Bayonne2 / Common C++ 2 Framework
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Private Attributes | Static Private Attributes
IncomingDataQueueBase Class Reference

#include <queuebase.h>

Inheritance diagram for IncomingDataQueueBase:
Inheritance graph
[legend]
Collaboration diagram for IncomingDataQueueBase:
Collaboration graph
[legend]

Public Member Functions

size_t getDefaultMaxRecvPacketSize () const
 
size_t getMaxRecvPacketSize () const
 
void setMaxRecvPacketSize (size_t maxsize)
 
bool setPayloadFormat (const PayloadFormat &pf)
 Set the payload format in use, for timing and payload type identification purposes. More...
 
uint32 getLocalSSRC () const
 
uint32 getCurrentRTPClockRate () const
 Get the clock rate in RTP clock units (for instance, 8000 units per second for PCMU, or 90000 units per second for MP2T). More...
 
PayloadType getCurrentPayloadType () const
 
timeval getInitialTime () const
 

Protected Member Functions

 IncomingDataQueueBase ()
 
virtual ~IncomingDataQueueBase ()
 
void setLocalSSRC (uint32 ssrc)
 
uint32 getLocalSSRCNetwork () const
 
virtual size_t dispatchBYE (const std::string &)
 A plugin point for posting of BYE messages. More...
 
virtual void renewLocalSSRC ()
 

Private Attributes

size_t maxRecvPacketSize
 

Static Private Attributes

static const size_t defaultMaxRecvPacketSize
 

Detailed Description

Author
Federico Montesino Pouzols fedem.nosp@m.p@al.nosp@m.tern..nosp@m.org

Definition at line 297 of file queuebase.h.

Constructor & Destructor Documentation

IncomingDataQueueBase::IncomingDataQueueBase ( )
inlineprotected

Definition at line 323 of file queuebase.h.

virtual IncomingDataQueueBase::~IncomingDataQueueBase ( )
inlineprotectedvirtual

Definition at line 327 of file queuebase.h.

Member Function Documentation

virtual size_t RTPQueueBase::dispatchBYE ( const std::string &  )
inlineprotectedvirtualinherited

A plugin point for posting of BYE messages.

Parameters
-reason to leave the RTP session.
Returns
number of octets sent.

Reimplemented in QueueRTCPManager.

Definition at line 231 of file queuebase.h.

PayloadType RTPQueueBase::getCurrentPayloadType ( ) const
inlineinherited

Definition at line 201 of file queuebase.h.

uint32 RTPQueueBase::getCurrentRTPClockRate ( ) const
inlineinherited

Get the clock rate in RTP clock units (for instance, 8000 units per second for PCMU, or 90000 units per second for MP2T).

This value depends on what payload format has been selected using setPayloadFormat().

Returns
clock rate in RTP clock units.

Definition at line 198 of file queuebase.h.

size_t IncomingDataQueueBase::getDefaultMaxRecvPacketSize ( ) const
inline

Definition at line 301 of file queuebase.h.

timeval RTPQueueBase::getInitialTime ( ) const
inlineinherited

Definition at line 204 of file queuebase.h.

uint32 RTPQueueBase::getLocalSSRC ( ) const
inlineinherited

Definition at line 187 of file queuebase.h.

uint32 RTPQueueBase::getLocalSSRCNetwork ( ) const
inlineprotectedinherited

Definition at line 217 of file queuebase.h.

size_t IncomingDataQueueBase::getMaxRecvPacketSize ( ) const
inline

Definition at line 305 of file queuebase.h.

virtual void RTPQueueBase::renewLocalSSRC ( )
inlineprotectedvirtualinherited

Reimplemented in IncomingDataQueue, and RTPDataQueue.

Definition at line 235 of file queuebase.h.

void RTPQueueBase::setLocalSSRC ( uint32  ssrc)
inlineprotectedinherited

Definition at line 214 of file queuebase.h.

void IncomingDataQueueBase::setMaxRecvPacketSize ( size_t  maxsize)
inline
Parameters
maxsizemaximum length of received RTP data packets, in octets. Defaults to the value returned by getDefaultMaxRecvPacketSize().
Note
This method sets a filter for incoming packets. Setting higher values does not necessarily imply higher memory usage (this method does not set any buffer size).

Definition at line 319 of file queuebase.h.

bool RTPQueueBase::setPayloadFormat ( const PayloadFormat pf)
inlineinherited

Set the payload format in use, for timing and payload type identification purposes.

Parameters
pfpayload format to use from now on.
Returns
whether the payload format has been successfully set.

Definition at line 180 of file queuebase.h.

Field Documentation

const size_t IncomingDataQueueBase::defaultMaxRecvPacketSize
staticprivate

Definition at line 331 of file queuebase.h.

size_t IncomingDataQueueBase::maxRecvPacketSize
private

Definition at line 333 of file queuebase.h.


The documentation for this class was generated from the following file: