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

Set the number of RTCP intervals that the stack will wait to change the state of a source from stateActive to stateInactive, or to delete the source after being in stateInactive. More...

virtual size_t takeInDataPacket ()

This function is used by the service thread to process the next incoming packet and place it in the receive list. More...

void renewLocalSSRC ()

IncomingDataQueue::IncomingRTPPktLink * getWaiting (uint32 timestamp, const SyncSource *src=NULL)

This is used to fetch a packet in the receive queue and to expire packets older than the current timestamp. More...

bool recordReception (SyncSourceLink &srcLink, const IncomingRTPPkt &pkt, const timeval recvtime)

Log reception of a new RTP packet from this source. More...

void recordExtraction (const IncomingRTPPkt &pkt)

Log extraction of a packet from this source from the scheduled reception queue. More...

void purgeIncomingQueue ()

virtual void onNewSyncSource (const SyncSource &)

Virtual called when a new synchronization source has joined the session. More...

virtual bool onRTPPacketRecv (IncomingRTPPkt &)

A virtual function to support parsing of arriving packets to determine if they should be kept in the queue and to dispatch events. More...

virtual void onExpireRecv (IncomingRTPPkt &)

A hook to filter packets in the receive queue that are being expired. More...

virtual bool onSRTPPacketError (IncomingRTPPkt &pkt, int32 errorCode)

A hook that gets called if the decoding of an incoming SRTP was erroneous. More...

virtual bool end2EndDelayed (IncomingRTPPktLink &)

bool insertRecvPacket (IncomingRTPPktLink *packetLink)

Insert a just received packet in the queue (both general and source specific queues). More...

virtual size_t recvData (unsigned char *buffer, size_t length, InetHostAddress &host, tpport_t &port)=0

This function performs the physical I/O for reading a packet from the source. More...

virtual size_t getNextDataPacketSize () const =0

void setLocalSSRC (uint32 ssrc)

uint32 getLocalSSRCNetwork () const

virtual size_t dispatchBYE (const std::string &)

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

size_t getDefaultMembersHashSize ()

SyncSourceLink * getLink (const SyncSource &source) const

bool isMine (const SyncSource &source) const

Get whether a synchronization source is recorded in this membership controller. More...

bool isRegistered (uint32 ssrc)

Returns whether there is already a synchronizacion source with "ssrc" SSRC identifier. More...

SyncSourceLink * getSourceBySSRC (uint32 ssrc, bool &created)

Get the description of a source by its ssrc identifier. More...

bool BYESource (uint32 ssrc)

Mark the source identified by ssrc as having sent a BYE packet. More...

bool removeSource (uint32 ssrc)

Remove the description of the source identified by ssrc More...

SyncSourceLink * getFirst ()

SyncSourceLink * getLast ()

uint32 getMembersCount ()

void setMembersCount (uint32 n)

uint32 getSendersCount ()

void setLink (SyncSource &source, void *link)

void setParticipant (SyncSource &source, Participant &p)

void setState (SyncSource &source, SyncSource::State ns)

void setSender (SyncSource &source, bool active)

void setDataTransportPort (SyncSource &source, tpport_t p)

void setControlTransportPort (SyncSource &source, tpport_t p)

void setNetworkAddress (SyncSource &source, InetAddress addr)

void setSDESItem (Participant *part, SDESItemType item, const std::string &val)

void setPRIVPrefix (Participant *part, const std::string val)

void addParticipant (RTPApplication &app, Participant &part)

void removeParticipant (RTPApplication &app, RTPApplication::ParticipantLink *pl)

ConflictingTransportAddress * searchDataConflict (InetAddress na, tpport_t dtp)

ConflictingTransportAddress * searchControlConflict (InetAddress na, tpport_t ctp)

void updateConflict (ConflictingTransportAddress &ca)

void addConflict (const InetAddress &na, tpport_t dtp, tpport_t ctp)

Protected Attributes

ThreadLock recvLock

IncomingRTPPktLink * recvFirst

IncomingRTPPktLink * recvLast

uint8 minValidPacketSequence

uint16 maxPacketMisorder

uint16 maxPacketDropout

uint8 sourceExpirationPeriod

Mutex cryptoMutex

std::list< CryptoContext * > cryptoContexts

ConflictingTransportAddress * firstConflict

ConflictingTransportAddress * lastConflict

Static Protected Attributes

static const uint8 defaultMinValidPacketSequence

static const uint16 defaultMaxPacketMisorder

