This class, an RTP/RTCP queue, adds audio/video profile (AVP) specific methods to the generic RTCP service queue (QueueRTCPManager). More...

#include <cqueue.h>

Inheritance diagram for AVPQueue:

[legend]

Collaboration diagram for AVPQueue:

[legend]

Public Types
enum	Tos { tosBestEffort, tosEnhanced }
	rtp.h cc++/rtp.h More...

Public Member Functions
void	setControlBandwidth (float fraction)
	Specify the bandwith available for control (RTCP) packets. More...

float	getControlBandwidth () const

RTCPSenderInfo *	getMRSenderInfo (SyncSource &src)
	Get the most recent sender report received from a synchronization source. More...

RTCPReceiverInfo *	getMRReceiverInfo (SyncSource &srcFrom)
	Ask for the info in the most recent receiver report about the local source received from the source given as parameter. More...

void	setLeavingDelay (microtimeout_t delay)
	Set how much time the stack will wait before deleting a synchronization source that has sent an RTCP BYE packet. More...

void	setEnd2EndDelay (microtimeout_t t)
	This method sets the maximum end to end delay allowed. More...

microtimeout_t	getDefaultEnd2EndDelay () const

microtimeout_t	getEnd2EndDelay () const

void	setSendersControlFraction (float fraction)
	Specify the fraction of the total control bandwith to be dedicated to senders reports. More...

void	setMinRTCPInterval (microtimeout_t interval)
	Manually set the minimum interval for sending RTP compound packets. More...

uint32	getSendRTCPPacketCount () const
	Get the total number of RTCP packets sent until now. More...

void	setOutQueueCryptoContextCtrl (CryptoContextCtrl *cc)
	Set ouput queue CryptoContext. More...

void	removeOutQueueCryptoContextCtrl (CryptoContextCtrl *cc)
	Remove output queue CryptoContext. More...

CryptoContextCtrl *	getOutQueueCryptoContextCtrl (uint32 ssrc)
	Get an output queue CryptoContext identified by SSRC. More...

void	setInQueueCryptoContextCtrl (CryptoContextCtrl *cc)
	Set input queue CryptoContext. More...

void	removeInQueueCryptoContextCtrl (CryptoContextCtrl *cc)
	Remove input queue CryptoContext. More...

CryptoContextCtrl *	getInQueueCryptoContextCtrl (uint32 ssrc)
	Get an input queue CryptoContext identified by SSRC. More...

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

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

void	setTypeOfService (Tos tos)
	Specify the kind of service the application expects to use. More...

void	enableStack ()
	Enable packet queue processing in the stack. More...

void	disableStack ()
	Disable packet queue processing in the stack. More...

bool	isActive () const
	Get active connection state flag. More...

uint32	getCurrentTimestamp () const
	Get the timestamp that should be given for a packet whose payload sampling instant corresponds to the current system time. More...

void	setSessionBandwidth (uint32 bw)
	Specify the bandwidth of the current session. More...

uint32	getDefaultSessionBandwidth () const

uint32	getSessionBandwidth () const

void	setTimeclock ()
	Set the packet timeclock for synchronizing timestamps. More...

timeout_t	getTimeclock () const
	Get the packet timeclock for synchronizing timestamps. More...

SyncSourcesIterator	begin ()

SyncSourcesIterator	end ()

const AppDataUnit *	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. 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...

CryptoContext *	getInQueueCryptoContext (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

bool	addDestination (const InetHostAddress &ia, tpport_t dataPort=DefaultRTPDataPort, tpport_t controlPort=0)

bool	addDestination (const InetMcastAddress &ia, tpport_t dataPort=DefaultRTPDataPort, tpport_t controlPort=0)

bool	forgetDestination (const InetHostAddress &ia, tpport_t dataPort=DefaultRTPDataPort, tpport_t controlPort=0)

bool	forgetDestination (const InetMcastAddress &ia, tpport_t dataPort=DefaultRTPDataPort, tpport_t controlPort=0)

void	addContributor (uint32 csrc)
	Add csrc as the CSRC identifier of a new contributor. More...

bool	removeContributor (uint32 csrc)
	Remove CSRC from the list of contributors. More...

bool	isSending () const
	Determine if outgoing packets are waiting to send. More...

void	putData (uint32 stamp, const unsigned char *data=NULL, size_t len=0)
	This is used to create a data packet in the send queue. More...

void	sendImmediate (uint32 stamp, const unsigned char *data=NULL, size_t len=0)
	This is used to create a data packet and send it immediately. More...

void	setPadding (uint8 paddinglen)
	Set padding. More...

void	setMark (bool mark)
	Set marker bit for the packet in which the next data provided will be send. More...

bool	getMark () const
	Get wheter the mark bit will be set in the next packet. More...

size_t	setPartial (uint32 timestamp, unsigned char *data, size_t offset, size_t max)
	Set partial data for an already queued packet. More...

microtimeout_t	getDefaultSchedulingTimeout () const

void	setSchedulingTimeout (microtimeout_t to)
	Set the default scheduling timeout to use when no data packets are waiting to be sent. More...

microtimeout_t	getDefaultExpireTimeout () const

void	setExpireTimeout (microtimeout_t to)
	Set the "expired" timer for expiring packets pending in the send queue which have gone unsent and are already "too late" to be sent now. More...

microtimeout_t	getExpireTimeout () const

uint32	getSendPacketCount () const
	Get the total number of packets sent so far. More...

uint32	getSendOctetCount () const
	Get the total number of octets (payload only) sent so far. More...

uint16	getSequenceNumber () const
	Get the sequence number of the next outgoing packet. More...

void	setOutQueueCryptoContext (CryptoContext *cc)
	Set ouput queue CryptoContext. More...

void	removeOutQueueCryptoContext (CryptoContext *cc)
	Remove output queue CryptoContext. More...

CryptoContext *	getOutQueueCryptoContext (uint32 ssrc)
	Get an output queue CryptoContext identified by SSRC. More...

size_t	getDefaultMaxSendSegmentSize ()

void	setMaxSendSegmentSize (size_t size)
	Set maximum payload segment size before fragmenting sends. More...

size_t	getMaxSendSegmentSize ()

Static Public Member Functions
static size_t	getDefaultMembersSize ()

Protected Types
enum	{ defaultPathMTU = 1500 }

Protected Member Functions
	AVPQueue (uint32 size=RTPDataQueue::defaultMembersHashSize, RTPApplication &app=defaultApplication())

	AVPQueue (uint32 ssrc, uint32 size=RTPDataQueue::defaultMembersHashSize, RTPApplication &app=defaultApplication())
	Local SSRC is given instead of computed by the queue. More...

virtual	~AVPQueue ()

const RTPApplication &	getApplication ()

void	controlTransmissionService ()
	Build and send RTCP packets following timing rules (including the "timer reconsideration" algorithm). More...

void	controlReceptionService ()
	Process incoming RTCP packets pending in the control reception socket. More...

bool	checkSSRCInRTCPPkt (SyncSourceLink &sourceLink, bool is_new, InetAddress &na, tpport_t tp)
	Appy collision and loop detection and correction algorithm when receiving RTCP packets. More...

void	endQueueRTCPManager ()

virtual void	onGotSR (SyncSource &source, SendReport &SR, uint8 blocks)
	Plug-in for processing (acquire information carried in) an incoming RTCP Sender Report. More...

virtual void	onGotRR (SyncSource &source, RecvReport &RR, uint8 blocks)
	Plug-in for processing (acquire information carried in) an incoming RTCP Receiver Report. More...

bool	onGotSDES (SyncSource &source, RTCPPacket &pkt)

virtual bool	onGotSDESChunk (SyncSource &source, SDESChunk &chunk, size_t len)
	Plug-in for handling of SDES chunks. More...

virtual void	onGotAPP (SyncSource &, RTCPCompoundHandler::APPPacket &, size_t)
	Plug-in for handling of APP (application specific) RTCP packets. More...

timeval	getRTCPCheckInterval ()

uint32	getLastSendPacketCount () const
	Get the number of data packets sent at the time the last SR was generated. More...

void	setPrevMembersNum (uint32 n)

uint32	getPrevMembersCount () const

size_t	dispatchBYE (const std::string &reason)
	This method is used to send an RTCP BYE packet. More...

size_t	sendControlToDestinations (unsigned char *buffer, size_t len)

virtual void	timerTick ()
	A plugin point for timer tick driven events. More...

void	renewLocalSSRC ()

void	endQueue ()
	This method ends the queue. More...

virtual bool	isPendingData (microtimeout_t timeout)=0
	This function is used to check for and schedule against arriving packets based on the derived connection type. More...

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

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

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

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	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)

