QueueRTCPManager(3)

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

💖 QueueRTCPManager(3) 💖

okay bestie, so this is a page from the Library Functions Manual, and it's literally all about QueueRTCPManager — the girl who handles RTCP stuff for an RTP data queue. she's giving very much "I manage the control plane so you don't have to" energy. 🎀

✨ NAME ✨

QueueRTCPManager — Adds generic management of RTCP functions to an RTP data queue.

like. she adds generic management of RTCP functions. to an RTP data queue. that's the whole vibe. no cap. 🦋

✨ SYNOPSIS ✨

#include <cqueue.h>

okay so first things first, she Inherits RTPDataQueue and RTCPCompoundHandler. 💅

and she's Inherited by AVPQueue. (yes bestie, she's a mother. the lineage is real. 👑)

🌸 Public Member Functions 🌸

💜 her own iconic methods

  • RTCPSenderInfo * getMRSenderInfo (SyncSource &src) — grab the most recent sender report that came in from a synchronization source. "MR" = most recent, iykyk. ✨
  • RTCPReceiverInfo * getMRReceiverInfo (SyncSource &srcFrom) — this one asks for the info inside the most recent receiver report about the local source, and it's the one you received from the source you pass in as the parameter. yes it's specific. yes she's worth it. 💖
  • void setLeavingDelay (microtimeout_t delay) — sets how long the stack will sit there and wait before it deletes a synchronization source that already sent an RTCP BYE packet. like giving them a lil grace period before the block. 🫶
  • void setEnd2EndDelay (microtimeout_t t) — sets the maximum end to end delay allowed. that's it. that's the method. 🔥
  • microtimeout_t getDefaultEnd2EndDelay () const — returns the default. the og. the blueprint. ⭐
  • microtimeout_t getEnd2EndDelay () const — returns the one you actually set. 💫
  • void setSendersControlFraction (float fraction) — you're specifying what fraction of the total control bandwidth gets dedicated to senders reports. math girlies rise. 📐💅
  • void setMinRTCPInterval (microtimeout_t interval) — manually set the minimum interval for sending RTP compound packets. manual mode: engaged. 🎀
  • uint32 getSendRTCPPacketCount () const — get the total number of RTCP packets sent until now. a running tally. a little scoreboard. 🌈
  • void setOutQueueCryptoContextCtrl (CryptoContextCtrl *cc) — set output queue CryptoContext. secure the bag (the control one). 🔐
  • void removeOutQueueCryptoContextCtrl (CryptoContextCtrl *cc) — remove output queue CryptoContext. okay bye bestie 👋
  • CryptoContextCtrl * getOutQueueCryptoContextCtrl (uint32 ssrc) — get an output queue CryptoContext, identified by SSRC. she knows exactly which one you mean. 👑
  • void setInQueueCryptoContextCtrl (CryptoContextCtrl *cc) — set input queue CryptoContext. 💖
  • void removeInQueueCryptoContextCtrl (CryptoContextCtrl *cc) — remove input queue CryptoContext. 🙈
  • CryptoContextCtrl * getInQueueCryptoContextCtrl (uint32 ssrc) — get an input queue CryptoContext identified by SSRC. matching set, obviously. 🦋

🌟 Public Member Functions inherited from RTPDataQueue 🌟

she didn't have to flex these but she did:

  • void setTypeOfService (Tos tos) — specify the kind of service the application expects to use. manifesting that QoS. ✨
  • void enableStack () — enable packet queue processing in the stack. wake her up 💅
  • void disableStack () — disable packet queue processing in the stack. nap time 😴
  • bool isActive () const — get the active connection state flag. are we live? 🎤
  • uint32 getCurrentTimestamp () const — get the timestamp that should be given for a packet whose payload sampling instant corresponds to the current system time. yes, all of that. it's precise. she's precise. ⏰
  • void setSessionBandwidth (uint32 bw) — specify the bandwidth of the current session. 📶
  • uint32 getDefaultSessionBandwidth () const — the default bandwidth. the factory setting. the og. ⭐
  • uint32 getSessionBandwidth () const — the bandwidth you actually set. 💫
  • void setTimeclock () — set the packet timeclock for synchronizing timestamps. 🕰️
  • timeout_t getTimeclock () const — get the packet timeclock for synchronizing timestamps. right back at ya. 🕰️✨

