class RTP_Session: public PObject

This class is for encpsulating the IETF Real Time Protocol interface

Inheritance:


Public

[more] Construction
[more] Operations
[more] Call back frunctions
[more] Member variable access


Documentation

This class is for encpsulating the IETF Real Time Protocol interface
o Construction

oRTP_UserData* userData
Session ID for RTP channel

o ~RTP_Session()
Delete a session. This deletes the userData field.

o Operations

ovoid SetJitterBufferSize( unsigned jitterDelay, PINDEX stackSize = 30000 )
Sets the size of the jitter buffer to be used by this RTP session. A session default to not having any jitter buffer enabled for reading and the ReadBufferedData() function simply calls ReadData(). Once a jitter buffer has been created it cannot be removed, though its size may be adjusted.

If the jitterDelay paramter is zero, it destroys the jitter buffer attached to this RTP session.

Parameters:
jitterDelay - Total jitter buffer delay in milliseconds
stackSize - Stack size for jitter thread

oBOOL ReadBufferedData( DWORD timestamp, RTP_DataFrame & frame )
Read a data frame from the RTP channel. This function will conditionally read data from eth jitter buffer or directly if there is no jitter buffer enabled. An application should generally use this in preference to directly calling ReadData().
Parameters:
timestamp - Timestamp to read from buffer.
frame - Frame read from the RTP session

ovirtual BOOL ReadData( RTP_DataFrame & frame )
Read a data frame from the RTP channel. Any control frames received are dispatched to callbacks and are not returned by this function. It will block until a data frame is available or an error occurs.
Parameters:
frame - Frame read from the RTP session

ovirtual BOOL WriteData( RTP_DataFrame & frame )
Write a data frame from the RTP channel.
Parameters:
frame - Frame to write to the RTP session

ovirtual BOOL WriteControl( RTP_ControlFrame & frame )
Write a control frame from the RTP channel.
Parameters:
frame - Frame to write to the RTP session

ovirtual void Close( BOOL reading )
Close down the RTP session.
Parameters:
reading - Closing the read side of the session

ovirtual PString GetLocalHostName()
Get the local host name as used in SDES packes

o Call back frunctions

o Member variable access

ounsigned GetSessionID() const
Get the ID for the RTP session

oRTP_UserData* GetUserData() const
Get the user data for the session

ovoid SetUserData( RTP_UserData * data )
Set the user data for the session

oDWORD GetSyncSourceOut() const
Get the source output identifier

ovoid IncrementReference()
Increment reference count for RTP session

oBOOL DecrementReference()
Decrement reference count for RTP session

oBOOL WillIgnoreOtherSources() const
Indicate if will ignore all but first received SSRC value

ovoid SetIgnoreOtherSources( BOOL ignore )
Indicate if will ignore all but first received SSRC value.
Parameters:
ignore - Flag for ignore other SSRC values

oBOOL WillIgnoreOutOfOrderPackets() const
Indicate if will ignore out of order packets

ovoid SetIgnoreOutOfOrderPackets( BOOL ignore )
Indicate if will ignore out of order packets.
Parameters:
ignore - Flag for ignore out of order packets

ounsigned GetSenderReportInterval()
Get the interval for transmitter reports in the session

ovoid SetSenderReportInterval( unsigned packets )
Set the interval for transmitter reports in the session

ounsigned GetReceiverReportInterval()
Get the interval for receiver reports in the session

ovoid SetReceiverReportInterval( unsigned packets )
Set the interval for receiver reports in the session

oDWORD GetPacketsSent() const
Get total number of packets sent in session

oDWORD GetOctetsSent() const
Get total number of octets sent in session

oDWORD GetPacketsReceived() const
Get total number of packets received in session

oDWORD GetOctetsReceived() const
Get total number of octets received in session

oDWORD GetPacketsLost() const
Get total number received packets lost in session

oDWORD GetPacketsOutOfOrder() const
Get total number of packets received out of order in session

oDWORD GetPacketsTooLate() const
Get total number received packets too late to go into jitter buffer

oDWORD GetAverageSendTime() const
Get average time between sent packets. This is averaged over the last senderReportInterval packets and is in milliseconds.

oDWORD GetMaximumSendTime() const
Get maximum time between sent packets. This is over the last senderReportInterval packets and is in milliseconds.

oDWORD GetMinimumSendTime() const
Get minimum time between sent packets. This is over the last senderReportInterval packets and is in milliseconds.

oDWORD GetAverageReceiveTime() const
Get average time between received packets. This is averaged over the last receiverReportInterval packets and is in milliseconds.

oDWORD GetMaximumReceiveTime() const
Get maximum time between received packets. This is over the last receiverReportInterval packets and is in milliseconds.

oDWORD GetMinimumReceiveTime() const
Get minimum time between received packets. This is over the last receiverReportInterval packets and is in milliseconds.

oDWORD GetJitterTime() const
Get averaged jitter time for received packets. This is the calculated statistical variance of the interarrival time of received packets in milliseconds.


Direct child classes:
RTP_UDP

Alphabetic index HTML hierarchy of classes or Java



This page was generated with the help of DOC++.