void	dispatchImmediate (OutgoingRTPPkt *packet)
	This is used to write the RTP data packet to one or more destinations. More...

microtimeout_t	getSchedulingTimeout ()
	This computes the timeout period for scheduling transmission of the next packet at the "head" of the send buffer. More...

size_t	dispatchDataPacket ()
	This function is used by the service thread to process the next outgoing packet pending in the sending queue. More...

void	setNextSeqNum (uint32 seqNum)
	For thoses cases in which the application requires a method to set the sequence number for the outgoing stream (such as for implementing the RTSP PLAY command). More...

uint32	getCurrentSeqNum (void)

void	setInitialTimestamp (uint32 ts)

uint32	getInitialTimestamp ()

void	purgeOutgoingQueue ()

virtual void	setControlPeer (const InetAddress &host, tpport_t port)

bool	isSingleDestination () const
	Get whether there is only a destination in the list. More...

TransportAddress *	getFirstDestination () const

void	lockDestinationList () const

void	unlockDestinationList () const

void	writeLockDestinationList () const

bool	addDestinationToList (const InetAddress &ia, tpport_t data, tpport_t control)
	Locks the object before modifying it. More...

bool	removeDestinationFromList (const InetAddress &ia, tpport_t dataPort, tpport_t controlPort)
	Locks the object before modifying it. More...

void	setPathMTU (uint16 mtu)

uint16	getPathMTU ()

bool	checkCompoundRTCPHeader (size_t len)
	Perform RTCP compound packet header validity check as specified in draft-ietv-avt-rtp-new. More...

Protected Attributes
ThreadLock	recvLock

IncomingRTPPktLink *	recvFirst

IncomingRTPPktLink *	recvLast

uint8	minValidPacketSequence

uint16	maxPacketMisorder

uint16	maxPacketDropout

uint8	sourceExpirationPeriod

Mutex	cryptoMutex

Mutex	cryptoMutex

std::list< CryptoContext * >	cryptoContexts

std::list< CryptoContext * >	cryptoContexts

ConflictingTransportAddress *	firstConflict

ConflictingTransportAddress *	lastConflict

std::list< TransportAddress * >	destList

unsigned char *	rtcpSendBuffer

unsigned char *	rtcpRecvBuffer

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

This class, an RTP/RTCP queue, adds audio/video profile (AVP) specific methods to the generic RTCP service queue (QueueRTCPManager).

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

Definition at line 708 of file cqueue.h.

Member Enumeration Documentation

anonymous enum

protectedinherited

Enumerator
defaultPathMTU

Definition at line 330 of file rtcppkt.h.

enum RTPDataQueue::Tos

inherited

rtp.h cc++/rtp.h

Type of network service the application uses.

If the application uses enhanced network service, for instance Integrated Services or Differentiated Services, it has not to ensure fair competition with TCP, provided that the requested service is actually being delivered. Whenever the application uses best-effort service or the requested enhanced service is not actually being delivered, it has to ensure fair competition with TCP. By default, best-effot is assumed.

Note: Although not required, RTP packets are always sent on top of UDP segments. No other underlying transport protocol is supported at present.

Todo:: implement fair competition with tcp

Enumerator
tosBestEffort	Best-effort network service.
tosEnhanced	Enhanced network service.

Definition at line 98 of file ioqueue.h.

Constructor & Destructor Documentation