💕 Public Member Functions inherited from IncomingDataQueue 💕

  • SyncSourcesIterator begin () — the beginning. as in iterator. 🎬
  • SyncSourcesIterator end () — the end. also iterator. 🎞️
  • 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. (yes the original spells it "Retreive", and yes we're keeping it exactly as-is bestie, character for character. 💀)
  • bool isWaiting (const SyncSource *src=NULL) const — determine if packets are waiting in the reception queue. the queue said "soon." 🙈
  • uint32 getFirstTimestamp (const SyncSource *src=NULL) const — get timestamp of first packet waiting in the queue. first in line, main character energy. 👑
  • void setMinValidPacketSequence (uint8 packets) — when you're receiving packets from a new source, it may be convenient to reject a first few packets before you're really sure the source is valid. trust issues but make it protocol design. 🚩
  • uint8 getDefaultMinValidPacketSequence () const — the default value of the above. ⭐
  • uint8 getMinValidPacketSequence () const — get the minimun number of consecutive packets that must be received from a source before accepting its data packets. (again — original spelling "minimun", preserved with love. 💖)
  • void setMaxPacketMisorder (uint16 packets) — sets the max packet misorder. that's the whole description she gave us, and we're not inventing more. 🤷♀️
  • uint16 getDefaultMaxPacketMisorder () const — the default max packet misorder. ⭐
  • uint16 getMaxPacketMisorder () const — the max packet misorder you set. 💫
  • void setMaxPacketDropout (uint16 packets) — it also prevents packets sent after a restart of the source being immediately accepted. sneaky lil side effect, we love a multitasker. 🔥
  • uint16 getDefaultMaxPacketDropout () const — default dropout value. ⭐
  • uint16 getMaxPacketDropout () const — the dropout value in play. 💫
  • 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 — the default max receive packet size. ⭐
  • size_t getMaxRecvPacketSize () const — the max receive packet size currently set. 💫
  • void setMaxRecvPacketSize (size_t maxsize) — set it. now it's your maxsize. 💅

🧚 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 — get the local SSRC. that's your id bestie, don't lose it. 🪪
  • 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). look at the numbers, we love specificity. 🔢
  • PayloadType getCurrentPayloadType () const — get the current payload type. 🏷️
  • timeval getInitialTime () const — get the initial time. ⏳

🌈 Public Member Functions inherited from OutgoingDataQueue 🌈

  • bool addDestination (const InetHostAddress &ia, tpport_t dataPort=DefaultRTPDataPort, tpport_t controlPort=0) — add a destination by host address. 🌍
  • bool addDestination (const InetMcastAddress &ia, tpport_t dataPort=DefaultRTPDataPort, tpport_t controlPort=0) — same thing but multicast flavoured. 📡
  • bool forgetDestination (const InetHostAddress &ia, tpport_t dataPort=DefaultRTPDataPort, tpport_t controlPort=0) — forget a host destination. 🫥
  • bool forgetDestination (const InetMcastAddress &ia, tpport_t dataPort=DefaultRTPDataPort, tpport_t controlPort=0) — forget a multicast destination. 🫥📡
  • void addContributor (uint32 csrc) — add csrc as the CSRC identifier of a new contributor. welcome to the group chat. 🫂
  • bool removeContributor (uint32 csrc) — remove CSRC from the list of contributors. removed from the group chat. 💀
  • 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. no waiting, no queue, straight to the function. 🔥
  • 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. (yes, "be send". she said what she said. 💅)
  • 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. piece by piece, like a puzzle. 🧩
  • microtimeout_t getDefaultSchedulingTimeout () const — the default scheduling timeout. ⭐
  • 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 — the default expire timeout. ⭐
  • 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. rip to those packets fr. 😭
  • microtimeout_t getExpireTimeout () const — get the expire timeout. 💫
  • 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. payload only, don't count the whole thing, she's specific. 🔢
  • uint16 getSequenceNumber () const — get the sequence number of the next outgoing packet. future-facing. 🔮
  • 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 () — the default max send segment size. ⭐
  • void setMaxSendSegmentSize (size_t size) — set maximum payload segment size before fragmenting sends. she'll fragment. don't test her. 🧨
  • size_t getMaxSendSegmentSize () — get the max send segment size. 💫

