RTPBaseIO Class Reference

Common send/recv variables holder. More...

#include <yatertp.h>

Inheritance diagram for RTPBaseIO:
RTPReceiver RTPSender

List of all members.

Public Member Functions

 RTPBaseIO (RTPSession *session=0)
virtual ~RTPBaseIO ()
int dataPayload () const
bool dataPayload (int type)
int eventPayload () const
bool eventPayload (int type)
int silencePayload () const
bool silencePayload (int type)
unsigned int ssrcInit ()
void reset ()
unsigned int ssrc () const
void ssrc (unsigned int src)
u_int16_t seq () const
u_int32_t rollover () const
u_int64_t fullSeq () const
u_int32_t ioPackets () const
u_int32_t ioOctets () const
RTPSessionsession () const
RTPSecuresecurity () const
void security (RTPSecure *secure)

Protected Member Functions

virtual void timerTick (const Time &when)=0
void secLength (u_int32_t len, u_int32_t key=0)

Protected Attributes

RTPSessionm_session
RTPSecurem_secure
bool m_ssrcInit
u_int32_t m_ssrc
u_int32_t m_ts
u_int16_t m_seq
u_int32_t m_rollover
u_int16_t m_secLen
u_int16_t m_mkiLen
u_int32_t m_evTs
int m_evNum
int m_evVol
u_int32_t m_ioPackets
u_int32_t m_ioOctets

Friends

class RTPSession
class RTPSecure

Detailed Description

Common send/recv variables holder.

Base class that holds common sender and receiver methods


Constructor & Destructor Documentation

RTPBaseIO ( RTPSession session = 0  )  [inline]

Default constructor.

virtual ~RTPBaseIO (  )  [virtual]

Destructor


Member Function Documentation

bool dataPayload ( int  type  ) 

Set the payload type for data packets

Parameters:
type Payload type, -1 to disable
Returns:
True if changed, false if invalid payload type
int dataPayload (  )  const [inline]

Get the payload type for data packets

Returns:
Payload type, -1 if not set
bool eventPayload ( int  type  ) 

Set the payload type for event packets

Parameters:
type Payload type, -1 to disable
Returns:
True if changed, false if invalid payload type
int eventPayload (  )  const [inline]

Get the payload type for event packets

Returns:
Payload type, -1 if not set
u_int64_t fullSeq (  )  const [inline]

Get the full current sequence number including rollovers

Returns:
Full 48 bit current sequence number
u_int32_t ioOctets (  )  const [inline]

Retrieve the number of payload octets exchanged on current session

Returns:
Number of octets exchanged except headers and padding
u_int32_t ioPackets (  )  const [inline]

Retrieve the number of packets exchanged on current session

Returns:
Number of packets exchanged
void reset (  )  [inline]

Requesting generation/grabbing of a new SSRC

u_int32_t rollover (  )  const [inline]

Get the value of the rollover counter

Returns:
How many times the seqeunce has rolled over since SSRC changed
void secLength ( u_int32_t  len,
u_int32_t  key = 0 
) [inline, protected]

Set the length of the added / expected security info block

Parameters:
len Length of security information portion
key Length of master key identifier
void security ( RTPSecure secure  ) 

Set the security provider of this sender or receiver

Parameters:
secure Pointer to the new RTPSecure or NULL
RTPSecure* security (  )  const [inline]

Get the security provider of this sender or receiver

Returns:
A pointer to the RTPSecure or NULL
u_int16_t seq (  )  const [inline]

Get the current sequence number

Returns:
Sequence number
RTPSession* session (  )  const [inline]

Get the session this object belongs to

Returns:
Pointer to RTP session or NULL
bool silencePayload ( int  type  ) 

Set the payload type for Silence event packets. Thanks, Silence, for a new and incompatible way of sending events.

Parameters:
type Payload type, -1 to disable
Returns:
True if changed, false if invalid payload type
int silencePayload (  )  const [inline]

Get the payload type for Silence event packets

Returns:
Payload type, -1 if not set
void ssrc ( unsigned int  src  )  [inline]

Force a new known SSRC for all further packets

unsigned int ssrc (  )  const [inline]

Get the value of the current SSRC, zero if not initialized yet

Returns:
Value of SSRC, zero if not initialized
unsigned int ssrcInit (  ) 

Return SSRC value, initialize to a new, random value if needed

Returns:
Current value of SSRC
virtual void timerTick ( const Time when  )  [protected, pure virtual]

Method called periodically to keep the data flowing

Parameters:
when Time to use as base in all computing

Implemented in RTPReceiver, and RTPSender.


The documentation for this class was generated from the following file:
Generated on Thu Apr 8 18:19:44 2010 for Yate by  doxygen 1.6.3