AVPQueue::AVPQueue	(	uint32	size = `RTPDataQueue::defaultMembersHashSize`,
		RTPApplication &	app = `defaultApplication()`
	)

inlineprotected

Definition at line 735 of file cqueue.h.

AVPQueue::AVPQueue	(	uint32	ssrc,
		uint32	size = `RTPDataQueue::defaultMembersHashSize`,
		RTPApplication &	app = `defaultApplication()`
	)

inlineprotected

Local SSRC is given instead of computed by the queue.

Definition at line 743 of file cqueue.h.

virtual AVPQueue::~AVPQueue ( )

inlineprotectedvirtual

Definition at line 748 of file cqueue.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 OutgoingDataQueue::addContributor ( uint32 csrc )

inherited

Add csrc as the CSRC identifier of a new contributor.

This method adds the CSRC identifier to a list of contributors that will be inserted in every packet enqueued from now on.

bool OutgoingDataQueue::addDestination	(	const InetHostAddress &	ia,
		tpport_t	dataPort = `DefaultRTPDataPort`,
		tpport_t	controlPort = `0`
	)

inherited

Definition at line 219 of file outqueue.cpp.

bool OutgoingDataQueue::addDestination	(	const InetMcastAddress &	ia,
		tpport_t	dataPort = `DefaultRTPDataPort`,
		tpport_t	controlPort = `0`
	)

inherited

Definition at line 233 of file outqueue.cpp.

bool DestinationListHandler::addDestinationToList	(	const InetAddress &	ia,
		tpport_t	data,
		tpport_t	control
	)

protectedinherited

Locks the object before modifying it.

Definition at line 74 of file outqueue.cpp.

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

inlineinherited

Definition at line 209 of file iqueue.h.

SyncSourcesIterator IncomingDataQueue::begin ( )

inlineinherited

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 RTCPCompoundHandler::checkCompoundRTCPHeader ( size_t len )

protectedinherited

Perform RTCP compound packet header validity check as specified in draft-ietv-avt-rtp-new.

This method follows appendix A.2. Correct version, payload type, padding bit and length of every RTCP packet in the compound are verified.

Parameters

len	length of the RTCP compound packet in the reception buffer

Returns: whether the header is valid.

Definition at line 107 of file rtcppkt.cpp.

bool IncomingDataQueue::checkSSRCInIncomingRTPPkt	(	SyncSourceLink &	sourceLink,
		bool	is_new,
		InetAddress &	na,
		tpport_t	tp
	)

protectedinherited

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.

Definition at line 299 of file incqueue.cpp.

bool QueueRTCPManager::checkSSRCInRTCPPkt	(	SyncSourceLink &	sourceLink,
		bool	is_new,
		InetAddress &	na,
		tpport_t	tp
	)

protectedinherited

Appy collision and loop detection and correction algorithm when receiving RTCP packets.

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

Parameters

sourceLink	link to the source object.
is_new	whether the source has been just recorded.
na	RTCP packet network address.
tp	RTCP packet source transport port.

Returns: whether the packet must not be discarded.

Definition at line 176 of file control.cpp.

void QueueRTCPManager::controlReceptionService ( )

protectedinherited

Process incoming RTCP packets pending in the control reception socket.

Definition at line 242 of file control.cpp.

void QueueRTCPManager::controlTransmissionService ( )

protectedinherited

Build and send RTCP packets following timing rules (including the "timer reconsideration" algorithm).

Definition at line 264 of file control.cpp.

void RTPDataQueue::disableStack ( )

inlineinherited

Disable packet queue processing in the stack.

Definition at line 129 of file ioqueue.h.

size_t QueueRTCPManager::dispatchBYE ( const std::string & reason )

protectedvirtualinherited

This method is used to send an RTCP BYE packet.

An RTCP BYE packet is sent when one of the the following circumstances occur:

when leaving the session
when we have detected that another synchronization source in the same session is using the same SSRC identifier as us.

Try to post a BYE message. It will send a BYE packet as long as at least one RTP or RTCP packet has been sent before. If the number of members in the session is more than 50, the algorithm described in section 6.3.7 of RFC 3550 is applied in order to avoid a flood of BYE messages.

Parameters

reason reason to specify in the BYE packet.

Reimplemented from RTPQueueBase.

Definition at line 745 of file control.cpp.

size_t OutgoingDataQueue::dispatchDataPacket ( void )

protectedinherited

This function is used by the service thread to process the next outgoing packet pending in the sending queue.

Returns: number of bytes sent. 0 if silent, <0 if error.

Definition at line 549 of file outqueue.cpp.

void OutgoingDataQueue::dispatchImmediate ( OutgoingRTPPkt * packet )

protectedinherited

This is used to write the RTP data packet to one or more destinations.

It is used by both sendImmediate and by dispatchDataPacket.

Parameters

RTP	packet to send.

Definition at line 505 of file outqueue.cpp.

void RTPDataQueue::enableStack ( )

inlineinherited

Enable packet queue processing in the stack.

This method will not any thread of execution.

Definition at line 123 of file ioqueue.h.

SyncSourcesIterator IncomingDataQueue::end ( )

inlineinherited

Definition at line 941 of file iqueue.h.

void RTPDataQueue::endQueue ( void )

protectedinherited

This method ends the queue.

Definition at line 557 of file queue.cpp.

void QueueRTCPManager::endQueueRTCPManager ( )

protectedinherited

Definition at line 167 of file control.cpp.

bool OutgoingDataQueue::forgetDestination	(	const InetHostAddress &	ia,
		tpport_t	dataPort = `DefaultRTPDataPort`,
		tpport_t	controlPort = `0`
	)

inherited

Definition at line 247 of file outqueue.cpp.

bool OutgoingDataQueue::forgetDestination	(	const InetMcastAddress &	ia,
		tpport_t	dataPort = `DefaultRTPDataPort`,
		tpport_t	controlPort = `0`
	)

inherited

Definition at line 257 of file outqueue.cpp.

const RTPApplication& QueueRTCPManager::getApplication ( )

inlineprotectedinherited

