IncomingDataQueue(3) | Library Functions Manual | IncomingDataQueue(3) |
IncomingDataQueue - Queue for incoming RTP data packets in an RTP session.
#include <iqueue.h>
Inherits IncomingDataQueueBase, and MembershipBookkeeping.
Inherited by RTPDataQueue.
class SyncSourcesIterator
iterator through the list of synchronizations sources in this session
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. bool isWaiting (const
SyncSource *src=NULL) const
Determine if packets are waiting in the reception queue. uint32
getFirstTimestamp (const SyncSource *src=NULL) const
Get timestamp of first packet waiting in the queue. 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. 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. 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. uint16 getDefaultMaxPacketDropout () const
uint16 getMaxPacketDropout () const
void setInQueueCryptoContext (CryptoContext *cc)
Set input queue CryptoContext. void removeInQueueCryptoContext
(CryptoContext *cc)
Remove input queue CryptoContext. CryptoContext *
getInQueueCryptoContext (uint32 ssrc)
Get an input queue CryptoContext identified by SSRC.
static size_t getDefaultMembersSize ()
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. 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. 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. void renewLocalSSRC ()
IncomingDataQueue::IncomingRTPPktLink * getWaiting (uint32
timestamp, const SyncSource *src=NULL)
This is used to fetch a packet in the receive queue and to expire packets
older than the current timestamp. bool recordReception
(SyncSourceLink &srcLink, const IncomingRTPPkt &pkt,
const timeval recvtime)
Log reception of a new RTP packet from this source. void
recordExtraction (const IncomingRTPPkt &pkt)
Log extraction of a packet from this source from the scheduled reception
queue. void purgeIncomingQueue ()
virtual void onNewSyncSource (const SyncSource &)
Virtual called when a new synchronization source has joined the session.
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. virtual void
onExpireRecv (IncomingRTPPkt &)
A hook to filter packets in the receive queue that are being expired. virtual
bool onSRTPPacketError (IncomingRTPPkt &pkt, int32
errorCode)
A hook that gets called if the decoding of an incoming SRTP was erroneous.
virtual bool end2EndDelayed (IncomingRTPPktLink &)
bool insertRecvPacket (IncomingRTPPktLink *packetLink)
Insert a just received packet in the queue (both general and source specific
queues). 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.
virtual size_t getNextDataPacketSize () const =0
ThreadLock recvLock
IncomingRTPPktLink * recvFirst
IncomingRTPPktLink * recvLast
uint8 minValidPacketSequence
uint16 maxPacketMisorder
uint16 maxPacketDropout
uint8 sourceExpirationPeriod
Mutex cryptoMutex
std::list< CryptoContext * > cryptoContexts
static const uint8 defaultMinValidPacketSequence
static const uint16 defaultMaxPacketMisorder
static const uint16 defaultMaxPacketDropout
static const size_t defaultMembersSize
Queue for incoming RTP data packets in an RTP session.
Author:
Parameters:
Apply collision and loop detection and correction algorithm when receiving RTP data packets. Follows section 8.2 in draft-ietf-avt-rtp-new.
Parameters:
Returns:
Retreive data from a specific timestamped packet if such a packet is currently available in the receive buffer.
Parameters:
Returns:
Return values:
Examples:
rtpduphello.cpp.
Get timestamp of first packet waiting in the queue.
Parameters:
Returns:
Examples:
rtpduphello.cpp.
Get an input queue CryptoContext identified by SSRC.
Parameters:
Returns:
Get the minimun number of consecutive packets that must be received from a source before accepting its data packets.
Implemented in RTPDuplex.
This is used to fetch a packet in the receive queue and to expire packets older than the current timestamp.
Returns:
Parameters:
Note:
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:
Returns:
Return values:
Determine if packets are waiting in the reception queue.
Parameters:
Returns:
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:
Virtual called when a new synchronization source has joined the session.
Parameters:
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 successfully, 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:
Returns:
A hook that gets called if the decoding of an incoming SRTP was erroneous.
Parameters:
Returns:
Log extraction of a packet from this source from the scheduled reception queue.
Parameters:
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:
Returns:
This function performs the physical I/O for reading a packet from the source. It is a virtual that is overridden in the derived class.
Returns:
Parameters:
Implemented in RTPDuplex.
Remove input queue CryptoContext. The endQueue method (provided by RTPQueue) also deletes all registered CryptoContexts.
Parameters:
Reimplemented from RTPQueueBase.
Set input queue CryptoContext. The endQueue method (provided by RTPQueue) deletes all registered CryptoContexts.
Parameters:
It also prevents packets sent after a restart of the source being immediately accepted.
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:
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:
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:
Note:
The default for this value is, as RECOMMENDED, 5.
This function is used by the service thread to process the next incoming packet and place it in the receive list.
Returns:
Generated automatically by Doxygen for ccRTP from the source code.
Sat Oct 27 2018 | ccRTP |