ccRTP 2.1.2
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Data Structures | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
IncomingDataQueue Class Referenceabstract

Queue for incoming RTP data packets in an RTP session. More...

#include <iqueue.h>

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

Data Structures

class  SyncSourcesIterator
 iterator through the list of synchronizations sources in this session More...
 

Public Member Functions

SyncSourcesIterator begin ()
 
SyncSourcesIterator end ()
 
const AppDataUnitgetData (uint32 stamp, const SyncSource *src=NULL)
 Retreive data from a specific timestamped packet if such a packet is currently available in the receive buffer. More...
 
bool isWaiting (const SyncSource *src=NULL) const
 Determine if packets are waiting in the reception queue. More...
 
uint32 getFirstTimestamp (const SyncSource *src=NULL) const
 Get timestamp of first packet waiting in the queue. More...
 
void setMinValidPacketSequence (uint8 packets)
 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. More...
 
uint8 getDefaultMinValidPacketSequence () const
 
uint8 getMinValidPacketSequence () const
 Get the minimun number of consecutive packets that must be received from a source before accepting its data packets. More...
 
void setMaxPacketMisorder (uint16 packets)
 
uint16 getDefaultMaxPacketMisorder () const
 
uint16 getMaxPacketMisorder () const
 
void setMaxPacketDropout (uint16 packets)
 It also prevents packets sent after a restart of the source being immediately accepted. More...
 
uint16 getDefaultMaxPacketDropout () const
 
uint16 getMaxPacketDropout () const
 
void setInQueueCryptoContext (CryptoContext *cc)
 Set input queue CryptoContext. More...
 
void removeInQueueCryptoContext (CryptoContext *cc)
 Remove input queue CryptoContext. More...
 
CryptoContextgetInQueueCryptoContext (uint32 ssrc)
 Get an input queue CryptoContext identified by SSRC. More...
 
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
 

Static Public Member Functions

static size_t getDefaultMembersSize ()
 

Protected Member Functions

 IncomingDataQueue (uint32 size)
 
virtual ~IncomingDataQueue ()
 
bool checkSSRCInIncomingRTPPkt (SyncSourceLink &sourceLink, bool is_new, InetAddress &na, tpport_t tp)
 Apply collision and loop detection and correction algorithm when receiving RTP data packets. More...
 