🔐 Protected Member Functions 🔐

(these are the backstage ones, for the class and her friends only. 💅)

  • QueueRTCPManager (uint32 size=RTPDataQueue::defaultMembersHashSize, RTPApplication &app=defaultApplication()) — constructor number one. 🎀
  • QueueRTCPManager (uint32 ssrc, uint32 size=RTPDataQueue::defaultMembersHashSize, RTPApplication &app=defaultApplication()) — constructor number two, this time you get to bring your own ssrc. ✨
  • virtual ~QueueRTCPManager () — the destructor. virtual. dramatic exit. 💀
  • const RTPApplication & getApplication () — get the application. 📱
  • void setControlBandwidth (float fraction) — set the control bandwidth as a fraction. 📶
  • float getControlBandwidth () const — get that control bandwidth back out. 💫
  • void controlTransmissionService () — build and send RTCP packets following timing rules (including the 'timer reconsideration' algorithm). the algorithm has a whole name, she's famous. ⏰👑
  • void controlReceptionService () — process incoming RTCP packets pending in the control reception socket. 📥
  • bool checkSSRCInRTCPPkt (SyncSourceLink &sourceLink, bool is_new, InetAddress &na, tpport_t tp) — appy collision and loop detection and correction algorithm when receiving RTCP packets. (yes, "Appy". we're preserving the typo exactly, bestie, it's part of the lore. 💀)
  • void endQueueRTCPManager () — ends the QueueRTCPManager. that's all she wrote. 🎬
  • virtual void onGotSR (SyncSource &source, SendReport &SR, uint8 blocks) — plug-in for processing (acquire information carried in) an incoming RTCP Sender Report. 🔌
  • virtual void onGotRR (SyncSource &source, RecvReport &RR, uint8 blocks) — plug-in for processing (acquire information carried in) an incoming RTCP Receiver Report. 🔌
  • bool onGotSDES (SyncSource &source, RTCPPacket &pkt) — the SDES handler. that's the description, short and sweet. 🍬
  • virtual bool onGotSDESChunk (SyncSource &source, SDESChunk &chunk, size_t len) — plug-in for handling of SDES chunks. 🧩
  • virtual void onGotAPP (SyncSource &, RTCPCompoundHandler::APPPacket &, size_t) — plug-in for handling of APP (application specific) RTCP packets. 📦
  • timeval getRTCPCheckInterval () — get the RTCP check interval. ⏲️
  • uint32 getLastSendPacketCount () const — get the number of data packets sent at the time the last SR was generated. 📊
  • void setPrevMembersNum (uint32 n) — set the previous members number to n. 🔢
  • uint32 getPrevMembersCount () const — get the previous members count. 🔢
  • size_t dispatchBYE (const std::string &reason) — this method is used to send an RTCP BYE packet. and she'll tell you why with reason. 👋
  • size_t sendControlToDestinations (unsigned char *buffer, size_t len) — send control stuff to the destinations. the destinations get the control. 🚚

💜 Protected Member Functions inherited from RTPDataQueue 💜

  • 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. custom ssrc, custom life. ✨
  • virtual ~RTPDataQueue () — the queue destructor flushes the queue and stops all services. full shutdown, no survivors. 💀
  • virtual void timerTick () — a plugin point for timer tick driven events. ⏱️
  • void renewLocalSSRC () — renew that local SSRC. glow up era. ✨
  • 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. note the =0 bestie, she's pure virtual, so the derived class has to implement her. no skipping. 🚨

🫶 Protected Member Functions inherited from IncomingDataQueue

