RTPDuplex(3)

🌸 RTPDuplex(3) 🌸

okay bestie, so this one lives in the Library Functions Manual and it's called RTPDuplex 💖

---

✨ NAME ✨

RTPDuplex — a peer-associated RTP socket pair for physically connected peer hosts. like, two sockets that are literally vibing with each other, no cap 🦋

---

✨ SYNOPSIS ✨

#include <cc++/rtp.h>

Inherits RTPDataQueue, UDPReceive, and UDPTransmit. yeah she's got main character energy and a whole family tree 💅

🌈 Public Member Functions

• RTPDuplex (const InetAddress &bind, tpport_t local, tpport_t remote) — the glow-up constructor, no description attached, we move ✨
• virtual ~RTPDuplex () — the destructor, she exits gracefully 💀
• UDPTransmit::Error connect (const InetHostAddress &host, tpport_t port=0) — link up with a host, port defaults to 0 🫶

🌈 Public Member Functions inherited from RTPDataQueue

• void setTypeOfService (Tos tos) — tell the world what kind of service your app is expecting 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 — check that active connection state flag, is she awake or not 🙈
• uint32 getCurrentTimestamp () const — grab the timestamp you should slap on a packet whose payload sampling instant lines up with the current system time ⏰
• void setSessionBandwidth (uint32 bw) — set the bandwidth of the current session 📶
• uint32 getDefaultSessionBandwidth () const — the default, as advertised 🎀
• uint32 getSessionBandwidth () const — the current one, fr fr 💜
• void setTimeclock () — set the packet timeclock so timestamps stay in sync 🕰️
• timeout_t getTimeclock () const — get that same packet timeclock back ✨

🌈 Public Member Functions inherited from IncomingDataQueue

• SyncSourcesIterator begin () — start of the iterator, let's gooo 🌈
• SyncSourcesIterator end () — end of the iterator, and that's the vibe 🦋
• const AppDataUnit * getData (uint32 stamp, const SyncSource *src=NULL) — pull data out of a specific timestamped packet, but only if such a packet is actually hanging out in the receive buffer right now; src defaults to NULL 👑
• bool isWaiting (const SyncSource *src=NULL) const — are packets chilling in the reception queue? src defaults to NULL 🙈
• uint32 getFirstTimestamp (const SyncSource *src=NULL) const — timestamp of the first packet waiting in the queue; src defaults to NULL 🍓
• void setMinValidPacketSequence (uint8 packets) — when packets arrive from a new source it can be handy to reject the first few before you're actually sure the source is valid 🧚
• uint8 getDefaultMinValidPacketSequence () const — the default min valid packet sequence ✨
• uint8 getMinValidPacketSequence () const — get the minimum number of consecutive packets that must show up from a source before its data packets get accepted, periodt 💅
• void setMaxPacketMisorder (uint16 packets) — set the max packet misorder 🌀
• uint16 getDefaultMaxPacketMisorder () const — the default max packet misorder ⭐
• uint16 getMaxPacketMisorder () const — get the max packet misorder 💫
• void setMaxPacketDropout (uint16 packets) — also stops packets sent after a source restart from being accepted immediately, sneaky 🚫
• uint16 getDefaultMaxPacketDropout () const — the default max packet dropout 🎀
• uint16 getMaxPacketDropout () const — get the max packet dropout 💜
• void setInQueueCryptoContext (CryptoContext *cc) — set the input queue CryptoContext 🔐
• void removeInQueueCryptoContext (CryptoContext *cc) — remove the input queue CryptoContext 🗑️
• CryptoContext * getInQueueCryptoContext (uint32 ssrc) — get an input queue CryptoContext by its SSRC 🔑

🌈 Public Member Functions inherited from IncomingDataQueueBase

• size_t getDefaultMaxRecvPacketSize () const — the default max recv packet size 📦
• size_t getMaxRecvPacketSize () const — the current max recv packet size 📬
• void setMaxRecvPacketSize (size_t maxsize) — set that max recv packet size, go off ✨

🌈 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 — grab the local SSRC 🪪
• uint32 getCurrentRTPClockRate () const — clock rate in RTP clock units, like 8000 units per second for PCMU or 90000 units per second for MP2T ⏱️
• PayloadType getCurrentPayloadType () const — the current payload type 🏷️
• timeval getInitialTime () const — the initial time 🕐

