RTPDataQueue(3)

📦
version 2.0.9 · 4 versions
, in debian trixie, ubuntu noble, ubuntu questing

💖 RTPDataQueue(3) 💖

okay bestie, welcome to the manual page for RTPDataQueue from the Library Functions Manual. This is the packet queue handler for building different kinds of RTP protocol systems, and it's giving serious networking main character energy, fr fr. ✨

✨ NAME ✨

RTPDataQueue — a packet queue handler for building different kinds of RTP protocol systems.

✨ SYNOPSIS ✨

#include <ioqueue.h>

Inherits IncomingDataQueue, and OutgoingDataQueue.

Inherited by QueueRTCPManager, and RTPDuplex.

🎀 Public Types 🎀

  • enum Tos { tosBestEffort, tosEnhanced } — the type-of-service enum, from rtp.h cc++/rtp.h. 💅

🌸 Public Member Functions 🌸

  • void setTypeOfService (Tos tos) — tell the stack what kind of service your app expects to use. ✨
  • void enableStack () — turn on packet queue processing in the stack. 🔥
  • void disableStack () — turn off packet queue processing in the stack. 🙈
  • bool isActive () const — get the active connection state flag. 👑
  • uint32 getCurrentTimestamp () const — get the timestamp that should be given for a packet whose payload sampling instant corresponds to the current system time. ⏰
  • void setSessionBandwidth (uint32 bw) — specify the bandwidth of the current session. 🌈
  • uint32 getDefaultSessionBandwidth () const — signature only, no description in the original. 🎀
  • uint32 getSessionBandwidth () const — signature only, no description in the original. 🎀
  • void setTimeclock () — set the packet timeclock for synchronizing timestamps. 🕰️
  • timeout_t getTimeclock () const — get the packet timeclock for synchronizing timestamps. 🕰️

💫 Public Member Functions inherited from IncomingDataQueue 💫

  • SyncSourcesIterator begin () — signature only, no description in the original. 🦋
  • SyncSourcesIterator end () — signature only, no description in the original. 🦋
  • const AppDataUnit * getData (uint32 stamp, const SyncSource *src=NULL) — grab data from a specific timestamped packet if such a packet is currently available in the receive buffer. 📦
  • bool isWaiting (const SyncSource *src=NULL) const — figure out if packets are waiting in the reception queue. 👀
  • uint32 getFirstTimestamp (const SyncSource *src=NULL) const — get the timestamp of the 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 — signature only, no description in the original. 🎀
  • uint8 getMinValidPacketSequence () const — get the minimum number of consecutive packets that must be received from a source before accepting its data packets. ✅
  • void setMaxPacketMisorder (uint16 packets) — signature only, no description in the original. 🎀
  • uint16 getDefaultMaxPacketMisorder () const — signature only, no description in the original. 🎀
  • uint16 getMaxPacketMisorder () const — signature only, no description in the original. 🎀
  • void setMaxPacketDropout (uint16 packets) — it also prevents packets sent after a restart of the source being immediately accepted. 🔁
  • uint16 getDefaultMaxPacketDropout () const — signature only, no description in the original. 🎀
  • uint16 getMaxPacketDropout () const — signature only, no description in the original. 🎀
  • 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. 🔎

🌟 Public Member Functions inherited from IncomingDataQueueBase 🌟

  • size_t getDefaultMaxRecvPacketSize () const — signature only, no description in the original. 🎀
  • size_t getMaxRecvPacketSize () const — signature only, no description in the original. 🎀
  • void setMaxRecvPacketSize (size_t maxsize) — signature only, no description in the original. 🎀

🌈 Public Member Functions inherited from RTPQueueBase 🌈

  • bool setPayloadFormat (const PayloadFormat &pf) — set the payload format in use, for timing and payload type identification purposes. 🎯
  • uint32 getLocalSSRC () const — signature only, no description in the original. 🎀
  • 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). ⏱️
  • PayloadType getCurrentPayloadType () const — signature only, no description in the original. 🎀
  • timeval getInitialTime () const — signature only, no description in the original. 🎀