okay bestie, these are all the inherited protected goodies — hand-me-downs but make them iconic:

  • IncomingDataQueue(uint32 size)
  • virtual ~IncomingDataQueue()
  • bool checkSSRCInIncomingRTPPkt(SyncSourceLink &sourceLink, bool is_new, InetAddress &na, tpport_t tp) — runs the collision + loop detection and correction algorithm when RTP data packets come rolling in.
  • void setSourceExpirationPeriod(uint8 intervals) — sets how many RTCP intervals the stack waits before flipping a source from stateActive to stateInactive, or before deleting the source once it's been sitting in stateInactive.
  • virtual size_t takeInDataPacket() — the service thread calls this to grab the next incoming packet and drop it in the receive list.
  • IncomingDataQueue::IncomingRTPPktLink * getWaiting(uint32 timestamp, const SyncSource *src=NULL) — fetches a packet out of the receive queue and expires anything older than the current timestamp.
  • bool recordReception(SyncSourceLink &srcLink, const IncomingRTPPkt &pkt, const timeval recvtime) — logs that a new RTP packet just arrived from this source.
  • void recordExtraction(const IncomingRTPPkt &pkt) — logs that a packet got pulled out of this source's scheduled reception queue.
  • void purgeIncomingQueue()
  • virtual void onNewSyncSource(const SyncSource &) — a virtual that fires when a new synchronization source joins the session.
  • virtual bool onRTPPacketRecv(IncomingRTPPkt &) — virtual hook to parse arriving packets, decide whether they deserve to stay in the queue, and dispatch events.
  • virtual void onExpireRecv(IncomingRTPPkt &) — hook to filter packets in the receive queue that are currently being expired.
  • virtual bool onSRTPPacketError(IncomingRTPPkt &pkt, int32 errorCode) — hook that gets called if decoding an incoming SRTP packet went wrong.
  • bool insertRecvPacket(IncomingRTPPktLink *packetLink) — inserts a just-received packet into the queue (both the general queue and the source-specific one).
  • virtual size_t recvData(unsigned char *buffer, size_t length, InetHostAddress &host, tpport_t &port)=0 — does the actual physical I/O for reading a packet from the source.
  • virtual size_t getNextDataPacketSize() const =0

✨ Protected Member Functions inherited from IncomingDataQueueBase

  • IncomingDataQueueBase()
  • virtual ~IncomingDataQueueBase()

🌸 Protected Member Functions inherited from RTPQueueBase

  • RTPQueueBase(uint32 *ssrc=NULL)
  • void setLocalSSRC(uint32 ssrc)
  • uint32 getLocalSSRCNetwork() const
  • virtual ~RTPQueueBase()

💜 Protected Member Functions inherited from MembershipBookkeeping

  • MembershipBookkeeping(uint32 initialSize=defaultMembersHashSize) — that initial size is just a hint, so the class can allocate the resources it needs to keep members' identifiers and their associated info.
  • virtual ~MembershipBookkeeping() — purges every RTPSource struct created during the session, plus the hash table and the list of sources.
  • SyncSourceLink * getLink(const SyncSource &source) const
  • bool isMine(const SyncSource &source) const — tells you whether a synchronization source is recorded in this membership controller.
  • bool isRegistered(uint32 ssrc) — returns whether a synchronization source with the SSRC identifier ssrc already exists.
  • SyncSourceLink * getSourceBySSRC(uint32 ssrc, bool &created) — get the description of a source by its ssrc identifier.
  • bool BYESource(uint32 ssrc) — mark the source identified by ssrc as having sent a BYE packet.
  • bool removeSource(uint32 ssrc) — remove the description of the source identified by ssrc.
  • SyncSourceLink * getFirst()
  • SyncSourceLink * getLast()
  • uint32 getMembersCount()
  • void setMembersCount(uint32 n)
  • uint32 getSendersCount()
  • size_t getDefaultMembersHashSize()

