#include <iqueue.h>
Public Member Functions | |
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 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. | |
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 |
Protected Attributes | |
ThreadLock | recvLock |
IncomingRTPPktLink * | recvFirst |
IncomingRTPPktLink * | recvLast |
uint8 | minValidPacketSequence |
uint16 | maxPacketMisorder |
uint16 | maxPacketDropout |
uint8 | sourceExpirationPeriod |
Mutex | cryptoMutex |
std::list< CryptoContext * > | cryptoContexts |
Static Protected Attributes | |
static const uint8 | defaultMinValidPacketSequence |
static const uint16 | defaultMaxPacketMisorder |
static const uint16 | defaultMaxPacketDropout |
static const size_t | defaultMembersSize |
Classes | |
class | SyncSourcesIterator |
iterator through the list of synchronizations sources in this session More... |
IncomingDataQueue::IncomingDataQueue | ( | uint32 | size | ) | [protected] |
size | initial size of the membership table. |
virtual IncomingDataQueue::~IncomingDataQueue | ( | ) | [inline, protected, virtual] |
SyncSourcesIterator IncomingDataQueue::begin | ( | ) | [inline] |
SyncSourcesIterator IncomingDataQueue::end | ( | ) | [inline] |
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.
stamp | Data unit timestamp. | |
src | Optional synchronization source selector. |
null | pointer if no packet with such timestamp is available. |
bool IncomingDataQueue::isWaiting | ( | const SyncSource * | src = NULL |
) | const |
Determine if packets are waiting in the reception queue.
src | Optional synchronization source selector. |
uint32 IncomingDataQueue::getFirstTimestamp | ( | const SyncSource * | src = NULL |
) | const |
Get timestamp of first packet waiting in the queue.
src | optional source selector. |
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.
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.
packets | number of sequential packet required |
uint8 IncomingDataQueue::getDefaultMinValidPacketSequence | ( | ) | const [inline] |
uint8 IncomingDataQueue::getMinValidPacketSequence | ( | ) | const [inline] |
Get the minimun number of consecutive packets that must be received from a source before accepting its data packets.
void IncomingDataQueue::setMaxPacketMisorder | ( | uint16 | packets | ) | [inline] |
uint16 IncomingDataQueue::getDefaultMaxPacketMisorder | ( | ) | const [inline] |
uint16 IncomingDataQueue::getMaxPacketMisorder | ( | ) | const [inline] |
void IncomingDataQueue::setMaxPacketDropout | ( | uint16 | packets | ) | [inline] |
It also prevents packets sent after a restart of the source being immediately accepted.
uint16 IncomingDataQueue::getDefaultMaxPacketDropout | ( | ) | const [inline] |
uint16 IncomingDataQueue::getMaxPacketDropout | ( | ) | const [inline] |
static size_t IncomingDataQueue::getDefaultMembersSize | ( | ) | [inline, static] |
void IncomingDataQueue::setInQueueCryptoContext | ( | CryptoContext * | cc | ) |
Set input queue CryptoContext.
The endQueue method (provided by RTPQueue) deletes all registered CryptoContexts.
cc | Pointer to initialized CryptoContext. |
void IncomingDataQueue::removeInQueueCryptoContext | ( | CryptoContext * | cc | ) |
Remove input queue CryptoContext.
The endQueue method (provided by RTPQueue) also deletes all registered CryptoContexts.
cc | Pointer to initialized CryptoContext to remove. If pointer if NULL then delete the whole queue |
CryptoContext* IncomingDataQueue::getInQueueCryptoContext | ( | uint32 | ssrc | ) |
Get an input queue CryptoContext identified by SSRC.
ssrc | Request CryptoContext for this incoming SSRC |
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.
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. |
void IncomingDataQueue::setSourceExpirationPeriod | ( | uint8 | intervals | ) | [inline, protected] |
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.
intervals | number of RTCP report intervals |
The default for this value is, as RECOMMENDED, 5.
virtual size_t IncomingDataQueue::takeInDataPacket | ( | ) | [protected, virtual] |
This function is used by the service thread to process the next incoming packet and place it in the receive list.
void IncomingDataQueue::renewLocalSSRC | ( | ) | [protected, virtual] |
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.
timestamp | timestamp requested. | |
src | optional source selector |
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.
srcLink | Link structure for the synchronization source of this packet. | |
pkt | Packet just created and to be logged. | |
recvtime | Reception time. |
void IncomingDataQueue::recordExtraction | ( | const IncomingRTPPkt & | pkt | ) | [protected] |
Log extraction of a packet from this source from the scheduled reception queue.
pkt | Packet extracted from the queue. |
void IncomingDataQueue::purgeIncomingQueue | ( | ) | [protected] |
virtual void IncomingDataQueue::onNewSyncSource | ( | const SyncSource & | ) | [inline, protected, virtual] |
Virtual called when a new synchronization source has joined the session.
- | new synchronization source |
virtual bool IncomingDataQueue::onRTPPacketRecv | ( | IncomingRTPPkt & | ) | [inline, protected, virtual] |
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.
- | packet just received. |
virtual void IncomingDataQueue::onExpireRecv | ( | IncomingRTPPkt & | ) | [inline, protected, virtual] |
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.
- | packet expired from the recv queue. |
virtual bool IncomingDataQueue::onSRTPPacketError | ( | IncomingRTPPkt & | pkt, | |
int32 | errorCode | |||
) | [inline, protected, virtual] |
A hook that gets called if the decoding of an incoming SRTP was erroneous.
pkt | The SRTP packet with error. | |
errorCode | The error code: -1 - SRTP authentication failure, -2 - replay check failed |
virtual bool IncomingDataQueue::end2EndDelayed | ( | IncomingRTPPktLink & | ) | [inline, protected, virtual] |
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.
packetLink | link to a packet just received and generally validated and processed by onRTPPacketRecv. |
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. |
virtual size_t IncomingDataQueue::recvData | ( | unsigned char * | buffer, | |
size_t | length, | |||
InetHostAddress & | host, | |||
tpport_t & | port | |||
) | [protected, pure 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.
buffer | of read packet. | |
length | of data to read. | |
host | address of source. | |
port | number of source. |
Implemented in RTPDuplex.
virtual size_t IncomingDataQueue::getNextDataPacketSize | ( | ) | const [protected, pure virtual] |
Implemented in RTPDuplex.
ThreadLock IncomingDataQueue::recvLock [mutable, protected] |
IncomingRTPPktLink* IncomingDataQueue::recvFirst [protected] |
IncomingRTPPktLink * IncomingDataQueue::recvLast [protected] |
const uint8 IncomingDataQueue::defaultMinValidPacketSequence [static, protected] |
const uint16 IncomingDataQueue::defaultMaxPacketMisorder [static, protected] |
const uint16 IncomingDataQueue::defaultMaxPacketDropout [static, protected] |
uint8 IncomingDataQueue::minValidPacketSequence [protected] |
uint16 IncomingDataQueue::maxPacketMisorder [protected] |
uint16 IncomingDataQueue::maxPacketDropout [protected] |
const size_t IncomingDataQueue::defaultMembersSize [static, protected] |
uint8 IncomingDataQueue::sourceExpirationPeriod [protected] |
Mutex IncomingDataQueue::cryptoMutex [mutable, protected] |
std::list<CryptoContext *> IncomingDataQueue::cryptoContexts [protected] |