MembershipBookkeeping_SyncSourceLink: Synchronization source internal handler within the incoming packets queue.

SYNOPSIS

#include <iqueue.h>

Public Member Functions

SyncSourceLink (MembershipBookkeeping *m, SyncSource *s, IncomingRTPPktLink *fp=NULL, IncomingRTPPktLink *lp=NULL, SyncSourceLink *ps=NULL, SyncSourceLink *ns=NULL, SyncSourceLink *ncollis=NULL)

~SyncSourceLink ()

Note it deletes the source. MembershipBookkeeping * getMembership ()

SyncSource * getSource ()

Get the synchronization source object this link objet holds information for. IncomingRTPPktLink * getFirst ()

Get first RTP (data) packet in the queue of packets received from this socket. void setFirst (IncomingRTPPktLink *fp)

IncomingRTPPktLink * getLast ()

Get last RTP (data) packet in the queue of packets received from this socket. void setLast (IncomingRTPPktLink *lp)

SyncSourceLink * getPrev ()

Get the link object for the previous RTP source. void setPrev (SyncSourceLink *ps)

SyncSourceLink * getNext ()

Get the link object for the next RTP source. void setNext (SyncSourceLink *ns)

SyncSourceLink * getNextCollis ()

Get the link object for the next RTP source in the hash table entry collision list. void setNextCollis (SyncSourceLink *ns)

ConflictingTransportAddress * getPrevConflict () const

void setPrevConflict (InetAddress &addr, tpport_t dataPort, tpport_t controlPort)

Get conflicting address. unsigned char * getSenderInfo ()

void setSenderInfo (unsigned char *si)

unsigned char * getReceiverInfo ()

void setReceiverInfo (unsigned char *ri)

timeval getLastPacketTime () const

timeval getLastRTCPPacketTime () const

timeval getLastRTCPSRTime () const

uint32 getObservedPacketCount () const

Get the total number of RTP packets received from this source. void incObservedPacketCount ()

uint32 getObservedOctetCount () const

Get the total number of payload octets received from this source. void incObservedOctetCount (uint32 n)

uint16 getMaxSeqNum () const

Get the highest valid sequence number received. void setMaxSeqNum (uint16 max)

Set the highest valid sequence number recived. uint32 getExtendedMaxSeqNum () const

void setExtendedMaxSeqNum (uint32 seq)

uint32 getCumulativePacketLost () const

void setCumulativePacketLost (uint32 pl)

uint8 getFractionLost () const

void setFractionLost (uint8 fl)

uint32 getLastPacketTransitTime ()

void setLastPacketTransitTime (uint32 time)

float getJitter () const

void setJitter (float j)

uint32 getInitialDataTimestamp () const

void setInitialDataTimestamp (uint32 ts)

timeval getInitialDataTime () const

void setInitialDataTime (timeval it)

bool getGoodbye ()

Mark this source as having sent a BYE control packet. bool getHello ()

Mark this source as having sent some packet. uint32 getBadSeqNum () const

void setBadSeqNum (uint32 seq)

uint8 getProbation () const

void setProbation (uint8 p)

void decProbation ()

bool isValid () const

uint16 getBaseSeqNum () const

void setBaseSeqNum (uint16 seqnum)

uint32 getSeqNumAccum () const

void incSeqNumAccum ()

void initSequence (uint16 seqnum)

Start a new sequence of received packets. void recordInsertion (const IncomingRTPPktLink &pl)

Record the insertion of an RTP packet from this source into the scheduled reception queue. void initStats ()

void computeStats ()

Compute cumulative packet lost and fraction of packets lost during the last reporting interval.

Public Attributes

MembershipBookkeeping * membership

SyncSource * source

IncomingRTPPktLink * first

IncomingRTPPktLink * last

SyncSourceLink * prev

SyncSourceLink * next

SyncSourceLink * nextCollis

ConflictingTransportAddress * prevConflict

unsigned char * senderInfo

unsigned char * receiverInfo

timeval lastPacketTime

timeval lastRTCPPacketTime

timeval lastRTCPSRTime

uint32 obsPacketCount

uint32 obsOctetCount

uint16 maxSeqNum

uint32 extendedMaxSeqNum