🦋 Protected Member Functions inherited from SyncSourceHandler

  • SyncSourceHandler()
  • virtual ~SyncSourceHandler()
  • void * getLink(const SyncSource &source) const — heads up, this one needs SyncSource – SyncSourceHandler friendship.
  • void setLink(SyncSource &source, void *link)
  • void setParticipant(SyncSource &source, Participant &p)
  • void setState(SyncSource &source, SyncSource::State ns)
  • void setSender(SyncSource &source, bool active)
  • void setDataTransportPort(SyncSource &source, tpport_t p)
  • void setControlTransportPort(SyncSource &source, tpport_t p)
  • void setNetworkAddress(SyncSource &source, InetAddress addr)

🎀 Protected Member Functions inherited from ParticipantHandler

  • ParticipantHandler()
  • virtual ~ParticipantHandler()
  • void setSDESItem(Participant *part, SDESItemType item, const std::string &val)
  • void setPRIVPrefix(Participant *part, const std::string val)

🍓 Protected Member Functions inherited from ApplicationHandler

  • ApplicationHandler()
  • virtual ~ApplicationHandler()
  • void addParticipant(RTPApplication &app, Participant &part)
  • void removeParticipant(RTPApplication &app, RTPApplication::ParticipantLink *pl)

💅 Protected Member Functions inherited from ConflictHandler

  • ConflictHandler()
  • virtual ~ConflictHandler()
  • ConflictingTransportAddress * searchDataConflict(InetAddress na, tpport_t dtp)
  • ConflictingTransportAddress * searchControlConflict(InetAddress na, tpport_t ctp)
  • void updateConflict(ConflictingTransportAddress &ca)
  • void addConflict(const InetAddress &na, tpport_t dtp, tpport_t ctp)

🔥 Protected Member Functions inherited from OutgoingDataQueue

  • OutgoingDataQueue()
  • virtual ~OutgoingDataQueue()
  • void dispatchImmediate(OutgoingRTPPkt *packet) — used to write the RTP data packet out to one or more destinations.
  • microtimeout_t getSchedulingTimeout() — computes the timeout period for scheduling transmission of the next packet sitting at the 'head' of the send buffer.
  • size_t dispatchDataPacket() — the service thread uses this to process the next outgoing packet pending in the sending queue.
  • void setNextSeqNum(uint32 seqNum) — for those cases where the application needs a way to set the sequence number for the outgoing stream (like 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)

⭐ Protected Member Functions inherited from OutgoingDataQueueBase

  • OutgoingDataQueueBase()
  • virtual ~OutgoingDataQueueBase()

🌈 Protected Member Functions inherited from DestinationListHandler

  • void writeLockDestinationList() const
  • 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()
  • ~DestinationListHandler()
  • bool isSingleDestination() const — tells you whether there's only one destination in the list.
  • TransportAddress * getFirstDestination() const
  • void lockDestinationList() const
  • void unlockDestinationList() const

🧚 Protected Member Functions inherited from RTCPCompoundHandler

  • RTCPCompoundHandler(uint16 mtu=defaultPathMTU)
  • ~RTCPCompoundHandler()
  • bool checkCompoundRTCPHeader(size_t len) — runs the RTCP compound packet header validity check exactly as specified in draft-ietv-avt-rtp-new.
  • void setPathMTU(uint16 mtu)
  • uint16 getPathMTU()

👑 Additional Inherited Members

🌟 Public Types inherited from RTPDataQueue

enum Tos { tosBestEffort, tosEnhanced }

rtp.h cc++/rtp.h

💖 Static Public Member Functions inherited from IncomingDataQueue

  • static size_t getDefaultMembersSize()

🫧 Protected Types inherited from RTCPCompoundHandler

enum { defaultPathMTU = 1500 }

🎯 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

📦 Protected Attributes inherited from RTCPCompoundHandler

  • unsigned char * rtcpSendBuffer
  • unsigned char * rtcpRecvBuffer

🔒 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

Adds generic management of RTCP functions to an RTP data queue.

Extends an RTP data i/o queue by adding management of RTCP functions, and here's the whole glow-up it brings:

  • Give feedback on the quality of the data distribution.
  • Convey the CNAME (the persistent transport-level identifier) for every RTP source.
  • Control the sending rate of RTCP packets
  • Convey minimal control information about the participants