🌈 Public Member Functions inherited from OutgoingDataQueue

• bool addDestination (const InetHostAddress &ia, tpport_t dataPort=DefaultRTPDataPort, tpport_t controlPort=0) — add a host destination; dataPort defaults to DefaultRTPDataPort, controlPort defaults to 0 📮
• bool addDestination (const InetMcastAddress &ia, tpport_t dataPort=DefaultRTPDataPort, tpport_t controlPort=0) — add a multicast destination; same defaults, dataPort=DefaultRTPDataPort, controlPort=0 📡
• bool forgetDestination (const InetHostAddress &ia, tpport_t dataPort=DefaultRTPDataPort, tpport_t controlPort=0) — forget a host destination, bye bestie 👋
• bool forgetDestination (const InetMcastAddress &ia, tpport_t dataPort=DefaultRTPDataPort, tpport_t controlPort=0) — forget a multicast destination, same energy 💔
• void addContributor (uint32 csrc) — add csrc as the CSRC identifier of a new contributor 🙋
• bool removeContributor (uint32 csrc) — remove that CSRC from the contributors list 🚪
• bool isSending () const — are outgoing packets waiting to send? 👀
• void putData (uint32 stamp, const unsigned char *data=NULL, size_t len=0) — this is how you create a data packet in the send queue; data defaults to NULL, len defaults to 0 📝
• void sendImmediate (uint32 stamp, const unsigned char *data=NULL, size_t len=0) — create a data packet AND send it immediately, no waiting around 🚀
• void setPadding (uint8 paddinglen) — set padding 🛋️
• void setMark (bool mark) — set the marker bit for the packet in which the next data you provide will be sent 🔖
• bool getMark () const — find out 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 a packet that's already queued 🧩
• 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, which expires packets pending in the send queue that have gone unsent and are already 'too late' to be sent now 😭
• microtimeout_t getExpireTimeout () const — get the expire timeout 🕰️
• uint32 getSendPacketCount () const — total number of packets sent so far, flex 📊
• uint32 getSendOctetCount () const — total number of octets sent so far, payload only 🔢
• uint16 getSequenceNumber () const — sequence number of the next outgoing packet 🔢
• void setOutQueueCryptoContext (CryptoContext *cc) — set the output queue CryptoContext 🔐
• void removeOutQueueCryptoContext (CryptoContext *cc) — remove the 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 the maximum payload segment size before sends get fragmented, we love boundaries ✂️
• size_t getMaxSendSegmentSize () — the current max send segment size 🎀

💅 Protected Member Functions

• bool isPendingData (microtimeout_t timeout) — is there pending data? ⏲️
• size_t sendData (const unsigned char *const buffer, size_t len) — send some data 📤
• size_t recvData (unsigned char *buffer, size_t len, InetHostAddress &na, tpport_t &tp) — receive some data 📥
• void setDataPeer (const InetAddress &, tpport_t) — set the data peer 🤝
• void setControlPeer (const InetAddress &, tpport_t) — set the control peer 🎛️
• size_t getNextDataPacketSize () const — size of the next data packet 📐
• SyncSource & getPeer () — grab the peer 🫶

💅 Protected Member Functions inherited from RTPDataQueue

• RTPDataQueue (uint32 size=defaultMembersHashSize) — the constructor; size defaults to defaultMembersHashSize 🏗️
• RTPDataQueue (uint32 *ssrc, uint32 size=defaultMembersHashSize) — with this constructor you can start a session with a given ssrc instead of the usual randomly generated one, custom queen energy; size defaults to defaultMembersHashSize 🎲
• virtual ~RTPDataQueue () — the queue destructor flushes the queue and stops all services, she cleans up after herself 🧹
• virtual void timerTick () — a plugin point for timer tick driven events ⏰
• void renewLocalSSRC () — renew the local SSRC 🔄
• void endQueue () — this method ends the queue, that's it that's the method 🛑

💅 Protected Member Functions inherited from IncomingDataQueue