static const uint16 defaultMaxPacketDropout

static const size_t defaultMembersSize

static const size_t defaultMembersHashSize

static const uint32 SEQNUMMOD

Detailed Description

Queue for incoming RTP data packets in an RTP session.

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

Definition at line 883 of file iqueue.h.

Constructor & Destructor Documentation

IncomingDataQueue::IncomingDataQueue ( uint32 size )

protected

Parameters: size initial size of the membership table.

virtual IncomingDataQueue::~IncomingDataQueue ( )

inlineprotectedvirtual

Definition at line 1088 of file iqueue.h.

Member Function Documentation

void ConflictHandler::addConflict ( const InetAddress & na,

tpport_t dtp,

tpport_t ctp

)

inherited

void ApplicationHandler::addParticipant ( RTPApplication & app,

Participant & part

)

inlineinherited

Definition at line 212 of file iqueue.h.

SyncSourcesIterator IncomingDataQueue::begin ( )

inline

Definition at line 938 of file iqueue.h.

bool MembershipBookkeeping::BYESource ( uint32 ssrc )

protectedinherited

Mark the source identified by ssrc as having sent a BYE packet.

It is not deleted until a timeout expires, so that in case some packets from this source arrive a bit later the source is not inserted again in the table of known sources.

Returns: true if the source had been previously identified. false if it was not in the table of known sources.

bool IncomingDataQueue::checkSSRCInIncomingRTPPkt ( SyncSourceLink & sourceLink,

bool is_new,

InetAddress & na,

tpport_t tp

)

protected

Apply collision and loop detection and correction algorithm when receiving RTP data packets.

Follows section 8.2 in draft-ietf-avt-rtp-new.

Parameters: sourceLink link to the source object.

is_new whether the source has been just recorded.

na data packet network address.

tp data packet source transport port.

Returns: whether the packet must not be discarded.

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.

SyncSourcesIterator IncomingDataQueue::end ( void )

inline

Definition at line 941 of file iqueue.h.

virtual bool IncomingDataQueue::end2EndDelayed ( IncomingRTPPktLink & )

inlineprotectedvirtual

Reimplemented in QueueRTCPManager.

Definition at line 1238 of file iqueue.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.

const AppDataUnit* IncomingDataQueue::getData ( uint32 stamp,

const SyncSource * src = NULL

)

Retreive data from a specific timestamped packet if such a packet is currently available in the receive buffer.

Parameters: stamp Data unit timestamp.

src Optional synchronization source selector.

Returns: data retrieved from the reception buffer.

Return values: null pointer if no packet with such timestamp is available.

uint16 IncomingDataQueue::getDefaultMaxPacketDropout ( ) const

inline

Definition at line 1035 of file iqueue.h.

uint16 IncomingDataQueue::getDefaultMaxPacketMisorder ( ) const

inline

Definition at line 1018 of file iqueue.h.

size_t IncomingDataQueueBase::getDefaultMaxRecvPacketSize ( ) const

inlineinherited

Definition at line 301 of file queuebase.h.

size_t MembershipBookkeeping::getDefaultMembersHashSize ( )

inlineinherited

Definition at line 309 of file iqueue.h.

static size_t IncomingDataQueue::getDefaultMembersSize ( )

inlinestatic

Definition at line 1045 of file iqueue.h.

uint8 IncomingDataQueue::getDefaultMinValidPacketSequence ( ) const

inline

Definition at line 1002 of file iqueue.h.

SyncSourceLink* MembershipBookkeeping::getFirst ( void )

inlineprotectedinherited

Definition at line 836 of file iqueue.h.

uint32 IncomingDataQueue::getFirstTimestamp ( const SyncSource * src = NULL ) const

Get timestamp of first packet waiting in the queue.

Parameters: src optional source selector.

Returns: timestamp of first arrival packet.

timeval RTPQueueBase::getInitialTime ( ) const

inlineinherited

Definition at line 204 of file queuebase.h.

CryptoContext* IncomingDataQueue::getInQueueCryptoContext ( uint32 ssrc )

Get an input queue CryptoContext identified by SSRC.

Parameters: ssrc Request CryptoContext for this incoming SSRC

Returns: Pointer to CryptoContext of the SSRC of NULL if no context available for this SSRC.

SyncSourceLink* MembershipBookkeeping::getLast ( void )

inlineprotectedinherited

Definition at line 839 of file iqueue.h.

SyncSourceLink* MembershipBookkeeping::getLink ( const SyncSource & source ) const

inlineprotectedinherited