This class implements generic RTCP behaviour (as specified in RFC 1889 / draft-ietf-avt-rtp-new) and may be specialized for specific profiles (peep AVPQueue) or particular RTCP extensions.

✍️ Author

Federico Montesino Pouzols fedemp@altern.org

🛠️ Constructor & Destructor Documentation

QueueRTCPManager::QueueRTCPManager (uint32 size =
    RTPDataQueue::defaultMembersHashSize, RTPApplication & app =
    defaultApplication()) [protected]
QueueRTCPManager::QueueRTCPManager (uint32 ssrc, uint32 size =
    RTPDataQueue::defaultMembersHashSize, RTPApplication & app =
    defaultApplication()) [protected]
virtual QueueRTCPManager::~QueueRTCPManager () [protected],  [virtual]

💅 Member Function Documentation 💅

okay bestie we're in the deep end now, but it's fine, we're built different. every single member function, no skips, no cap. let's GO 🚀

This one runs the collision and loop detection and correction algorithm when RTCP packets come rolling in. It follows section 8.2 in draft-ietf-avp-rtp-new, so like, it's literally the spec's algorithm, respect it.

Parameters:

  • sourceLink — link to the source object.
  • is_new — whether the source has been just recorded.
  • na — RTCP packet network address.
  • tp — RTCP packet source transport port.

Returns: whether the packet must not be discarded. 👑

🌸 void QueueRTCPManager::controlReceptionService () [protected]

Processes the incoming RTCP packets that are just chilling, pending, in the control reception socket. bestie's inbox but for RTCP fr fr.

🌸 void QueueRTCPManager::controlTransmissionService () [protected]

Builds and sends RTCP packets following the timing rules — and yes, that includes the 'timer reconsideration' algorithm, she's iconic for a reason. ✨

🌸 size_t QueueRTCPManager::dispatchBYE (const std::string & reason) [protected], [virtual]

This method is the one that sends an RTCP BYE packet. And an RTCP BYE packet gets sent when one of these two situations happens:

  • when leaving the session
  • when we've detected that another synchronization source in the same session is using the same SSRC identifier as us 😭 (identity theft, in MY session?)

It tries to post a BYE message. It will send a BYE packet as long as at least one RTP or RTCP packet has been sent before. And if the number of members in the session is more than 50, the algorithm described in section 6.3.7 of RFC 3550 is applied so we don't get a whole flood of BYE messages. queen behavior honestly, nobody wants that spam.

Parameters:

  • reason — reason to specify in the BYE packet.

Reimplemented from RTPQueueBase.

Reimplemented in TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue >, TRTPSessionBase< DualRTPUDPIPv4Channel, DualRTPUDPIPv4Channel, AVPQueue >, and SingleThreadRTPSession< RTPDataChannel, RTCPChannel, ServiceQueue >.

🌸 void QueueRTCPManager::endQueueRTCPManager () [protected]

That's it, that's the entry. no description bestie, she just exists. 💀

🌸 const RTPApplication & QueueRTCPManager::getApplication () [inline], [protected]

No description given, she's a mystery and we respect it. 🫶

🌸 float QueueRTCPManager::getControlBandwidth () const [inline], [protected]

Also no description. lowkey just vibes. 🌈

🌸 microtimeout_t QueueRTCPManager::getDefaultEnd2EndDelay () const [inline]

No description, but the name is doing a lot of work already. 💅

🌸 microtimeout_t QueueRTCPManager::getEnd2EndDelay () const [inline]

Same deal, no description. moving on bestie. ✨

🌸 CryptoContextCtrl * QueueRTCPManager::getInQueueCryptoContextCtrl (uint32 ssrc)

Get an input queue CryptoContext identified by SSRC. 🔐

Parameters:

  • ssrc — Request CryptoContext for this incoming SSRC

Returns: Pointer to CryptoContext of the SSRC of NULL if no context available for this SSRC.