🦋 Public Member Functions inherited from OutgoingDataQueue 🦋

  • bool addDestination (const InetHostAddress &ia, tpport_t dataPort=DefaultRTPDataPort, tpport_t controlPort=0) — signature only, no description in the original. 🎀
  • bool addDestination (const InetMcastAddress &ia, tpport_t dataPort=DefaultRTPDataPort, tpport_t controlPort=0) — signature only, no description in the original. 🎀
  • bool forgetDestination (const InetHostAddress &ia, tpport_t dataPort=DefaultRTPDataPort, tpport_t controlPort=0) — signature only, no description in the original. 🎀
  • bool forgetDestination (const InetMcastAddress &ia, tpport_t dataPort=DefaultRTPDataPort, tpport_t controlPort=0) — signature only, no description in the original. 🎀
  • 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) — used to create a data packet in the send queue. 📦
  • void sendImmediate (uint32 stamp, const unsigned char *data=NULL, size_t len=0) — used to create a data packet and send it immediately. 🚀
  • void setPadding (uint8 paddinglen) — set padding. 🧸
  • void setMark (bool mark) — set the marker bit for the packet in which the next data provided will be sent. 🔖
  • 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 — signature only, no description in the original. 🎀
  • 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 — signature only, no description in the original. 🎀
  • 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 — signature only, no description in the original. 🎀
  • 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. 🔎

🎀 Public Member Functions inherited from OutgoingDataQueueBase 🎀

  • size_t getDefaultMaxSendSegmentSize () — signature only, no description in the original. 🎀
  • void setMaxSendSegmentSize (size_t size) — set maximum payload segment size before fragmenting sends. 🧵
  • size_t getMaxSendSegmentSize () — signature only, no description in the original. 🎀

🔥 Protected Member Functions 🔥

  • RTPDataQueue (uint32 size=defaultMembersHashSize) — constructor. 🏗️
  • RTPDataQueue (uint32 *ssrc, uint32 size=defaultMembersHashSize) — using this constructor you can start a session with the given ssrc, instead of the usual randomly generated one. 🎲
  • virtual ~RTPDataQueue () — the queue destructor flushes the queue and stops all services. 💥
  • virtual void timerTick () — a plugin point for timer tick driven events. ⏲️
  • void renewLocalSSRC () — signature only, no description in the original. 🎀
  • void endQueue () — this method ends the queue. 🛑
  • 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. 📡

💜 Protected Member Functions inherited from IncomingDataQueue 💜

  • IncomingDataQueue (uint32 size) — signature only, no description in the original. 🎀
  • virtual ~IncomingDataQueue () — signature only, no description in the original. 🎀
  • 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. 📥
  • 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 () — signature only, no description in the original. 🎀
  • 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 &) — signature only, no description in the original. 🎀
  • 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 — signature only, no description in the original. 🎀

🫶 Protected Member Functions inherited from IncomingDataQueueBase 🫶

  • IncomingDataQueueBase () — signature only, no description in the original. 🎀
  • virtual ~IncomingDataQueueBase () — signature only, no description in the original. 🎀

🌟 Protected Member Functions inherited from RTPQueueBase 🌟

  • RTPQueueBase (uint32 *ssrc=NULL) — signature only, no description in the original. 🎀
  • void setLocalSSRC (uint32 ssrc) — signature only, no description in the original. 🎀
  • uint32 getLocalSSRCNetwork () const — signature only, no description in the original. 🎀
  • virtual ~RTPQueueBase () — signature only, no description in the original. 🎀
  • virtual size_t dispatchBYE (const std::string &) — a plugin point for posting of BYE messages. 👋

🫶 Protected Member Functions inherited from MembershipBookkeeping 🫶

bestie these are the lil helper functions your class just inherits, no extra work required, we love a hand-me-down 💅

  • MembershipBookkeeping(uint32 initialSize=defaultMembersHashSize) — the initial size is basically a hint ✨ it tells the object how much room to set aside so it can keep track of everybody's identifiers and the info attached to them.
  • virtual ~MembershipBookkeeping() — the destructor goes full Marie Kondo and purges all the RTPSource structures made during the session, plus the hash table and the list of sources. everything gone. clean slate. 🧹
  • SyncSourceLink * getLink(const SyncSource &source) const — no description on this one, it's just there doing its thing 🦋
  • bool isMine(const SyncSource &source) const — tells you whether a synchronization source is actually recorded in this membership controller. is it ours? 👀
  • bool isRegistered(uint32 ssrc) — returns whether there's already a synchronization source chilling there with that 'ssrc' SSRC identifier.
  • SyncSourceLink * getSourceBySSRC(uint32 ssrc, bool &created) — grab the description of a source by its ssrc identifier.
  • bool BYESource(uint32 ssrc) — marks the source identified by ssrc as having sent a BYE packet. bye bestie 👋
  • bool removeSource(uint32 ssrc) — removes the description of the source identified by ssrc.
  • SyncSourceLink * getFirst() — no description, just vibes ✨
  • SyncSourceLink * getLast() — same energy, no description 🌸
  • uint32 getMembersCount() — also undescribed, we move 💜
  • void setMembersCount(uint32 n) — yeah, no description here either 🙈
  • uint32 getSendersCount() — and none here 🎀
  • size_t getDefaultMembersHashSize() — nope, nothing, it's iconic in silence 👑

