class RTPSender

RTP/RTCP packet sender. More...

Full nameTelEngine::RTPSender
Definition#include <libs/yrtp/yatertp.h>
InheritsTelEngine::RTPBaseIO [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Protected Methods


Detailed Description

Class that builds and sends RTP and RTCP packets

 RTPSender (RTPSession* session = 0, bool randomTs = true)

RTPSender

Constructor

Parameters:
sessionRTP session the sender belongs
randomTsInitialize a random timestamp offset

 ~RTPSender ()

~RTPSender

[virtual]

Do-nothing destructor

bool  rtpSend (bool marker, int payload, unsigned int timestamp, const void* data, int len)

rtpSend

Send one RTP payload packet

Parameters:
markerSet to true if the marker bit must be set
payloadPayload number
timestampSampling instant of the packet data
dataPointer to data block to send
lenLength of the data block

Returns: True if data sending was attempted

bool  rtpSendData (bool marker, unsigned int timestamp, const void* data, int len)

rtpSendData

Send one RTP data packet

Parameters:
markerSet to true if the marker bit must be set
timestampSampling instant of the packet data
dataPointer to data block to send
lenLength of the data block

Returns: True if data sending was attempted

bool  rtpSendEvent (int event, int duration, int volume = 0, unsigned int timestamp = 0)

rtpSendEvent

Send one RTP event

Parameters:
eventEvent code to send
durationDuration of the event as number of samples
volumeAttenuation of the tone, zero for don't care
timestampSampling instant of the packet data, zero to use current

Returns: True if data sending was attempted

bool  rtpSendKey (char key, int duration, int volume = 0, unsigned int timestamp = 0)

rtpSendKey

Send one RTP key event

Parameters:
keyKey to send
durationDuration of the event as number of samples
volumeAttenuation of the tone, zero for don't care
timestampSampling instant of the packet data, zero to use current

Returns: True if data sending was attempted

inline int  padding ()

padding

[const]

Get the payload padding size

Returns: Chunk size to pad the payload to a multiple of

bool  padding (int chunk)

padding

Set the padding to a multiple of a data chunk

Parameters:
chunkSize to pad the payload to a multiple of

Returns: True if the new chunk size is valid

void  stats (NamedList& stat)

stats

[const virtual]

Retrieve the statistical data from this receiver in a NamedList. Reset all the data.

Parameters:
statNamedList to populate with the values for different counters

void  timerTick (const Time& when)

timerTick

[protected virtual]

Method called periodically to send events and buffered data

Parameters:
whenTime to use as base in all computing

Reimplemented from RTPBaseIO.

void  rtpEncipher (unsigned char* data, int len)

rtpEncipher

[protected virtual]

Method called to encipher RTP payload data in-place. The default implementation calls session's RTPSecure::rtpEncipher()

Parameters:
dataPointer to data block to encipher
lenLength of payload data to be encrypted including any padding

void  rtpAddIntegrity (const unsigned char* data, int len, unsigned char* authData)

rtpAddIntegrity

[protected virtual]

Method called to add integrity information to the RTP packet. The default implementation calls session's RTPSecure::rtpAddIntegrity()

Parameters:
dataPointer to the RTP packet to protect
lenLength of RTP data to be encrypted including header and padding
authDataAddress to write the integrity data to


Generated by: paulc on bussard on Tue Apr 12 17:15:21 2011, using kdoc 2.0a54.