🌸 uint32 QueueRTCPManager::getLastSendPacketCount () const [inline], [protected]

Get the number of data packets sent at the time the last SR was generated. receipts, but make them RTCP. 🧾

🌸 RTCPReceiverInfo * QueueRTCPManager::getMRReceiverInfo (SyncSource & srcFrom)

Asks for the info in the most recent receiver report about the local source received from the source given as parameter. like "hey what did they say about me" but formally. 💅

Parameters:

  • srcFrom — Source of the receiver info.

Returns: most recent receiver info received from src.

Return values: NULL when no receiver report has been received from the specified source. 😭

🌸 RTCPSenderInfo * QueueRTCPManager::getMRSenderInfo (SyncSource & src)

Gets the most recent sender report received from a synchronization source. the tea, freshly brewed. ☕

Parameters:

  • src — Synchronization source of the sender info.

Returns: Most recent sender info received from src.

Return values: NULL when no sender report has been received from the specified source.

🌸 CryptoContextCtrl * QueueRTCPManager::getOutQueueCryptoContextCtrl (uint32 ssrc)

Get an output queue CryptoContext identified by SSRC. 🔐

Parameters:

  • ssrc — Request CryptoContext for this incoming SSRC

Returns: Pointer to CryptoContext of the SSRC of NULL if no context available for this SSRC.

🌸 uint32 QueueRTCPManager::getPrevMembersCount () const [inline], [protected]

No description, just a count doing its thing. 🌸

🌸 timeval QueueRTCPManager::getRTCPCheckInterval (void) [inline], [protected]

No description. clock behavior. ⏰

🌸 uint32 QueueRTCPManager::getSendRTCPPacketCount () const [inline]

Get the total number of RTCP packets sent until now. the running total, the receipts, the legacy. 📈

🌸 virtual void QueueRTCPManager::onGotAPP (SyncSource &, RTCPCompoundHandler::APPPacket &, size_t) [inline], [protected], [virtual]

Plug-in for handling of APP (application specific) RTCP packets. your app, your rules, slay.

Parameters:

  • Synchronization source of this packet.
  • RTCP APP packet struct.
  • Length of the app data packet, including ssrc. name and app. specific data.

🌸 virtual void QueueRTCPManager::onGotRR (SyncSource & source, RecvReport & RR, uint8 blocks) [protected], [virtual]

Plug-in for processing (aka acquiring the information carried in) an incoming RTCP Receiver Report. The default implementation in this class only processes the receiver report blocks about the local source. she's nosy about herself specifically, and honestly? same.

Parameters:

  • source — Synchronization source this report comes from.
  • RR — Receiver report structure
  • blocks — Number of report blocks in the packet

Examples: rtplisten.cpp.

🌸 bool QueueRTCPManager::onGotSDES (SyncSource & source, RTCPPacket & pkt) [protected]

Parameters:

  • source — Synchronization source of SDES RTCP packet.
  • pkt — SDES RTCP packet received.

🌸 virtual bool QueueRTCPManager::onGotSDESChunk (SyncSource & source, SDESChunk & chunk, size_t len) [protected], [virtual]

Plug-in for handling of SDES chunks. the lore, in chunks. 🧩

Parameters:

  • source — Synchronization source of SDES chunk.
  • chunk — SDES chunk structure.
  • len — Length of chunk, in octets.

Returns: whether there was a CNAME. (iconic identifier, iykyk)

Examples: rtplisten.cpp.

🌸 virtual void QueueRTCPManager::onGotSR (SyncSource & source, SendReport & SR, uint8 blocks) [protected], [virtual]

Plug-in for processing (aka acquiring the information carried in) an incoming RTCP Sender Report. The default implementation in this class only processes the sender information and the receiver report blocks about the local source. again, main character energy, correct.

Parameters:

  • source — Synchronization source this report comes from.
  • SR — Sender report structure.
  • blocks — Number of report blocks in the packet.

Examples: rtplisten.cpp.

🌸 void QueueRTCPManager::removeInQueueCryptoContextCtrl (CryptoContextCtrl * cc)