💖 Protected Member Functions inherited from SyncSourceHandler 💖

  • SyncSourceHandler() — the constructor, living its best life 🦋
  • virtual ~SyncSourceHandler() — the destructor, also just existing ✨
  • void * getLink(const SyncSource &source) const — heads up, this one requires SyncSource - SyncSourceHandler friendship 🤝 like, they have to be besties for this to work.
  • void setLink(SyncSource &source, void *link) — no description 🍓
  • void setParticipant(SyncSource &source, Participant &p) — no description 🍓
  • void setState(SyncSource &source, SyncSource::State ns) — no description 🍓
  • void setSender(SyncSource &source, bool active) — no description 🍓
  • void setDataTransportPort(SyncSource &source, tpport_t p) — no description 🍓
  • void setControlTransportPort(SyncSource &source, tpport_t p) — no description 🍓
  • void setNetworkAddress(SyncSource &source, InetAddress addr) — no description 🍓

🌸 Protected Member Functions inherited from ParticipantHandler 🌸

  • ParticipantHandler() — constructor, slaying quietly 💅
  • virtual ~ParticipantHandler() — destructor, also quiet 💅
  • void setSDESItem(Participant *part, SDESItemType item, const std::string &val) — no description, it just is 🧚
  • void setPRIVPrefix(Participant *part, const std::string val) — no description either 🧚

✨ Protected Member Functions inherited from ApplicationHandler ✨

  • ApplicationHandler() — constructor, being adorable 🌈
  • virtual ~ApplicationHandler() — destructor, also adorable 🌈
  • void addParticipant(RTPApplication &app, Participant &part) — no description 🎀
  • void removeParticipant(RTPApplication &app, RTPApplication::ParticipantLink *pl) — no description 🎀

🔥 Protected Member Functions inherited from ConflictHandler 🔥

  • ConflictHandler() — constructor, staying out of drama 💀
  • virtual ~ConflictHandler() — destructor, also staying out of drama 💀
  • ConflictingTransportAddress * searchDataConflict(InetAddress na, tpport_t dtp) — no description 🫶
  • ConflictingTransportAddress * searchControlConflict(InetAddress na, tpport_t ctp) — no description 🫶
  • void updateConflict(ConflictingTransportAddress &ca) — no description 🫶
  • void addConflict(const InetAddress &na, tpport_t dtp, tpport_t ctp) — no description 🫶

👑 Protected Member Functions inherited from OutgoingDataQueue 👑

  • OutgoingDataQueue() — constructor, main character energy ✨
  • virtual ~OutgoingDataQueue() — destructor, also main character energy ✨
  • void dispatchImmediate(OutgoingRTPPkt *packet) — this is the one that actually writes the RTP data packet out to one or more destinations 📬
  • microtimeout_t getSchedulingTimeout() — this computes the timeout period for scheduling the transmission of the next packet sitting at the 'head' of the send buffer ⏰
  • size_t dispatchDataPacket() — this function is used by the service thread to process the next outgoing packet that's pending in the sending queue.
  • void setNextSeqNum(uint32 seqNum) — for those cases where your app needs a way to set the sequence number for the outgoing stream, like when you're implementing the RTSP PLAY command 🎬
  • uint32 getCurrentSeqNum(void) — no description 🍓
  • void setInitialTimestamp(uint32 ts) — no description 🍓
  • uint32 getInitialTimestamp() — no description 🍓
  • void purgeOutgoingQueue() — no description 🍓
  • virtual void setControlPeer(const InetAddress &host, tpport_t port) — no description 🍓

🦋 Protected Member Functions inherited from OutgoingDataQueueBase 🦋

  • OutgoingDataQueueBase() — constructor, no notes 🌟
  • virtual ~OutgoingDataQueueBase() — destructor, no notes 🌟

💜 Protected Member Functions inherited from DestinationListHandler 💜

  • void writeLockDestinationList() const — no description 🌸
  • bool addDestinationToList(const InetAddress &ia, tpport_t data, tpport_t control) — locks the object before modifying it 🔒
  • bool removeDestinationFromList(const InetAddress &ia, tpport_t dataPort, tpport_t controlPort) — locks the object before modifying it 🔒
  • DestinationListHandler() — no description 🌸
  • ~DestinationListHandler() — no description 🌸
  • bool isSingleDestination() const — tells you whether there's only one destination in the list.
  • TransportAddress * getFirstDestination() const — no description 🌸
  • void lockDestinationList() const — no description 🌸
  • void unlockDestinationList() const — no description 🌸

