Bayonne2 / Common C++ 2 Framework: RTPQueueBase Class Reference

Bayonne2 / Common C++ 2 Framework

[フレーム]

Public Member Functions | Protected Member Functions | Private Attributes

RTPQueueBase Class Reference

Base classes for RTP queues.

A virtual base class for RTP queue hierarchies. More...

#include <queuebase.h>

Inheritance diagram for RTPQueueBase:

Inheritance graph

[legend]

Collaboration diagram for RTPQueueBase:

Collaboration graph

[legend]

Public Member Functions

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

RTPQueueBase (uint32 *ssrc=NULL)

void setLocalSSRC (uint32 ssrc)

uint32 getLocalSSRCNetwork () const

virtual ~RTPQueueBase ()

virtual size_t dispatchBYE (const std::string &)

A plugin point for posting of BYE messages. More...

virtual void renewLocalSSRC ()

Private Attributes

uint32 localSSRC

uint32 localSSRCNetwork

uint32 currentRTPClockRate

PayloadType currentPayloadType

timeval initialTime

Detailed Description

A virtual base class for RTP queue hierarchies.

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

Definition at line 169 of file queuebase.h.

Constructor & Destructor Documentation

RTPQueueBase::RTPQueueBase ( uint32 * ssrc = NULL )

protected

Parameters: ssrc If not null, the local SSRC identifier for this session.

virtual RTPQueueBase::~RTPQueueBase ( )

inlineprotectedvirtual

Definition at line 221 of file queuebase.h.

Member Function Documentation

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

inlineprotectedvirtual

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

inline

Definition at line 201 of file queuebase.h.

uint32 RTPQueueBase::getCurrentRTPClockRate ( ) const

inline

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.

timeval RTPQueueBase::getInitialTime ( ) const

inline

Definition at line 204 of file queuebase.h.

uint32 RTPQueueBase::getLocalSSRC ( ) const

inline

Definition at line 187 of file queuebase.h.

uint32 RTPQueueBase::getLocalSSRCNetwork ( ) const

inlineprotected

Definition at line 217 of file queuebase.h.

virtual void RTPQueueBase::renewLocalSSRC ( )

inlineprotectedvirtual

Reimplemented in IncomingDataQueue, and RTPDataQueue.

Definition at line 235 of file queuebase.h.

void RTPQueueBase::setLocalSSRC ( uint32 ssrc )

inlineprotected

Definition at line 214 of file queuebase.h.

bool RTPQueueBase::setPayloadFormat ( const PayloadFormat & pf )

inline

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

Parameters: pf payload 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

PayloadType RTPQueueBase::currentPayloadType

private

Definition at line 247 of file queuebase.h.

uint32 RTPQueueBase::currentRTPClockRate

private

Definition at line 244 of file queuebase.h.

timeval RTPQueueBase::initialTime

private

Definition at line 249 of file queuebase.h.

uint32 RTPQueueBase::localSSRC

private

Definition at line 240 of file queuebase.h.

uint32 RTPQueueBase::localSSRCNetwork

private

Definition at line 242 of file queuebase.h.

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

queuebase.h

Generated on Dec 21, 2017 for commoncpp2-1.8.1, ccrtp-1.7.2, libzrtpcpp-2.3.4, ccscript3-1.1.7, ccaudio2-1.0.0 and bayonne2-2.3.2 (after installation in /usr/local/) by doxygen 1.8.6