Definition at line 339 of file iqueue.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.

uint16 IncomingDataQueue::getMaxPacketDropout ( ) const

inline

Definition at line 1039 of file iqueue.h.

uint16 IncomingDataQueue::getMaxPacketMisorder ( ) const

inline

Definition at line 1022 of file iqueue.h.

size_t IncomingDataQueueBase::getMaxRecvPacketSize ( ) const

inlineinherited

Definition at line 305 of file queuebase.h.

uint32 MembershipBookkeeping::getMembersCount ( )

inlineprotectedinherited

Definition at line 843 of file iqueue.h.

uint8 IncomingDataQueue::getMinValidPacketSequence ( ) const

inline

Get the minimun number of consecutive packets that must be received from a source before accepting its data packets.

Definition at line 1010 of file iqueue.h.

virtual size_t IncomingDataQueue::getNextDataPacketSize ( ) const

protectedpure virtual

Implemented in RTPDuplex.

uint32 MembershipBookkeeping::getSendersCount ( )

inlineprotectedinherited

Definition at line 851 of file iqueue.h.

SyncSourceLink* MembershipBookkeeping::getSourceBySSRC ( uint32 ssrc,

bool & created

)

protectedinherited

Get the description of a source by its ssrc identifier.

Parameters: ssrc SSRC identifier, in host order.

created whether a new source has been created.

Returns: Pointer to the SyncSource object identified by ssrc.

IncomingDataQueue::IncomingRTPPktLink* IncomingDataQueue::getWaiting ( uint32 timestamp,

const SyncSource * src = NULL

)

protected

This is used to fetch a packet in the receive queue and to expire packets older than the current timestamp.

Returns: packet buffer object for current timestamp if found.

Parameters: timestamp timestamp requested.

src optional source selector

Note: if found, the packet is removed from the reception queue

bool IncomingDataQueue::insertRecvPacket ( IncomingRTPPktLink * packetLink )

protected

Insert a just received packet in the queue (both general and source specific queues).

If the packet was already in the queue (same SSRC and sequence number), it is not inserted but deleted.

Parameters: packetLink link to a packet just received and generally validated and processed by onRTPPacketRecv.

Returns: whether the packet was successfully inserted.

Return values: false when the packet is duplicated (there is already a packet from the same source with the same timestamp).

true when the packet is not duplicated.

bool MembershipBookkeeping::isMine ( const SyncSource & source ) const

inlineprotectedinherited

Get whether a synchronization source is recorded in this membership controller.

Definition at line 345 of file iqueue.h.

bool MembershipBookkeeping::isRegistered ( uint32 ssrc )

protectedinherited

Returns whether there is already a synchronizacion source with "ssrc" SSRC identifier.

bool IncomingDataQueue::isWaiting ( const SyncSource * src = NULL ) const

Determine if packets are waiting in the reception queue.

Parameters: src Optional synchronization source selector.

Returns: True if packets are waiting.

virtual void IncomingDataQueue::onExpireRecv ( IncomingRTPPkt & )

inlineprotectedvirtual

A hook to filter packets in the receive queue that are being expired.

This hook may be used to do some application specific processing on expired packets before they are deleted.

Parameters: - packet expired from the recv queue.

Definition at line 1217 of file iqueue.h.

virtual void IncomingDataQueue::onNewSyncSource ( const SyncSource & )

inlineprotectedvirtual

Virtual called when a new synchronization source has joined the session.

Parameters: - new synchronization source

Definition at line 1185 of file iqueue.h.

virtual bool IncomingDataQueue::onRTPPacketRecv ( IncomingRTPPkt & )

inlineprotectedvirtual

A virtual function to support parsing of arriving packets to determine if they should be kept in the queue and to dispatch events.

A generic header validity check (as specified in RFC 1889) is performed on every incoming packet. If the generic check completes succesfully, this method is called before the packet is actually inserted into the reception queue.

May be used to perform additional validity checks or to do some application specific processing.

Parameters: - packet just received.

Returns: true if packet is kept in the incoming packets queue.

Definition at line 1206 of file iqueue.h.

virtual bool IncomingDataQueue::onSRTPPacketError ( IncomingRTPPkt & pkt,

int32 errorCode

)

inlineprotectedvirtual

A hook that gets called if the decoding of an incoming SRTP was erroneous.

Parameters: pkt The SRTP packet with error.

errorCode The error code: -1 - SRTP authentication failure, -2 - replay check failed