Definition at line 259 of file cqueue.h.

float AVPQueue::getControlBandwidth ( ) const

inline

Definition at line 731 of file cqueue.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.

uint32 OutgoingDataQueue::getCurrentSeqNum ( void )

inlineprotectedinherited

Definition at line 522 of file oqueue.h.

uint32 RTPDataQueue::getCurrentTimestamp ( ) const

inherited

Get the timestamp that should be given for a packet whose payload sampling instant corresponds to the current system time.

The timestamp applications should provide for each packet represents the sampling instant of its payload and should not be a reading of the system clock. Nevertheless, the internal operation of the RTP stack relies on the accuracy of the provided timestamp, since several computations assume that there is a certain degree of correspondence between the timestamp and the system clock.

It is recommended that applications use this method in order to periodically adjust the RTP timestamp.

In particular, it is advisable getting the timestamp corresponding to the first sampling instant or any instant after a period of inactivity through a call to this method.

Applications should use the nominal sampling or any other value provided by the coder in order to compute the next timestamps with minimum computational requirement.

For instance, an application using an RTP profile that specifies a fixed sampling rate of 8 Khz with eight bits per sample, continuously transmitting audio blocks 80 octets long, would transmit 100 packets every second. Every packet would carry a timestamp 80 units greater than the previous one. So, the first timestamp would be obtained from this method, whereas the following ones would be computed adding 80 every time. Also the timestamp should be increased for every block whether it is put in the queue or dropped.

The aforementioned increment can be obtained from the RTPDataQueue::getTimestampIncrement() method rather than computing it by hand in the application.

Note: Frame based applications must follow a specific timestamping method, probably specified in a profile.; You should take into account that by default ccRTP assumes that the application begins sampling at the queue creation time. Moreover, the first sampling instant is assigned a "user visible" timestamp of 0, although the RTP stack will then add internally a ramdom offset unknown to the application. That is to say, the application may count samples from 0 in order to get the timestamp for the next packet, provided that the first sampling instant is the same as the queue creation time. Nevertheless, this simpler way of starting will not be as accurate as it would be if the application got at least the first timestamp through getCurrentTimestamp. We provide this option since ccRTP interface is evolving, but we admit that it is ugly, we could remove this option or even replace uint32 timestamps with a restrictively regulated object; suggestions are gladly welcomed

Definition at line 576 of file queue.cpp.

const AppDataUnit * IncomingDataQueue::getData	(	uint32	stamp,
		const SyncSource *	src = `NULL`
	)

inherited

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.

Definition at line 472 of file incqueue.cpp.

microtimeout_t QueueRTCPManager::getDefaultEnd2EndDelay ( ) const

inlineinherited

Definition at line 136 of file cqueue.h.

microtimeout_t OutgoingDataQueue::getDefaultExpireTimeout ( ) const

inlineinherited

Definition at line 368 of file oqueue.h.

uint16 IncomingDataQueue::getDefaultMaxPacketDropout ( ) const

inlineinherited

Definition at line 1035 of file iqueue.h.

uint16 IncomingDataQueue::getDefaultMaxPacketMisorder ( ) const

inlineinherited

Definition at line 1018 of file iqueue.h.

size_t IncomingDataQueueBase::getDefaultMaxRecvPacketSize ( ) const

inlineinherited

Definition at line 298 of file queuebase.h.

size_t OutgoingDataQueueBase::getDefaultMaxSendSegmentSize ( )

inlineinherited

Definition at line 259 of file queuebase.h.

size_t MembershipBookkeeping::getDefaultMembersHashSize ( )

inlineinherited

Definition at line 306 of file iqueue.h.

static size_t IncomingDataQueue::getDefaultMembersSize ( )

inlinestaticinherited

Definition at line 1045 of file iqueue.h.

uint8 IncomingDataQueue::getDefaultMinValidPacketSequence ( ) const

inlineinherited

Definition at line 1002 of file iqueue.h.

microtimeout_t OutgoingDataQueue::getDefaultSchedulingTimeout ( ) const

inlineinherited

Definition at line 354 of file oqueue.h.

uint32 RTPDataQueue::getDefaultSessionBandwidth ( ) const

inlineinherited

Definition at line 215 of file ioqueue.h.

microtimeout_t QueueRTCPManager::getEnd2EndDelay ( ) const

inlineinherited

Definition at line 140 of file cqueue.h.

microtimeout_t OutgoingDataQueue::getExpireTimeout ( ) const

inlineinherited

Definition at line 382 of file oqueue.h.

SyncSourceLink* MembershipBookkeeping::getFirst ( )

inlineprotectedinherited

Definition at line 836 of file iqueue.h.

TransportAddress* DestinationListHandler::getFirstDestination ( ) const

inlineinherited

Definition at line 82 of file oqueue.h.

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

inherited

Get timestamp of first packet waiting in the queue.

Parameters

src	optional 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.

uint32 OutgoingDataQueue::getInitialTimestamp ( )

inlineprotectedinherited

Definition at line 534 of file oqueue.h.

CryptoContext * IncomingDataQueue::getInQueueCryptoContext ( uint32 ssrc )

inherited

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.

Definition at line 773 of file incqueue.cpp.

CryptoContextCtrl * QueueRTCPManager::getInQueueCryptoContextCtrl ( uint32 ssrc )

inherited

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.

Definition at line 1339 of file control.cpp.

SyncSourceLink* MembershipBookkeeping::getLast ( )

inlineprotectedinherited

Definition at line 839 of file iqueue.h.

uint32 QueueRTCPManager::getLastSendPacketCount ( ) const

inlineprotectedinherited

Get the number of data packets sent at the time the last SR was generated.

Definition at line 370 of file cqueue.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.

bool OutgoingDataQueue::getMark ( ) const

inlineinherited

Get wheter the mark bit will be set in the next packet.

Definition at line 337 of file oqueue.h.

uint16 IncomingDataQueue::getMaxPacketDropout ( ) const

inlineinherited

Definition at line 1039 of file iqueue.h.