void setSourceExpirationPeriod (uint8 intervals)
 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::IncomingRTPPktLinkgetWaiting (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 ()
 
SyncSourceLinkgetLink (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...
 
SyncSourceLinkgetSourceBySSRC (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...
 
SyncSourceLinkgetFirst ()
 
SyncSourceLinkgetLast ()
 
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)
 
ConflictingTransportAddresssearchDataConflict (InetAddress na, tpport_t dtp)
 
ConflictingTransportAddresssearchControlConflict (InetAddress na, tpport_t ctp)
 
void updateConflict (ConflictingTransportAddress &ca)
 
void addConflict (const InetAddress &na, tpport_t dtp, tpport_t ctp)
 

Protected Attributes

ThreadLock recvLock
 
IncomingRTPPktLinkrecvFirst
 
IncomingRTPPktLinkrecvLast
 
uint8 minValidPacketSequence
 
uint16 maxPacketMisorder
 
uint16 maxPacketDropout
 
uint8 sourceExpirationPeriod
 
Mutex cryptoMutex
 
std::list< CryptoContext * > cryptoContexts
 
ConflictingTransportAddressfirstConflict
 
ConflictingTransportAddresslastConflict
 

Static Protected Attributes

static const uint8 defaultMinValidPacketSequence = 0
 
static const uint16 defaultMaxPacketMisorder = 0
 
static const uint16 defaultMaxPacketDropout = 3000
 
static const size_t defaultMembersSize
 
static const size_t defaultMembersHashSize = 11
 
static const uint32 SEQNUMMOD = (1<<16)
 

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
sizeinitial size of the membership table.

Definition at line 94 of file incqueue.cpp.

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

Definition at line 75 of file incqueue.cpp.

void ApplicationHandler::addParticipant ( RTPApplication app,
Participant part 
)
inlineinherited

Definition at line 209 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.

Definition at line 282 of file members.cpp.

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
sourceLinklink to the source object.
is_newwhether the source has been just recorded.
nadata packet network address.
tpdata packet source transport port.
Returns
whether the packet must not be discarded.

Definition at line 299 of file incqueue.cpp.

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 228 of file queuebase.h.

SyncSourcesIterator IncomingDataQueue::end ( )
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 198 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 195 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
stampData unit timestamp.
srcOptional synchronization source selector.
Returns
data retrieved from the reception buffer.
Return values
nullpointer if no packet with such timestamp is available.

Definition at line 472 of file incqueue.cpp.

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 298 of file queuebase.h.

size_t MembershipBookkeeping::getDefaultMembersHashSize ( )
inlineinherited

Definition at line 306 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 ( )
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
srcoptional source selector.
Returns
timestamp of first arrival packet.

Definition at line 158 of file incqueue.cpp.

timeval RTPQueueBase::getInitialTime ( ) const
inlineinherited

Definition at line 201 of file queuebase.h.

CryptoContext * IncomingDataQueue::getInQueueCryptoContext ( uint32  ssrc)

Get an input queue CryptoContext identified by SSRC.

Parameters
ssrcRequest CryptoContext for this incoming SSRC
Returns
Pointer to CryptoContext of the SSRC of NULL if no context available for this SSRC.

Definition at line 773 of file incqueue.cpp.

SyncSourceLink* MembershipBookkeeping::getLast ( )
inlineprotectedinherited

Definition at line 839 of file iqueue.h.

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

Definition at line 336 of file iqueue.h.

uint32 RTPQueueBase::getLocalSSRC ( ) const
inlineinherited

Definition at line 184 of file queuebase.h.

uint32 RTPQueueBase::getLocalSSRCNetwork ( ) const
inlineprotectedinherited

Definition at line 214 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 302 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.

MembershipBookkeeping::SyncSourceLink * MembershipBookkeeping::getSourceBySSRC ( uint32  ssrc,
bool &  created 
)
protectedinherited

Get the description of a source by its ssrc identifier.

Parameters
ssrcSSRC identifier, in host order.
createdwhether a new source has been created.
Returns
Pointer to the SyncSource object identified by ssrc.

Definition at line 226 of file members.cpp.

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
timestamptimestamp requested.
srcoptional source selector
Note
if found, the packet is removed from the reception queue

Definition at line 496 of file incqueue.cpp.

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
packetLinklink to a packet just received and generally validated and processed by onRTPPacketRecv.
Returns
whether the packet was successfully inserted.
Return values
falsewhen the packet is duplicated (there is already a packet from the same source with the same timestamp).
truewhen the packet is not duplicated.

Definition at line 369 of file incqueue.cpp.

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

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

Definition at line 342 of file iqueue.h.

bool MembershipBookkeeping::isRegistered ( uint32  ssrc)
protectedinherited

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

Definition at line 205 of file members.cpp.

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

Determine if packets are waiting in the reception queue.

Parameters
srcOptional synchronization source selector.
Returns
True if packets are waiting.

Definition at line 144 of file incqueue.cpp.

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
pktThe SRTP packet with error.
errorCodeThe 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

Definition at line 105 of file incqueue.cpp.

void IncomingDataQueue::recordExtraction ( const IncomingRTPPkt pkt)
protected

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

Parameters
pktPacket extracted from the queue.

Definition at line 725 of file incqueue.cpp.

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
srcLinkLink structure for the synchronization source of this packet.
pktPacket just created and to be logged.
recvtimeReception time.
Returns
whether, according to the source state and statistics, the packet is considered valid and must be inserted in the incoming packets queue.

Definition at line 632 of file incqueue.cpp.

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
bufferof read packet.
lengthof data to read.
hostaddress of source.
portnumber 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
ccPointer to initialized CryptoContext to remove. If pointer if NULL then delete the whole queue

Definition at line 748 of file incqueue.cpp.

void ApplicationHandler::removeParticipant ( RTPApplication app,
RTPApplication::ParticipantLink pl 
)
inlineinherited

Definition at line 213 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.

Definition at line 295 of file members.cpp.

void IncomingDataQueue::renewLocalSSRC ( )
protectedvirtual

Reimplemented from RTPQueueBase.

Definition at line 128 of file incqueue.cpp.

ConflictHandler::ConflictingTransportAddress * ConflictHandler::searchControlConflict ( InetAddress  na,
tpport_t  ctp 
)
inherited
Parameters
naInet network address.
ctpData transport port.

Definition at line 64 of file incqueue.cpp.

ConflictHandler::ConflictingTransportAddress * ConflictHandler::searchDataConflict ( InetAddress  na,
tpport_t  dtp 
)
inherited
Parameters
naInet network address.
dtpData transport port.

Definition at line 54 of file incqueue.cpp.

void SyncSourceHandler::setControlTransportPort ( SyncSource source,
tpport_t  p 
)
inlineinherited

Definition at line 158 of file iqueue.h.

void SyncSourceHandler::setDataTransportPort ( SyncSource source,
tpport_t  p 
)
inlineinherited

Definition at line 154 of file iqueue.h.

void IncomingDataQueue::setInQueueCryptoContext ( CryptoContext cc)

Set input queue CryptoContext.

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

Parameters
ccPointer to initialized CryptoContext.

Definition at line 729 of file incqueue.cpp.

void SyncSourceHandler::setLink ( SyncSource source,
void *  link 
)
inlineinherited

Definition at line 138 of file iqueue.h.

void RTPQueueBase::setLocalSSRC ( uint32  ssrc)
inlineprotectedinherited

Definition at line 211 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
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 316 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
packetsnumber of sequential packet required

Definition at line 998 of file iqueue.h.

void SyncSourceHandler::setNetworkAddress ( SyncSource source,
InetAddress  addr 
)
inlineinherited

Definition at line 162 of file iqueue.h.

void SyncSourceHandler::setParticipant ( SyncSource source,
Participant p 
)
inlineinherited

Definition at line 142 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
pfpayload format to use from now on.
Returns
whether the payload format has been successfully set.

Definition at line 177 of file queuebase.h.

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

Definition at line 188 of file iqueue.h.

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

Definition at line 183 of file iqueue.h.

void SyncSourceHandler::setSender ( SyncSource source,
bool  active 
)
inlineinherited

Definition at line 150 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
intervalsnumber 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 146 of file iqueue.h.

size_t IncomingDataQueue::takeInDataPacket ( void  )
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.

Definition at line 181 of file incqueue.cpp.

void ConflictHandler::updateConflict ( ConflictingTransportAddress ca)
inlineinherited

Definition at line 273 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 = 3000
staticprotected

Definition at line 1283 of file iqueue.h.

const uint16 IncomingDataQueue::defaultMaxPacketMisorder = 0
staticprotected

Definition at line 1282 of file iqueue.h.

const size_t MembershipBookkeeping::defaultMembersHashSize = 11
staticprotectedinherited

Definition at line 854 of file iqueue.h.

const size_t IncomingDataQueue::defaultMembersSize
staticprotected
Initial value:

Definition at line 1287 of file iqueue.h.

const uint8 IncomingDataQueue::defaultMinValidPacketSequence = 0
staticprotected

Definition at line 1281 of file iqueue.h.

ConflictingTransportAddress* ConflictHandler::firstConflict
protectedinherited

Definition at line 285 of file iqueue.h.

ConflictingTransportAddress * ConflictHandler::lastConflict
protectedinherited

Definition at line 285 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 = (1<<16)
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 files: