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

Go to the source code of this file.

Functions

virtual unsigned long GetReason (unsigned char *puchReason)=0
 
virtual unsigned long GetCSRC (ssrc_t *paulCSRC, bool bNBO=FALSE)=0
 
virtual IByeReport * GetByeInterface (void)=0
 

Function Documentation

virtual unsigned long GetReason ( unsigned char *  puchReason)
pure virtual

Method Name: GetReason

Inputs: None

Outputs: unsigned char *puchReason Character buffer in which the Reason attribute shall be returned

Returns: unsigned long Length of the item being returned in the unsigned character buffer

Description: Retrieves the Reason attribute stored within the object and returns its associated length.

Usage Notes: All unsigned character strings returned are limited to 255 bytes in length. Any wide unsigned character support for internationalized display is a responsibility assumed by the caller.

virtual unsigned long GetCSRC ( ssrc_t paulCSRC,
bool  bNBO = FALSE 
)
pure virtual

Method Name: GetCSRC

Inputs: bool bNBO Flag identifying whether data should be represented in NBO format

Outputs: ssrc_t *paulCSRC Contributing Source Identifier(s) Array pointer

Returns: unsigned long - Number of Contributing Source Identifier(s)

Description: Returns the contributing source values associated with the RTP packet.

Usage Notes:

virtual IByeReport* GetByeInterface ( void  )
pure virtual

Method Name: GetByeInterface()

Inputs: None

Outputs: None

Returns: IByeReport * - Pointer to the Bye Report Interface

Description: Returns the Bye Report interface.

Usage Notes: