sipxmedialib  Version 3.3
Functions
IReceiverReport.h File Reference
#include "rtcp/RtcpConfig.h"
#include "IBaseClass.h"
Include dependency graph for IReceiverReport.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

virtual unsigned long FormatReceiverReport (bool bSRPresent, unsigned char *puchReportBuffer, unsigned long ulBufferSize)=0
 
virtual unsigned long ParseReceiverReport (bool bHeader, unsigned char *puchReportBuffer)=0
 

Function Documentation

virtual unsigned long FormatReceiverReport ( bool  bSRPresent,
unsigned char *  puchReportBuffer,
unsigned long  ulBufferSize 
)
pure virtual

Method Name: FormatReceiverReport

Inputs: bool bSRPresent Specifies whether a Sender Report is prepended unsigned long ulBufferSize Optional size defining the length allocated for the buffer

Outputs: unsigned char *puchReportBuffer Character Buffer used to store the Receiver Report

Returns: unsigned long Returns the number of octets written into the buffer.

Description: Constructs a Receiver report using the buffer passed in by the caller. A Receiver Report may be appended to the contents of a Sender Report or sent along in the case where no data was transmitted during the reporting period. The header flag set to True shall cause the Receiver Report to be appended while False will cause a header to be prepended to the Report information.

A call to this method shall cause all period counts to be reset.

Usage Notes: The header of the RTCP Report shall be formatted by delegating to the base class.

virtual unsigned long ParseReceiverReport ( bool  bHeader,
unsigned char *  puchReportBuffer 
)
pure virtual

Method Name: ParseReceiverReport

Inputs: boolean bHeader Specifies whether a header is included unsigned char *puchReportBuffer Character Buffer used to store the Receiver Report

Outputs:

Returns: unsigned long Returns the number of octets processed

Description: Processes a Receiver report using the buffer passed in by the caller. The header flag shall identify whether the report is prepended with a header.

Usage Notes: The header of the RTCP Report, if provided, shall be parsed by delegating to the base class.