🌈 Additional Inherited Members 🌈

⭐ Static Public Member Functions inherited from IncomingDataQueue ⭐

  • static size_t getDefaultMembersSize() — no description, it just exists 🎀

🧚 Protected Attributes inherited from IncomingDataQueue 🧚

  • ThreadLock recvLock
  • IncomingRTPPktLink * recvFirst
  • IncomingRTPPktLink * recvLast
  • uint8 minValidPacketSequence
  • uint16 maxPacketMisorder
  • uint16 maxPacketDropout
  • uint8 sourceExpirationPeriod
  • Mutex cryptoMutex
  • std::list< CryptoContext * > cryptoContexts

💀 Protected Attributes inherited from ConflictHandler 💀

  • ConflictingTransportAddress * firstConflict
  • ConflictingTransportAddress * lastConflict

🔥 Protected Attributes inherited from OutgoingDataQueue 🔥

  • Mutex cryptoMutex
  • std::list< CryptoContext * > cryptoContexts

🍓 Protected Attributes inherited from DestinationListHandler 🍓

  • std::list< TransportAddress * > destList

👑 Static Protected Attributes inherited from IncomingDataQueue 👑

  • static const uint8 defaultMinValidPacketSequence
  • static const uint16 defaultMaxPacketMisorder
  • static const uint16 defaultMaxPacketDropout
  • static const size_t defaultMembersSize

✨ Static Protected Attributes inherited from MembershipBookkeeping ✨

  • static const size_t defaultMembersHashSize
  • static const uint32 SEQNUMMOD

📦 Detailed Description 📦

a packet queue handler for building all different kinds of RTP protocol systems, no cap 💅

the queue handles both the incoming and the outgoing RTP packets, plus the synchronization and the transmission/reception timers. and the way it makes the queue handler its own separate base class? that's what lets you define RTP classes for RTP profiles and sessions of totally different types. obsessed honestly ✨

outgoing packets get sent via the OutgoingDataQueue::putData method 📤

incoming packets can be retrieved via the IncomingDataQueue::getData method 📥

Author

David Sugar dyfet@ostel.com

RTP data queue handler.

🎀 Member Enumeration Documentation 🎀

enum RTPDataQueue::Tos

rtp.h cc++/rtp.h — the type of network service the application uses.

so here's the tea: if the application uses enhanced network service — think Integrated Services or Differentiated Services — it does not have to ensure fair competition with TCP, as long as the requested service is actually being delivered. but whenever the application uses best-effort service, or the enhanced service it asked for isn't actually being delivered, then it does have to ensure fair competition with TCP. and by default? best-effort is what's assumed. periodt.

Note — although it's not required, RTP packets are always sent on top of UDP segments. no other underlying transport protocol is supported at present 🫶

Enumerator

  • tosBestEffort — best-effort network service.
  • tosEnhanced — enhanced network service.

💅 Constructor & Destructor Documentation 💅

RTPDataQueue::RTPDataQueue(uint32 size = defaultMembersHashSize) [protected]

the constructor ✨ this one generates a random application SSRC identifier for you, like a lil surprise gift 🎁

Parameters

  • size — an estimation of the number of participants in the session.

RTPDataQueue::RTPDataQueue(uint32 * ssrc, uint32 size = defaultMembersHashSize) [protected]

with this constructor you get to start a session with the ssrc you provide, instead of the usual randomly generated one. this is necessary when you need to kick off several sessions that all have the same SSRC identifier — for instance, to implement layered encoding, where each layer is managed through a different session but all the sessions share the same SSRC identifier. team effort fr fr 🤝

Warning — this doesn't seem to be a good solution 💀

Parameters

  • ssrc — synchronization SouRCe identifier for this session.
  • size — an estimation of the number of participants in the session.

virtual RTPDataQueue::~RTPDataQueue() [inline], [protected], [virtual]

the queue destructor flushes the queue and stops all services. everything wraps up, curtains closed, iconic exit 🎬✨

✨ Member Function Documentation ✨

void RTPDataQueue::disableStack (void) [inline]

void RTPDataQueue::disableStack (void) [inline]

Okay so bestie, this one just turns OFF packet queue processing in the stack. That's the entire job. It's giving "lights off, nobody's home" energy. 🛑

void RTPDataQueue::enableStack (void) [inline]

void RTPDataQueue::enableStack (void) [inline]

And this icon turns packet queue processing in the stack back ON. ✨