Returns: True: put the packet in incoming queue for further processing by the applications; false: dismiss packet. The default implementation returns false.

Reimplemented in ZrtpQueue.

Definition at line 1234 of file iqueue.h.

void IncomingDataQueue::purgeIncomingQueue ( )

protected

void IncomingDataQueue::recordExtraction ( const IncomingRTPPkt & pkt )

protected

Log extraction of a packet from this source from the scheduled reception queue.

Parameters: pkt Packet extracted from the queue.

bool IncomingDataQueue::recordReception ( SyncSourceLink & srcLink,

const IncomingRTPPkt & pkt,

const timeval recvtime

)

protected

Log reception of a new RTP packet from this source.

Usually updates data such as the packet counter, the expected sequence number for the next packet and the time the last packet was received at.

Parameters: srcLink Link structure for the synchronization source of this packet.

pkt Packet just created and to be logged.

recvtime Reception time.

Returns: whether, according to the source state and statistics, the packet is considered valid and must be inserted in the incoming packets queue.

virtual size_t IncomingDataQueue::recvData ( unsigned char * buffer,

size_t length,

InetHostAddress & host,

tpport_t & port

)

protectedpure virtual

This function performs the physical I/O for reading a packet from the source.

It is a virtual that is overriden in the derived class.

Returns: number of bytes read.

Parameters: buffer of read packet.

length of data to read.

host address of source.

port number of source.

Implemented in RTPDuplex.

void IncomingDataQueue::removeInQueueCryptoContext ( CryptoContext * cc )

Remove input queue CryptoContext.

The endQueue method (provided by RTPQueue) also deletes all registered CryptoContexts.

Parameters: cc Pointer to initialized CryptoContext to remove. If pointer if NULL then delete the whole queue

void ApplicationHandler::removeParticipant ( RTPApplication & app,

RTPApplication::ParticipantLink * pl

)

inlineinherited

Definition at line 216 of file iqueue.h.

bool MembershipBookkeeping::removeSource ( uint32 ssrc )

protectedinherited

Remove the description of the source identified by ssrc

Returns: whether the source has been actually removed or it did not exist.

void IncomingDataQueue::renewLocalSSRC ( )

protectedvirtual

Reimplemented from RTPQueueBase.

ConflictingTransportAddress* ConflictHandler::searchControlConflict ( InetAddress na,

tpport_t ctp

)

inherited

Parameters: na Inet network address.

ctp Data transport port.

ConflictingTransportAddress* ConflictHandler::searchDataConflict ( InetAddress na,

tpport_t dtp

)

inherited

Parameters: na Inet network address.

dtp Data transport port.

void SyncSourceHandler::setControlTransportPort ( SyncSource & source,

tpport_t p

)

inlineinherited

Definition at line 161 of file iqueue.h.

void SyncSourceHandler::setDataTransportPort ( SyncSource & source,

tpport_t p

)

inlineinherited

Definition at line 157 of file iqueue.h.

void IncomingDataQueue::setInQueueCryptoContext ( CryptoContext * cc )

Set input queue CryptoContext.

The endQueue method (provided by RTPQueue) deletes all registered CryptoContexts.

Parameters: cc Pointer to initialized CryptoContext.

void SyncSourceHandler::setLink ( SyncSource & source,

void * link

)

inlineinherited

Definition at line 141 of file iqueue.h.

void RTPQueueBase::setLocalSSRC ( uint32 ssrc )

inlineprotectedinherited

Definition at line 214 of file queuebase.h.

void IncomingDataQueue::setMaxPacketDropout ( uint16 packets )

inline

It also prevents packets sent after a restart of the source being immediately accepted.

Definition at line 1031 of file iqueue.h.

void IncomingDataQueue::setMaxPacketMisorder ( uint16 packets )

inline

Definition at line 1014 of file iqueue.h.

void IncomingDataQueueBase::setMaxRecvPacketSize ( size_t maxsize )

inlineinherited

Parameters: maxsize maximum 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.

void MembershipBookkeeping::setMembersCount ( uint32 n )

inlineprotectedinherited

Definition at line 847 of file iqueue.h.

void IncomingDataQueue::setMinValidPacketSequence ( uint8 packets )

inline

When receiving packets from a new source, it may be convenient to reject a first few packets before we are really sure the source is valid.

This method sets how many data packets must be received in sequence before the source is considered valid and the stack starts to accept its packets.