uint32 cumulativePacketLost

uint8 fractionLost

uint32 lastPacketTransitTime

float jitter

uint32 initialDataTimestamp

timeval initialDataTime

bool flag

uint32 badSeqNum

uint8 probation

uint16 baseSeqNum

uint32 expectedPrior

uint32 receivedPrior

uint32 seqNumAccum

Static Public Attributes

static const uint32 SEQNUMMOD

Detailed Description

Synchronization Source internal handler within the incoming packets queue.

Incoming packets queue objects hold a hash table and a linked list of synchronization sources. For each of these sources, there is also a linked list of incoming rtp packets, which are linked in an 'all incoming packets' list as well. SyncSourceLink objects hold the necessary data to maintain these data estructures, as well as source specific information and statistics for RTCP,

Author:

Federico Montesino Pouzols [email protected]

Constructor & Destructor Documentation

MembershipBookkeeping::SyncSourceLink::SyncSourceLink (\fBMembershipBookkeeping\fP m, \fBSyncSource\fP s, \fBIncomingRTPPktLink\fP fp = \fCNULL\fP, \fBIncomingRTPPktLink\fP lp = \fCNULL\fP, \fBSyncSourceLink\fP ps = \fCNULL\fP, \fBSyncSourceLink\fP ns = \fCNULL\fP, \fBSyncSourceLink\fP *ncollis = \fCNULL\fP)\fC [inline]\fP

MembershipBookkeeping::SyncSourceLink::~SyncSourceLink ()

Note it deletes the source.

Member Function Documentation

void MembershipBookkeeping::SyncSourceLink::computeStats ()

Compute cumulative packet lost and fraction of packets lost during the last reporting interval.

void MembershipBookkeeping::SyncSourceLink::decProbation ()\fC [inline]\fP

uint32 MembershipBookkeeping::SyncSourceLink::getBadSeqNum () const\fC [inline]\fP

uint16 MembershipBookkeeping::SyncSourceLink::getBaseSeqNum () const\fC [inline]\fP

uint32 MembershipBookkeeping::SyncSourceLink::getCumulativePacketLost () const\fC [inline]\fP

uint32 MembershipBookkeeping::SyncSourceLink::getExtendedMaxSeqNum () const\fC [inline]\fP

\fBIncomingRTPPktLink\fP* MembershipBookkeeping::SyncSourceLink::getFirst ()\fC [inline]\fP

Get first RTP (data) packet in the queue of packets received from this socket.

uint8 MembershipBookkeeping::SyncSourceLink::getFractionLost () const\fC [inline]\fP

bool MembershipBookkeeping::SyncSourceLink::getGoodbye ()\fC [inline]\fP

Mark this source as having sent a BYE control packet.

Returns:

whether some packet from this source had been received before (getHello() has been called at least once)

bool MembershipBookkeeping::SyncSourceLink::getHello ()\fC [inline]\fP

Mark this source as having sent some packet.

Returns:

whether no packet from this source had been received before

timeval MembershipBookkeeping::SyncSourceLink::getInitialDataTime () const\fC [inline]\fP

uint32 MembershipBookkeeping::SyncSourceLink::getInitialDataTimestamp () const\fC [inline]\fP

float MembershipBookkeeping::SyncSourceLink::getJitter () const\fC [inline]\fP

\fBIncomingRTPPktLink\fP* MembershipBookkeeping::SyncSourceLink::getLast ()\fC [inline]\fP

Get last RTP (data) packet in the queue of packets received from this socket.

timeval MembershipBookkeeping::SyncSourceLink::getLastPacketTime () const\fC [inline]\fP

uint32 MembershipBookkeeping::SyncSourceLink::getLastPacketTransitTime ()\fC [inline]\fP

timeval MembershipBookkeeping::SyncSourceLink::getLastRTCPPacketTime () const\fC [inline]\fP

timeval MembershipBookkeeping::SyncSourceLink::getLastRTCPSRTime () const\fC [inline]\fP

uint16 MembershipBookkeeping::SyncSourceLink::getMaxSeqNum () const\fC [inline]\fP

Get the highest valid sequence number received.

\fBMembershipBookkeeping\fP* MembershipBookkeeping::SyncSourceLink::getMembership ()\fC [inline]\fP