• IncomingDataQueue (uint32 size) — constructor, takes a size 🏗️
• virtual ~IncomingDataQueue () — destructor 💀
• 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 how many RTCP intervals the stack will wait to flip a source from stateActive to stateInactive, or to delete the source after it's been in stateInactive 🕰️
• virtual size_t takeInDataPacket () — used by the service thread to process the next incoming packet and drop it in the receive list 🧺
• IncomingDataQueue::IncomingRTPPktLink * getWaiting (uint32 timestamp, const SyncSource *src=NULL) — fetch a packet in the receive queue and expire packets older than the current timestamp; src defaults to NULL ⌛
• 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 out of the scheduled reception queue 📤
• void purgeIncomingQueue () — purge the incoming queue 🧼
• virtual void onNewSyncSource (const SyncSource &) — virtual, called when a new synchronization source joins the session 🎉
• virtual bool onRTPPacketRecv (IncomingRTPPkt &) — a virtual function to help parse arriving packets, deciding whether 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 decoding an incoming SRTP was erroneous 😭
• virtual bool end2EndDelayed (IncomingRTPPktLink &) — end-to-end delayed hook 🐢
• bool insertRecvPacket (IncomingRTPPktLink *packetLink) — insert a just-received packet into the queue, both the general queue and the source-specific queue 🧷

💅 Protected Member Functions inherited from IncomingDataQueueBase

• IncomingDataQueueBase () — constructor 🏗️
• virtual ~IncomingDataQueueBase () — destructor 💀

💅 Protected Member Functions inherited from RTPQueueBase

• RTPQueueBase (uint32 *ssrc=NULL) — constructor; ssrc defaults to NULL 🏗️
• void setLocalSSRC (uint32 ssrc) — set the local SSRC 🪪
• uint32 getLocalSSRCNetwork () const — get the local SSRC network 🌐
• virtual ~RTPQueueBase () — destructor 💀
• virtual size_t dispatchBYE (const std::string &) — a plugin point for posting of BYE messages 👋

🫶 Protected Member Functions inherited from MembershipBookkeeping

• MembershipBookkeeping (uint32 initialSize=defaultMembersHashSize) — okay so this initial size is just a hint, bestie: it helps allocate the resources needed to keep the members' identifiers and associated info. ✨
• virtual ~MembershipBookkeeping () — purges every RTPSource structure created during the session, plus the hash table and the list of sources. 💅
• SyncSourceLink * getLink (const SyncSource &source) const — signature only, iykyk.
• bool isMine (const SyncSource &source) const — tells you whether a synchronization source is recorded in this membership controller. 👀
• bool isRegistered (uint32 ssrc) — returns whether there is already a synchronization source with the 'ssrc' SSRC identifier.
• SyncSourceLink * getSourceBySSRC (uint32 ssrc, bool &created) — gets 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. 👋
• bool removeSource (uint32 ssrc) — removes the description of the source identified by ssrc.
• SyncSourceLink * getFirst () — signature only.
• SyncSourceLink * getLast () — signature only.
• uint32 getMembersCount () — signature only.
• void setMembersCount (uint32 n) — signature only.
• uint32 getSendersCount () — signature only.
• size_t getDefaultMembersHashSize () — signature only.

🦋 Protected Member Functions inherited from SyncSourceHandler

• SyncSourceHandler ()
• virtual ~SyncSourceHandler ()
• void * getLink (const SyncSource &source) const — this one requires 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 to one or more destinations. 📬
• microtimeout_t getSchedulingTimeout () — computes the timeout period for scheduling transmission of the next packet at the 'head' of the send buffer. ⏰
• size_t dispatchDataPacket () — used by the service thread to process the next outgoing packet pending in the sending queue. 🧵
• void setNextSeqNum (uint32 seqNum) — for those cases where the application needs a method to set the sequence number for the outgoing stream (like when implementing the RTSP PLAY command). 🎬
• uint32 getCurrentSeqNum (void)
• void setInitialTimestamp (uint32 ts)
• uint32 getInitialTimestamp ()
• void purgeOutgoingQueue ()

🧚 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 is only a destination in the list. 1️⃣
• TransportAddress * getFirstDestination () const
• void lockDestinationList () const
• void unlockDestinationList () const

✨ 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 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 peer associated RTP socket pair for physically connected peer hosts. 👯‍♀️

This has no RTCP and assumes the receiver is connected to a known transmitter, hence no 'foreign' packets will arrive. No cap. 🚫

Author

David Sugar

RTP peer host over UDP. 🌐

Examples

rtpduphello.cpp.

Author

Generated automatically by Doxygen for ccRTP from the source code.

---

And the footer? It’s just ccRTP and RTPDuplex(3) — that’s the source/version and the page, plus whatever date Doxygen stamped on it, bestie. Stay iconic. 💅✨