Note: the default (see defaultMinValidPacketSequence()) value for this parameter is 0, so that no packets are rejected (data packets are accepted from the first one).; this validation is performed after the generic header validation and the additional validation done in onRTPPacketRecv().; if any valid RTCP packet is received from this source, it will be immediatly considered valid regardless of the number of sequential data packets received.

Parameters: packets number of sequential packet required

Definition at line 998 of file iqueue.h.

void SyncSourceHandler::setNetworkAddress ( SyncSource & source,

InetAddress addr

)

inlineinherited

Definition at line 165 of file iqueue.h.

void SyncSourceHandler::setParticipant ( SyncSource & source,

Participant & p

)

inlineinherited

Definition at line 145 of file iqueue.h.

bool RTPQueueBase::setPayloadFormat ( const PayloadFormat & pf )

inlineinherited

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.

void ParticipantHandler::setPRIVPrefix ( Participant * part,

const std::string val

)

inlineinherited

Definition at line 191 of file iqueue.h.

void ParticipantHandler::setSDESItem ( Participant * part,

SDESItemType item,

const std::string & val

)

inlineinherited

Definition at line 186 of file iqueue.h.

void SyncSourceHandler::setSender ( SyncSource & source,

bool active

)

inlineinherited

Definition at line 153 of file iqueue.h.

void IncomingDataQueue::setSourceExpirationPeriod ( uint8 intervals )

inlineprotected

Set the number of RTCP intervals that the stack will wait to change the state of a source from stateActive to stateInactive, or to delete the source after being in stateInactive.

Note that this value should be uniform accross all participants and SHOULD be fixed for a particular profile.

Parameters: intervals number of RTCP report intervals

Note: If RTCP is not being used, the RTCP interval is assumed to be the default: 5 seconds.; The default for this value is, as RECOMMENDED, 5.

Definition at line 1122 of file iqueue.h.

void SyncSourceHandler::setState ( SyncSource & source,

SyncSource::State ns

)

inlineinherited

Definition at line 149 of file iqueue.h.

virtual size_t IncomingDataQueue::takeInDataPacket ( )

protectedvirtual

This function is used by the service thread to process the next incoming packet and place it in the receive list.

Returns: number of payload bytes received. <0 if error.

Reimplemented in ZrtpQueue.

void ConflictHandler::updateConflict ( ConflictingTransportAddress & ca )

inlineinherited

Definition at line 276 of file iqueue.h.

Field Documentation

std::list<CryptoContext *> IncomingDataQueue::cryptoContexts

protected

Definition at line 1290 of file iqueue.h.

Mutex IncomingDataQueue::cryptoMutex

mutableprotected

Definition at line 1289 of file iqueue.h.

const uint16 IncomingDataQueue::defaultMaxPacketDropout

staticprotected

Definition at line 1283 of file iqueue.h.

const uint16 IncomingDataQueue::defaultMaxPacketMisorder

staticprotected

Definition at line 1282 of file iqueue.h.

const size_t MembershipBookkeeping::defaultMembersHashSize

staticprotectedinherited

Definition at line 854 of file iqueue.h.

const size_t IncomingDataQueue::defaultMembersSize

staticprotected

Definition at line 1287 of file iqueue.h.

const uint8 IncomingDataQueue::defaultMinValidPacketSequence

staticprotected

Definition at line 1281 of file iqueue.h.

ConflictingTransportAddress* ConflictHandler::firstConflict

protectedinherited

Definition at line 288 of file iqueue.h.

ConflictingTransportAddress * ConflictHandler::lastConflict

protectedinherited

Definition at line 288 of file iqueue.h.

uint16 IncomingDataQueue::maxPacketDropout

protected

Definition at line 1286 of file iqueue.h.

uint16 IncomingDataQueue::maxPacketMisorder

protected

Definition at line 1285 of file iqueue.h.

uint8 IncomingDataQueue::minValidPacketSequence

protected

Definition at line 1284 of file iqueue.h.

IncomingRTPPktLink* IncomingDataQueue::recvFirst

protected

Definition at line 1279 of file iqueue.h.

IncomingRTPPktLink * IncomingDataQueue::recvLast

protected

Definition at line 1279 of file iqueue.h.

ThreadLock IncomingDataQueue::recvLock

mutableprotected

Definition at line 1277 of file iqueue.h.

const uint32 MembershipBookkeeping::SEQNUMMOD

staticprotectedinherited

Definition at line 855 of file iqueue.h.

uint8 IncomingDataQueue::sourceExpirationPeriod

protected

Definition at line 1288 of file iqueue.h.

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

iqueue.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