\fBSyncSourceLink\fP* MembershipBookkeeping::SyncSourceLink::getNext ()\fC [inline]\fP

Get the link object for the next RTP source.

\fBSyncSourceLink\fP* MembershipBookkeeping::SyncSourceLink::getNextCollis ()\fC [inline]\fP

Get the link object for the next RTP source in the hash table entry collision list. Note that collision does not refer to SSRC collision, but hash table collision.

uint32 MembershipBookkeeping::SyncSourceLink::getObservedOctetCount () const\fC [inline]\fP

Get the total number of payload octets received from this source.

uint32 MembershipBookkeeping::SyncSourceLink::getObservedPacketCount () const\fC [inline]\fP

Get the total number of RTP packets received from this source.

\fBSyncSourceLink\fP* MembershipBookkeeping::SyncSourceLink::getPrev ()\fC [inline]\fP

Get the link object for the previous RTP source.

ConflictingTransportAddress* MembershipBookkeeping::SyncSourceLink::getPrevConflict () const\fC [inline]\fP

uint8 MembershipBookkeeping::SyncSourceLink::getProbation () const\fC [inline]\fP

unsigned char* MembershipBookkeeping::SyncSourceLink::getReceiverInfo ()\fC [inline]\fP

unsigned char* MembershipBookkeeping::SyncSourceLink::getSenderInfo ()\fC [inline]\fP

uint32 MembershipBookkeeping::SyncSourceLink::getSeqNumAccum () const\fC [inline]\fP

\fBSyncSource\fP* MembershipBookkeeping::SyncSourceLink::getSource ()\fC [inline]\fP

Get the synchronization source object this link objet holds information for.

void MembershipBookkeeping::SyncSourceLink::incObservedOctetCount (uint32n)\fC [inline]\fP

void MembershipBookkeeping::SyncSourceLink::incObservedPacketCount ()\fC [inline]\fP

void MembershipBookkeeping::SyncSourceLink::incSeqNumAccum ()\fC [inline]\fP

void MembershipBookkeeping::SyncSourceLink::initSequence (uint16seqnum)\fC [inline]\fP

Start a new sequence of received packets.

void MembershipBookkeeping::SyncSourceLink::initStats ()

bool MembershipBookkeeping::SyncSourceLink::isValid () const\fC [inline]\fP

void MembershipBookkeeping::SyncSourceLink::recordInsertion (const \fBIncomingRTPPktLink\fP &pl)

Record the insertion of an RTP packet from this source into the scheduled reception queue. All received packets should be registered with recordReception(), but only those actually inserted into the queue should be registered via this method.

Parameters:

pl Link structure for packet inserted into the queue.

void MembershipBookkeeping::SyncSourceLink::setBadSeqNum (uint32seq)\fC [inline]\fP

void MembershipBookkeeping::SyncSourceLink::setBaseSeqNum (uint16seqnum)\fC [inline]\fP

void MembershipBookkeeping::SyncSourceLink::setCumulativePacketLost (uint32pl)\fC [inline]\fP

void MembershipBookkeeping::SyncSourceLink::setExtendedMaxSeqNum (uint32seq)\fC [inline]\fP

void MembershipBookkeeping::SyncSourceLink::setFirst (\fBIncomingRTPPktLink\fP *fp)\fC [inline]\fP

void MembershipBookkeeping::SyncSourceLink::setFractionLost (uint8fl)\fC [inline]\fP

void MembershipBookkeeping::SyncSourceLink::setInitialDataTime (timevalit)\fC [inline]\fP

void MembershipBookkeeping::SyncSourceLink::setInitialDataTimestamp (uint32ts)\fC [inline]\fP

void MembershipBookkeeping::SyncSourceLink::setJitter (floatj)\fC [inline]\fP

void MembershipBookkeeping::SyncSourceLink::setLast (\fBIncomingRTPPktLink\fP *lp)\fC [inline]\fP

void MembershipBookkeeping::SyncSourceLink::setLastPacketTransitTime (uint32time)\fC [inline]\fP

void MembershipBookkeeping::SyncSourceLink::setMaxSeqNum (uint16max)\fC [inline]\fP

Set the highest valid sequence number recived.