OutgoingDataQueue(3) | Library Functions Manual | OutgoingDataQueue(3) |
OutgoingDataQueue - A generic outgoing RTP data queue supporting multiple destinations.
#include <oqueue.h>
Inherits OutgoingDataQueueBase, and DestinationListHandler.
Inherited by RTPDataQueue.
struct OutgoingRTPPktLink
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. bool
removeContributor (uint32 csrc)
Remove CSRC from the list of contributors. bool isSending () const
Determine if outgoing packets are waiting to send. 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. 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. void
setPadding (uint8 paddinglen)
Set padding. void setMark (bool mark)
Set marker bit for the packet in which the next data provided will be send.
bool getMark () const
Get whether the mark bit will be set in the next packet. size_t
setPartial (uint32 timestamp, unsigned char *data, size_t offset,
size_t max)
Set partial data for an already queued packet. 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. 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.
microtimeout_t getExpireTimeout () const
uint32 getSendPacketCount () const
Get the total number of packets sent so far. uint32 getSendOctetCount
() const
Get the total number of octets (payload only) sent so far. uint16
getSequenceNumber () const
Get the sequence number of the next outgoing packet. void
setOutQueueCryptoContext (CryptoContext *cc)
Set output queue CryptoContext. void removeOutQueueCryptoContext
(CryptoContext *cc)
Remove output queue CryptoContext. CryptoContext *
getOutQueueCryptoContext (uint32 ssrc)
Get an output queue CryptoContext identified by SSRC.
OutgoingDataQueue ()
virtual ~OutgoingDataQueue ()
void dispatchImmediate (OutgoingRTPPkt *packet)
This is used to write the RTP data packet to one or more destinations.
microtimeout_t getSchedulingTimeout ()
This computes the timeout period for scheduling transmission of the next
packet at the 'head' of the send buffer. size_t dispatchDataPacket ()
This function is used by the service thread to process the next outgoing
packet pending in the sending queue. 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). uint32 getCurrentSeqNum (void)
void setInitialTimestamp (uint32 ts)
uint32 getInitialTimestamp ()
void purgeOutgoingQueue ()
virtual void setControlPeer (const InetAddress &host, tpport_t
port)
Mutex cryptoMutex
std::list< CryptoContext * > cryptoContexts
A generic outgoing RTP data queue supporting multiple destinations.
Author:
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.
This function is used by the service thread to process the next outgoing packet pending in the sending queue.
Returns:
This is used to write the RTP data packet to one or more destinations. It is used by both sendImmediate and by dispatchDataPacket.
Parameters:
Get whether the mark bit will be set in the next packet.
Get an output queue CryptoContext identified by SSRC.
Parameters:
Returns:
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:
Get the total number of octets (payload only) sent so far.
Returns:
Get the total number of packets sent so far.
Returns:
Get the sequence number of the next outgoing packet.
Returns:
Determine if outgoing packets are waiting to send.
Returns:
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 appearance that a next packet is waiting to be sent and to provide a valid timestamp for that packet.
Parameters:
Examples:
rtpduphello.cpp.
Remove CSRC from the list of contributors.
Remove output queue CryptoContext. The endQueue method (provided by RTPQueue) also deletes all registered CryptoContexts.
Parameters:
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 appearance that a next packet is waiting to be sent and to provide a valid timestamp for that packet.
Parameters:
Reimplemented in RTPDuplex.
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:
Examples:
rtpduphello.cpp.
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:
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:
Set output queue CryptoContext. The endQueue method (provided by RTPQueue) deletes all registered CryptoContexts.
Parameters:
Set padding. All outgoing packets will be transparently padded to a multiple of paddinglen.
Parameters:
Set partial data for an already queued packet. This is often used for multichannel data.
Parameters:
Returns:
Set the default scheduling timeout to use when no data packets are waiting to be sent.
Parameters:
Examples:
rtpduphello.cpp.
Generated automatically by Doxygen for ccRTP from the source code.
Sat Oct 27 2018 | ccRTP |