uint16 IncomingDataQueue::getMaxPacketMisorder ( ) const

inlineinherited

Definition at line 1022 of file iqueue.h.

size_t IncomingDataQueueBase::getMaxRecvPacketSize ( ) const

inlineinherited

Definition at line 302 of file queuebase.h.

size_t OutgoingDataQueueBase::getMaxSendSegmentSize ( )

inlineinherited

Definition at line 273 of file queuebase.h.

uint32 MembershipBookkeeping::getMembersCount ( )

inlineprotectedinherited

Definition at line 843 of file iqueue.h.

uint8 IncomingDataQueue::getMinValidPacketSequence ( ) const

inlineinherited

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.

RTCPReceiverInfo* QueueRTCPManager::getMRReceiverInfo ( SyncSource & srcFrom )

inherited

Ask for the info in the most recent receiver report about the local source received from the source given as parameter.

Parameters

srcFrom Source of the receiver info.

Returns: most recent receiver info received from src.

Return values

NULL	when no receiver report has been received from the specified source.

RTCPSenderInfo* QueueRTCPManager::getMRSenderInfo ( SyncSource & src )

inherited

Get the most recent sender report received from a synchronization source.

Parameters

src	Synchronization source of the sender info.

Returns: Most recent sender info received from src.

Return values

NULL	when no sender report has been received from the specified source.

virtual size_t IncomingDataQueue::getNextDataPacketSize ( ) const

protectedpure virtualinherited

Implemented in RTPDuplex.

CryptoContext * OutgoingDataQueue::getOutQueueCryptoContext ( uint32 ssrc )

inherited

Get an output 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.

Definition at line 661 of file outqueue.cpp.

CryptoContextCtrl * QueueRTCPManager::getOutQueueCryptoContextCtrl ( uint32 ssrc )

inherited

Get an output 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.

Definition at line 1281 of file control.cpp.

uint16 RTCPCompoundHandler::getPathMTU ( )

inlineinherited

Definition at line 95 of file rtcppkt.h.

uint32 QueueRTCPManager::getPrevMembersCount ( ) const

inlineprotectedinherited

Definition at line 381 of file cqueue.h.

timeval QueueRTCPManager::getRTCPCheckInterval ( )

inlineprotectedinherited

Definition at line 362 of file cqueue.h.

microtimeout_t OutgoingDataQueue::getSchedulingTimeout ( void )

protectedinherited

This computes the timeout period for scheduling transmission of the next packet at the "head" of the send buffer.

If no packets are waiting, a default timeout is used. This actually forms the "isPending()" timeout of the rtp receiver in the service thread.

Returns: timeout until next packet is scheduled to send.

Definition at line 303 of file outqueue.cpp.

uint32 MembershipBookkeeping::getSendersCount ( )

inlineprotectedinherited

Definition at line 851 of file iqueue.h.

uint32 OutgoingDataQueue::getSendOctetCount ( ) const

inlineinherited

Get the total number of octets (payload only) sent so far.

Returns: total number of payload octets sent in RTP packets.

Definition at line 400 of file oqueue.h.

uint32 OutgoingDataQueue::getSendPacketCount ( ) const

inlineinherited

Get the total number of packets sent so far.

Returns: total number of packets sent

Definition at line 391 of file oqueue.h.

uint32 QueueRTCPManager::getSendRTCPPacketCount ( ) const

inlineinherited

Get the total number of RTCP packets sent until now.

Definition at line 177 of file cqueue.h.

uint16 OutgoingDataQueue::getSequenceNumber ( ) const

inlineinherited

Get the sequence number of the next outgoing packet.

Returns: the 16 bit sequence number.

Definition at line 409 of file oqueue.h.

uint32 RTPDataQueue::getSessionBandwidth ( ) const

inlineinherited

Definition at line 219 of file ioqueue.h.

MembershipBookkeeping::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.

Definition at line 226 of file members.cpp.

timeout_t RTPDataQueue::getTimeclock ( ) const

inlineinherited

Get the packet timeclock for synchronizing timestamps.

Returns: runtime in milliseconds since last set.

Definition at line 235 of file ioqueue.h.

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

protectedinherited

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

Definition at line 496 of file incqueue.cpp.

bool IncomingDataQueue::insertRecvPacket ( IncomingRTPPktLink * packetLink )

protectedinherited

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.

Definition at line 369 of file incqueue.cpp.

bool RTPDataQueue::isActive ( ) const

inlineinherited

Get active connection state flag.

Returns: true if connection "active".

Definition at line 138 of file ioqueue.h.

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.

virtual bool RTPDataQueue::isPendingData ( microtimeout_t timeout )

protectedpure virtualinherited

This function is used to check for and schedule against arriving packets based on the derived connection type.

Returns: true if packet waiting for processing.

Parameters

number of microseconds to wait.

Implemented in RTPDuplex.

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 OutgoingDataQueue::isSending ( void ) const

inherited

Determine if outgoing packets are waiting to send.

Returns: true if there are packets waiting to be send.

Definition at line 294 of file outqueue.cpp.

bool DestinationListHandler::isSingleDestination ( ) const

inlineinherited

Get whether there is only a destination in the list.

Definition at line 79 of file oqueue.h.

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

inherited

Determine if packets are waiting in the reception queue.

Parameters

src	Optional synchronization source selector.

Returns: True if packets are waiting.

Definition at line 144 of file incqueue.cpp.

void DestinationListHandler::lockDestinationList ( ) const

inlineinherited

Definition at line 85 of file oqueue.h.

virtual void IncomingDataQueue::onExpireRecv ( IncomingRTPPkt & )

inlineprotectedvirtualinherited

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 QueueRTCPManager::onGotAPP	(	SyncSource &	,
		RTCPCompoundHandler::APPPacket &	,
		size_t
	)

inlineprotectedvirtualinherited

Plug-in for handling of APP (application specific) RTCP packets.

Parameters

-	Synchronization source of this packet.
-	RTCP APP packet struct.
-	Length of the app data packet, including ssrc. name and app. specific data.

Definition at line 357 of file cqueue.h.