Heads up: this method will not any thread of execution. That's literally what the docs say, word for word — I am not editing the ancestors. Make of it what you will, bestie. 🫶

void RTPDataQueue::endQueue () [protected]

void RTPDataQueue::endQueue () [protected]

This method ends the queue. That's it. Queue over, pack it up, go home. 💅 (It's protected, so it's living its life behind the velvet rope.)

uint32 RTPDataQueue::getCurrentTimestamp () const

uint32 RTPDataQueue::getCurrentTimestamp () const

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. So like... it's not the clock, but it does need to be clock-adjacent. The way that nuance lives in this function. 😭

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. Please don't do math by hand, bestie, we have functions for that. 🧮

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 random 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. 💀 (the devs literally said "it's ugly" in the docs, no cap — they're so real for that)

Examples

  • rtphello.cpp

uint32 RTPDataQueue::getDefaultSessionBandwidth () const [inline]

uint32 RTPDataQueue::getDefaultSessionBandwidth () const [inline]

The docs give us literally zero description here. Just the signature, standing there, mysterious, serving main character energy with no lines. 🙈

uint32 RTPDataQueue::getSessionBandwidth () const [inline]

uint32 RTPDataQueue::getSessionBandwidth () const [inline]

Same situation, bestie — signature only, no prose. The silence is deafening. 🔇

timeout_t RTPDataQueue::getTimeclock () const [inline]

timeout_t RTPDataQueue::getTimeclock () const [inline]

Get the packet timeclock for synchronizing timestamps. ⏱️

Returns

  • runtime in milliseconds since last set.

bool RTPDataQueue::isActive () const [inline]

bool RTPDataQueue::isActive () const [inline]

Get active connection state flag. Vibe check, but for connections. 🦋

Returns

  • true if connection 'active'.

Examples

  • audiorx.cpp
  • audiotx.cpp
  • rtphello.cpp

virtual bool RTPDataQueue::isPendingData (microtimeout_t timeout) [protected], [pure virtual]

virtual bool RTPDataQueue::isPendingData (microtimeout_t timeout) [protected], [pure virtual]

This function is used to check for and schedule against arriving packets based on the derived connection type. 👀 It's pure virtual, so the derived connection type is the one who actually has to show up and do the work. Periodt.

Returns

  • true if packet waiting for processing.

Parameters

  • number of microseconds to wait.

Implemented in

  • RTPDuplex
  • TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue >
  • TRTPSessionBase< DualRTPUDPIPv4Channel, DualRTPUDPIPv4Channel, AVPQueue >
  • SingleThreadRTPSession< RTPDataChannel, RTCPChannel, ServiceQueue >

void RTPDataQueue::renewLocalSSRC () [inline], [protected], [virtual]

void RTPDataQueue::renewLocalSSRC () [inline], [protected], [virtual]

Reimplemented from IncomingDataQueue. No extra notes, no side quests — just a glow-up of the SSRC with the receipts to prove where it came from. 💅

void RTPDataQueue::setSessionBandwidth (uint32 bw) [inline]

void RTPDataQueue::setSessionBandwidth (uint32 bw) [inline]

Specify the bandwidth of the current session. 📶

Parameters

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

See also

  • AVPQueue::setControlBandwidth()

void RTPDataQueue::setTimeclock () [inline]

void RTPDataQueue::setTimeclock () [inline]

Set the packet timeclock for synchronizing timestamps. That's the whole note, bestie. Short, sweet, and it matches getTimeclock() like a matching set. 🎀

void RTPDataQueue::setTypeOfService (Tos tos) [inline]

void RTPDataQueue::setTypeOfService (Tos tos) [inline]

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. So like, if you ask for the fancy treatment and the network is not delivering, ccRTP stops pretending and plays nice with TCP instead. Not me being humbled by the network layer. 😭

virtual void RTPDataQueue::timerTick (void) [inline], [protected], [virtual]

virtual void RTPDataQueue::timerTick (void) [inline], [protected], [virtual]

A plugin point for timer tick driven events. 🎯 Like a little hook where timer tick stuff can do its thing.

Reimplemented in

  • SingleThreadRTPSession< RTPDataChannel, RTCPChannel, ServiceQueue >

Author ✍️

Generated automatically by Doxygen for ccRTP from the source code. So nobody hand-wrote this one, it just ✨manifested✨.

And that's the whole page, bestie — that footer at the bottom is your source and version tag, ccRTP, living on manual page RTPDataQueue(3), dated like a little timestamp on the whole thing. 💖 Go build something cute with it. 🦋🌸

📦 where this page comes from