Remove input queue CryptoContext. The endQueue method (provided by RTPQueue) also deletes all registered CryptoContexts. 🧹

Parameters:

  • cc — Pointer to initialized CryptoContext to remove. If pointer if NULL then delete the whole queue

🌸 void QueueRTCPManager::removeOutQueueCryptoContextCtrl (CryptoContextCtrl * cc)

Remove output queue CryptoContext. The endQueue method (provided by RTPQueue) also deletes all registered CryptoContexts. bye bestie 💖

Parameters:

  • cc — Pointer to initialized CryptoContext to remove.

🌸 size_t QueueRTCPManager::sendControlToDestinations (unsigned char * buffer, size_t len) [protected]

No description given, but the name is loud enough. sending control to the destinations, as one does. 📮

🌸 void QueueRTCPManager::setControlBandwidth (float fraction) [inline], [protected]

No description. set the bandwidth, girl. 🎚️

🌸 void QueueRTCPManager::setEnd2EndDelay (microtimeout_t t) [inline]

This method sets the maximum end to end delay allowed. And listen — if the processing delay plus the trip time for a packet is greater than the end to end delay, the packet is discarded, and the application cannot get it. gone. poof. 🫠

This is a way of setting an upper bound to the end to end delay, computed as the elapsed time between the packet timestamping at the sender side, and the picking of the packet at the receiver side.

Parameters:

  • t — maximum end to end delay allowed. A value of 0 implies there is no limit and is the default

🌸 void QueueRTCPManager::setInQueueCryptoContextCtrl (CryptoContextCtrl * cc)

Set input queue CryptoContext. The endQueue method (provided by RTPQueue) deletes all registered CryptoContexts.

Parameters:

  • cc — Pointer to initialized CryptoContext.

🌸 void QueueRTCPManager::setLeavingDelay (microtimeout_t delay) [inline]

Set how much time the stack will wait before deleting a synchronization source that has sent an RTCP BYE packet. giving them a lil grace period before the unfollow. 🕊️

Parameters:

  • delay — delay in microseconds.
Note: The default delay is 1000000 microseconds

🌸 void QueueRTCPManager::setMinRTCPInterval (microtimeout_t interval) [inline]

Manually set the minimum interval for sending RTP compound packets.

Parameters:

  • interval — minimum interval between RTCP packets, in microseconds.

See also: computeRTCPInterval()

🌸 void QueueRTCPManager::setOutQueueCryptoContextCtrl (CryptoContextCtrl * cc)

Set output queue CryptoContext. The endQueue method (provided by RTPQueue) deletes all registered CryptoContexts.

Parameters:

  • cc — Pointer to initialized CryptoContext.

🌸 void QueueRTCPManager::setPrevMembersNum (uint32 n) [inline], [protected]

Parameters:

  • n — Number of members.

🌸 void QueueRTCPManager::setSendersControlFraction (float fraction) [inline]

Specify the fraction of the total control bandwith to be dedicated to senders reports. (yes, "bandwith", we keep it exactly as written bestie, we don't edit the original's spelling, that's the rule 💅)

Parameters:

  • fraction — fraction of bandwidth, must be between 0 an 1.

This method sets the fraction of the global control bandwidth that will be dedicated to senders reports. Of course, 1 - fraction will be dedicated to receivers reports. math is math. ✨

See also: setControlBandwidth

🦋 Member Data Documentation 🦋

the variables, the lore keepers:

  • uint32 QueueRTCPManager::rtcpPMembers
  • timeval QueueRTCPManager::rtcpTc
  • timeval QueueRTCPManager::rtcpTn
  • timeval QueueRTCPManager::rtcpTp

no descriptions on these, they're mysterious and that's their whole thing. 🎀

👑 Author 👑

Generated automatically by Doxygen for ccRTP from the source code.

and that's a wrap on the whole page bestie 💖 this was QueueRTCPManager(3) from the ccRTP source, footer's dated by the Doxygen auto-generation, and honestly? iconic. go read it again, you know you want to. periodt. 💅✨🌸🫶

📦 where this page comes from