void QueueRTCPManager::onGotRR	(	SyncSource &	source,
		RecvReport &	RR,
		uint8	blocks
	)

protectedvirtualinherited

Plug-in for processing (acquire information carried in) an incoming RTCP Receiver Report.

The default implementation in this class only processes the receiver report blocks about the local source.

Parameters

source	Synchronization source this report comes from.
RR	Receiver report structure
blocks	Number of report blocks in the packet

Definition at line 509 of file control.cpp.

bool QueueRTCPManager::onGotSDES	(	SyncSource &	source,
		RTCPPacket &	pkt
	)

protectedinherited

Parameters

source	Synchronization source of SDES RTCP packet.
pkt	SDES RTCP packet received.

Definition at line 597 of file control.cpp.

bool QueueRTCPManager::onGotSDESChunk	(	SyncSource &	source,
		SDESChunk &	chunk,
		size_t	len
	)

protectedvirtualinherited

Plug-in for handling of SDES chunks.

Parameters

source	Synchronization source of SDES chunk.
chunk	SDES chunk structure.
len	Length of chunk, in octets.

Returns: whether there was a CNAME.

Definition at line 629 of file control.cpp.

void QueueRTCPManager::onGotSR	(	SyncSource &	source,
		SendReport &	SR,
		uint8	blocks
	)

protectedvirtualinherited

Plug-in for processing (acquire information carried in) an incoming RTCP Sender Report.

The default implementation in this class only processes the sender information and the receiver report blocks about the local source.

Parameters

source	Synchronization source this report comes from.
SR	Sender report structure.
blocks	Number of report blocks in the packet.

Definition at line 502 of file control.cpp.

virtual void IncomingDataQueue::onNewSyncSource ( const SyncSource & )

inlineprotectedvirtualinherited

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 & )

inlineprotectedvirtualinherited

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
	)

inlineprotectedvirtualinherited

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 ( )

protectedinherited

Definition at line 105 of file incqueue.cpp.

void OutgoingDataQueue::purgeOutgoingQueue ( )

protectedinherited

Definition at line 203 of file outqueue.cpp.

void OutgoingDataQueue::putData	(	uint32	stamp,
		const unsigned char *	data = `NULL`,
		size_t	len = `0`
	)

inherited

This is used to create a data packet in the send queue.

Sometimes a "NULL" or empty packet will be used instead, and these are known as "silent" packets. "Silent" packets are used simply to "push" the scheduler along more accurately by giving the appearence that a next packet is waiting to be sent and to provide a valid timestamp for that packet.

Parameters

stamp	Timestamp for expected send time of packet.
data	Value or NULL if special "silent" packet.
len	May be 0 to indicate a default by payload type.

Definition at line 404 of file outqueue.cpp.

void IncomingDataQueue::recordExtraction ( const IncomingRTPPkt & pkt )

protectedinherited

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

Parameters

pkt	Packet extracted from the queue.

Definition at line 725 of file incqueue.cpp.

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

protectedinherited

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.

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 virtualinherited

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.

bool OutgoingDataQueue::removeContributor ( uint32 csrc )

inherited

Remove CSRC from the list of contributors.

bool DestinationListHandler::removeDestinationFromList	(	const InetAddress &	ia,
		tpport_t	dataPort,
		tpport_t	controlPort
	)

protectedinherited

Locks the object before modifying it.

Definition at line 85 of file outqueue.cpp.

void IncomingDataQueue::removeInQueueCryptoContext ( CryptoContext * cc )

inherited

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

Definition at line 748 of file incqueue.cpp.

void QueueRTCPManager::removeInQueueCryptoContextCtrl ( CryptoContextCtrl * cc )

inherited

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

Definition at line 1314 of file control.cpp.

void OutgoingDataQueue::removeOutQueueCryptoContext ( CryptoContext * cc )

inherited

Remove output queue CryptoContext.

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

Parameters

cc	Pointer to initialized CryptoContext to remove.

Definition at line 636 of file outqueue.cpp.

void QueueRTCPManager::removeOutQueueCryptoContextCtrl ( CryptoContextCtrl * cc )

inherited

Remove output queue CryptoContext.

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

Parameters

cc	Pointer to initialized CryptoContext to remove.

Definition at line 1256 of file control.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 RTPDataQueue::renewLocalSSRC ( )

inlineprotectedvirtualinherited

Reimplemented from RTPQueueBase.

Definition at line 281 of file ioqueue.h.

ConflictHandler::ConflictingTransportAddress * ConflictHandler::searchControlConflict	(	InetAddress	na,
		tpport_t	ctp
	)

inherited

Parameters

na	Inet network address.
ctp	Data transport port.

Definition at line 64 of file incqueue.cpp.

ConflictHandler::ConflictingTransportAddress * ConflictHandler::searchDataConflict	(	InetAddress	na,
		tpport_t	dtp
	)

inherited

Parameters

na	Inet network address.
dtp	Data transport port.

Definition at line 54 of file incqueue.cpp.

size_t QueueRTCPManager::sendControlToDestinations	(	unsigned char *	buffer,
		size_t	len
	)

protectedinherited

Definition at line 1124 of file control.cpp.

void OutgoingDataQueue::sendImmediate	(	uint32	stamp,
		const unsigned char *	data = `NULL`,
		size_t	len = `0`
	)

inherited

This is used to create a data packet and send it immediately.

Sometimes a "NULL" or empty packet will be used instead, and these are known as "silent" packets. "Silent" packets are used simply to "push" the scheduler along more accurately by giving the appearence that a next packet is waiting to be sent and to provide a valid timestamp for that packet.

Parameters

stamp	Timestamp immediate send time of packet.
data	Value or NULL if special "silent" packet.
len	May be 0 to indicate a default by payload type.

Definition at line 464 of file outqueue.cpp.

void AVPQueue::setControlBandwidth ( float fraction )

inline

Specify the bandwith available for control (RTCP) packets.

This method sets the global control bandwidth for both sender and receiver reports. As recommended in RFC 1890, 1/4 of the total control bandwidth is dedicated to senders, whereas 3/4 are dedicated to receivers.

Parameters

fraction fraction of the session bandwidth, between 0 and 1

Note: If this method is not called, it is assumed that the control bandwidth is equal to 5% of the session bandwidth. Note also that the RFC RECOMMENDS the 5%.

Definition at line 727 of file cqueue.h.

virtual void OutgoingDataQueue::setControlPeer	(	const InetAddress &	host,
		tpport_t	port
	)

inlineprotectedvirtualinherited

Reimplemented in RTPDuplex.

Definition at line 540 of file oqueue.h.

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 QueueRTCPManager::setEnd2EndDelay ( microtimeout_t t )

inlineinherited

This method sets the maximum end to end delay allowed.

If the processing delay plus the trip time for a packet is greater than the end to end delay, the packet is discarded, and the application cannot get it.

This is a way of setting an upper bound to the end to end delay, computed as the elapsed time between the packet timestamping at the sender side, and the picking of the packet at the receiver side.

Parameters

t	maximum end to end delay allowed. A value of 0 implies there is no limit and is the default

Definition at line 132 of file cqueue.h.

void OutgoingDataQueue::setExpireTimeout ( microtimeout_t to )

inlineinherited

Set the "expired" timer for expiring packets pending in the send queue which have gone unsent and are already "too late" to be sent now.

Parameters

to	timeout to expire unsent packets in milliseconds.

Definition at line 379 of file oqueue.h.

void OutgoingDataQueue::setInitialTimestamp ( uint32 ts )

inlineprotectedinherited

Definition at line 528 of file oqueue.h.

void IncomingDataQueue::setInQueueCryptoContext ( CryptoContext * cc )

inherited

Set input queue CryptoContext.

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

Parameters

cc	Pointer to initialized CryptoContext.

Definition at line 729 of file incqueue.cpp.

void QueueRTCPManager::setInQueueCryptoContextCtrl ( CryptoContextCtrl * cc )

inherited

Set input queue CryptoContext.

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

Parameters

cc	Pointer to initialized CryptoContext.

Definition at line 1295 of file control.cpp.

void QueueRTCPManager::setLeavingDelay ( microtimeout_t delay )

inlineinherited

Set how much time the stack will wait before deleting a synchronization source that has sent an RTCP BYE packet.

Parameters

delay delay in microseconds.

Note: The default delay is 1000000 microseconds

Definition at line 114 of file cqueue.h.

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 OutgoingDataQueue::setMark ( bool mark )

inlineinherited

Set marker bit for the packet in which the next data provided will be send.

When transmitting audio, should be set for the first packet of a talk spurt. When transmitting video, should be set for the last packet for a video frame.

Parameters

mark	Marker bit value for next packet.

Definition at line 331 of file oqueue.h.

void IncomingDataQueue::setMaxPacketDropout ( uint16 packets )

inlineinherited

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 )

inlineinherited

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

void OutgoingDataQueueBase::setMaxSendSegmentSize ( size_t size )

inlineinherited

Set maximum payload segment size before fragmenting sends.

Parameters

size	Maximum payload size.

Returns: Whether segment size was successfully set.

Definition at line 269 of file queuebase.h.

void MembershipBookkeeping::setMembersCount ( uint32 n )

inlineprotectedinherited

Definition at line 847 of file iqueue.h.

void QueueRTCPManager::setMinRTCPInterval ( microtimeout_t interval )

inlineinherited

Manually set the minimum interval for sending RTP compound packets.

Parameters

interval minimum interval between RTCP packets, in microseconds.

See Also: computeRTCPInterval()

Definition at line 170 of file cqueue.h.

void IncomingDataQueue::setMinValidPacketSequence ( uint8 packets )

inlineinherited

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 162 of file iqueue.h.

void OutgoingDataQueue::setNextSeqNum ( uint32 seqNum )

inlineprotectedinherited

For thoses cases in which the application requires a method to set the sequence number for the outgoing stream (such as for implementing the RTSP PLAY command).

Parameters

seqNum next sequence number to be used for outgoing packets.

Definition at line 518 of file oqueue.h.

void OutgoingDataQueue::setOutQueueCryptoContext ( CryptoContext * cc )

inherited

Set ouput queue CryptoContext.

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

Parameters

cc	Pointer to initialized CryptoContext.

Definition at line 617 of file outqueue.cpp.

void QueueRTCPManager::setOutQueueCryptoContextCtrl ( CryptoContextCtrl * cc )

inherited

Set ouput queue CryptoContext.

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

Parameters

cc	Pointer to initialized CryptoContext.

Definition at line 1237 of file control.cpp.

void OutgoingDataQueue::setPadding ( uint8 paddinglen )

inlineinherited

Set padding.

All outgoing packets will be transparently padded to a multiple of paddinglen.

Parameters

paddinglen pad packets to a length multiple of paddinglen.

Definition at line 320 of file oqueue.h.

size_t OutgoingDataQueue::setPartial	(	uint32	timestamp,
		unsigned char *	data,
		size_t	offset,
		size_t	max
	)

inherited

Set partial data for an already queued packet.

This is often used for multichannel data.

Parameters

timestamp	Timestamp of packet.
data	Buffer to copy from.
offset	Offset to copy from.
max	Maximum data size.

Returns: Number of packet data bytes set.

Definition at line 581 of file outqueue.cpp.

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

inlineinherited

Definition at line 142 of file iqueue.h.

void RTCPCompoundHandler::setPathMTU ( uint16 mtu )

inlineinherited

Definition at line 92 of file rtcppkt.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 177 of file queuebase.h.

void QueueRTCPManager::setPrevMembersNum ( uint32 n )

inlineprotectedinherited

Parameters

n	Number of members.

Definition at line 377 of file cqueue.h.

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

inlineinherited

Definition at line 188 of file iqueue.h.

void OutgoingDataQueue::setSchedulingTimeout ( microtimeout_t to )

inlineinherited

Set the default scheduling timeout to use when no data packets are waiting to be sent.

Parameters

to	timeout in milliseconds.

Definition at line 364 of file oqueue.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 QueueRTCPManager::setSendersControlFraction ( float fraction )

inlineinherited

Specify the fraction of the total control bandwith to be dedicated to senders reports.

Parameters

fraction fraction of bandwidth, must be between 0 an 1.

This method sets the fraction of the global control bandwidth that will be dedicated to senders reports. Of course, 1 - fraction will be dedicated to receivers reports.

See Also: setControlBandwidth

Definition at line 157 of file cqueue.h.

void RTPDataQueue::setSessionBandwidth ( uint32 bw )

inlineinherited

Specify the bandwidth of the current session.

Parameters

bw	bandwidth of the current session, in bits/s.

See Also: AVPQueue::setControlBandwidth()

Definition at line 211 of file ioqueue.h.

void IncomingDataQueue::setSourceExpirationPeriod ( uint8 intervals )

inlineprotectedinherited

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 146 of file iqueue.h.

void RTPDataQueue::setTimeclock ( )

inlineinherited

Set the packet timeclock for synchronizing timestamps.

Definition at line 226 of file ioqueue.h.

void RTPDataQueue::setTypeOfService ( Tos tos )

inlineinherited

Specify the kind of service the application expects to use.

Parameters

tos	type of service the application expects to use

Note: If enhanced service is specified but packet loss is high (the requested service does not appear to actually be delivered) ccRTP defaults to best-effort suitable behaviour: guarantee fair competition with TCP.

Todo:: Implement fair competition with tcp

Definition at line 116 of file ioqueue.h.

size_t IncomingDataQueue::takeInDataPacket ( void )

protectedvirtualinherited

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.

virtual void RTPDataQueue::timerTick ( )

inlineprotectedvirtualinherited

A plugin point for timer tick driven events.

Definition at line 278 of file ioqueue.h.

void DestinationListHandler::unlockDestinationList ( ) const

inlineinherited

Definition at line 88 of file oqueue.h.

void ConflictHandler::updateConflict ( ConflictingTransportAddress & ca )

inlineinherited

Definition at line 273 of file iqueue.h.

void DestinationListHandler::writeLockDestinationList ( ) const

inlineprotectedinherited

Definition at line 92 of file oqueue.h.

Field Documentation

bool OutgoingDataQueue::complete

inherited

Definition at line 615 of file oqueue.h.

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

protectedinherited

Definition at line 549 of file oqueue.h.

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

protectedinherited

Definition at line 1290 of file iqueue.h.

Mutex OutgoingDataQueue::cryptoMutex

mutableprotectedinherited

Definition at line 548 of file oqueue.h.

Mutex IncomingDataQueue::cryptoMutex

mutableprotectedinherited

Definition at line 1289 of file iqueue.h.

const uint16 IncomingDataQueue::defaultMaxPacketDropout = 3000

staticprotectedinherited

Definition at line 1283 of file iqueue.h.

const uint16 IncomingDataQueue::defaultMaxPacketMisorder = 0

staticprotectedinherited

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

staticprotectedinherited

Initial value:

=

MembershipBookkeeping::defaultMembersHashSize

Definition at line 1287 of file iqueue.h.

const uint8 IncomingDataQueue::defaultMinValidPacketSequence = 0

staticprotectedinherited

Definition at line 1281 of file iqueue.h.

std::list<TransportAddress*> DestinationListHandler::destList

protectedinherited

Definition at line 68 of file oqueue.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.

bool OutgoingDataQueue::marked

inherited

Definition at line 613 of file oqueue.h.

uint16 IncomingDataQueue::maxPacketDropout

protectedinherited

Definition at line 1286 of file iqueue.h.

uint16 IncomingDataQueue::maxPacketMisorder

protectedinherited

Definition at line 1285 of file iqueue.h.

uint8 IncomingDataQueue::minValidPacketSequence

protectedinherited

Definition at line 1284 of file iqueue.h.

uint32 OutgoingDataQueue::octetCount

inherited

Definition at line 601 of file oqueue.h.

timeval OutgoingDataQueue::overflowTime

inherited

Definition at line 620 of file oqueue.h.

uint32 OutgoingDataQueue::packetCount

inherited

Definition at line 599 of file oqueue.h.

uint8 OutgoingDataQueue::paddinglen

inherited

Definition at line 609 of file oqueue.h.

IncomingRTPPktLink* IncomingDataQueue::recvFirst

protectedinherited

Definition at line 1279 of file iqueue.h.

IncomingRTPPktLink * IncomingDataQueue::recvLast

protectedinherited

Definition at line 1279 of file iqueue.h.

ThreadLock IncomingDataQueue::recvLock

mutableprotectedinherited

Definition at line 1277 of file iqueue.h.

uint32 QueueRTCPManager::rtcpPMembers

inherited

Definition at line 659 of file cqueue.h.

unsigned char* RTCPCompoundHandler::rtcpRecvBuffer

protectedinherited

Definition at line 355 of file rtcppkt.h.

unsigned char* RTCPCompoundHandler::rtcpSendBuffer

protectedinherited

Definition at line 352 of file rtcppkt.h.

timeval QueueRTCPManager::rtcpTc

inherited

Definition at line 658 of file cqueue.h.

timeval QueueRTCPManager::rtcpTn

inherited

Definition at line 658 of file cqueue.h.

timeval QueueRTCPManager::rtcpTp

inherited

Definition at line 658 of file cqueue.h.

uint16 OutgoingDataQueue::sendCC

inherited

Definition at line 607 of file oqueue.h.

uint16 OutgoingDataQueue::sendSeq

inherited

Definition at line 603 of file oqueue.h.

uint32 OutgoingDataQueue::sendSources[16]

inherited

Definition at line 605 of file oqueue.h.

const uint32 MembershipBookkeeping::SEQNUMMOD = (1<<16)

staticprotectedinherited

Definition at line 855 of file iqueue.h.

uint8 IncomingDataQueue::sourceExpirationPeriod

protectedinherited

Definition at line 1288 of file iqueue.h.

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

cqueue.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation