TRTPSESSIONBASE(3)

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

✨ TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue > ✨

okay bestie, welcome to the blueprint of TRTPSessionBase 💖 this is the big foundational class for RTP sessions, and yes it's a template with three lil parameters: RTPDataChannel, RTCPChannel, and ServiceQueue. she's the main character and everyone else inherits her energy. let's get into it 🫶

🌸 SYNOPSIS 🌸

#include <rtp.h>

Inherits AVPQueue.

Inherited by SingleThreadRTPSession< RTPDataChannel, RTCPChannel, ServiceQueue >.

💅 Public Member Functions

  • TRTPSessionBase (const InetHostAddress &ia, tpport_t dataPort, tpport_t controlPort, uint32 membersSize, RTPApplication &app) — builds a session that's just sitting there, waiting for packets on a host address 🦋
  • TRTPSessionBase (uint32 ssrc, const InetHostAddress &ia, tpport_t dataPort, tpport_t controlPort, uint32 membersSize, RTPApplication &app) — same vibe, but you hand her the ssrc identifier for the local source yourself 💫
  • TRTPSessionBase (const InetMcastAddress &ia, tpport_t dataPort, tpport_t controlPort, uint32 membersSize, RTPApplication &app, uint32 iface) — builds a session waiting for packets on a multicast address, yes she does multicast, she contains multitudes 🌈
  • TRTPSessionBase (uint32 ssrc, const InetMcastAddress &ia, tpport_t dataPort, tpport_t controlPort, uint32 membersSize, RTPApplication &app, uint32 iface) — multicast again but with your own ssrc for the local source, iconic behavior ✨
  • virtual size_t dispatchBYE (const std::string &str) — the BYE dispatcher, no notes 💀
  • Socket::Error setMcastTTL (uint8 ttl) — sets the value of the TTL field in the packets she sends out, very demure, very mindful 🎀
  • virtual ~TRTPSessionBase () — the destructor, she logs off 😭
  • RTPDataChannel * getDSO (void) — grab the DSO, slay

🧚 Public Member Functions inherited from AVPQueue

  • void setControlBandwidth (float fraction) — tells the stack how much bandwidth is available for control (RTCP) packets, share the wealth bestie 💜
  • float getControlBandwidth () const — reads that number back

🌸 Public Member Functions inherited from QueueRTCPManager

  • RTCPSenderInfo * getMRSenderInfo (SyncSource &src) — gets the most recent sender report that came in from a synchronization source 👑
  • RTCPReceiverInfo * getMRReceiverInfo (SyncSource &srcFrom) — asks for the info in the most recent receiver report about the local source, as received from the source you pass in 🦋
  • void setLeavingDelay (microtimeout_t delay) — sets how long the stack waits before it deletes a synchronization source that already sent an RTCP BYE packet ✌️
  • void setEnd2EndDelay (microtimeout_t t) — sets the maximum end to end delay allowed, no cap on caring tho 💖
  • microtimeout_t getDefaultEnd2EndDelay () const — the default end to end delay
  • microtimeout_t getEnd2EndDelay () const — the current end to end delay
  • void setSendersControlFraction (float fraction) — says what fraction of the total control bandwidth gets dedicated to senders reports 📊
  • void setMinRTCPInterval (microtimeout_t interval) — manually sets the minimum interval for sending RTP compound packets, sometimes you just gotta take the wheel 💅
  • uint32 getSendRTCPPacketCount () const — the total number of RTCP packets sent so far, a flex fr fr 🔥
  • void setOutQueueCryptoContextCtrl (CryptoContextCtrl *cc) — sets the output queue CryptoContext
  • void removeOutQueueCryptoContextCtrl (CryptoContextCtrl *cc) — removes the output queue CryptoContext
  • CryptoContextCtrl * getOutQueueCryptoContextCtrl (uint32 ssrc) — gets an output queue CryptoContext identified by SSRC 🔍
  • void setInQueueCryptoContextCtrl (CryptoContextCtrl *cc) — sets the input queue CryptoContext
  • void removeInQueueCryptoContextCtrl (CryptoContextCtrl *cc) — removes the input queue CryptoContext
  • CryptoContextCtrl * getInQueueCryptoContextCtrl (uint32 ssrc) — gets an input queue CryptoContext identified by SSRC

💜 Public Member Functions inherited from RTPDataQueue

  • void setTypeOfService (Tos tos) — says what kind of service the application expects to use 🎀
  • void enableStack () — enables packet queue processing in the stack, wake her up ⭐
  • void disableStack () — disables packet queue processing in the stack, nap time 😴
  • bool isActive () const — gets the active connection state flag
  • uint32 getCurrentTimestamp () const — gets the timestamp you should give a packet whose payload sampling instant lines up with the current system time ⏰
  • void setSessionBandwidth (uint32 bw) — specifies the bandwidth of the current session
  • uint32 getDefaultSessionBandwidth () const — the default session bandwidth
  • uint32 getSessionBandwidth () const — the current session bandwidth
  • void setTimeclock () — sets the packet timeclock used for synchronizing timestamps 🕰️
  • timeout_t getTimeclock () const — gets the packet timeclock used for synchronizing timestamps

🦋 Public Member Functions inherited from IncomingDataQueue

  • SyncSourcesIterator begin () — begin, bestie
  • SyncSourcesIterator end () — end, bestie
  • const AppDataUnit * getData (uint32 stamp, const SyncSource *src=NULL) — retrieves data from a specific timestamped packet, if such a packet is currently available in the receive buffer 👀
  • bool isWaiting (const SyncSource *src=NULL) const — tells you if packets are waiting in the reception queue 🎀
  • uint32 getFirstTimestamp (const SyncSource *src=NULL) const — timestamp of the first packet waiting in the queue
  • void setMinValidPacketSequence (uint8 packets) — when packets arrive from a new source, sometimes you wanna reject the first few before you're actually sure the source is valid. cautious queen behavior 💅
  • uint8 getDefaultMinValidPacketSequence () const — the default minimum valid packet sequence
  • uint8 getMinValidPacketSequence () const — gets the minimum number of consecutive packets that must arrive from a source before her data packets get accepted ✅
  • void setMaxPacketMisorder (uint16 packets) — sets the max packet misorder
  • uint16 getDefaultMaxPacketMisorder () const — the default max packet misorder
  • uint16 getMaxPacketMisorder () const — the current max packet misorder
  • void setMaxPacketDropout (uint16 packets) — sets the max packet dropout. this one also stops packets sent after a source restart from being immediately accepted, sneaky-proof 🔒
  • uint16 getDefaultMaxPacketDropout () const — the default max packet dropout
  • uint16 getMaxPacketDropout () const — the current max packet dropout
  • void setInQueueCryptoContext (CryptoContext *cc) — sets the input queue CryptoContext
  • void removeInQueueCryptoContext (CryptoContext *cc) — removes the input queue CryptoContext
  • CryptoContext * getInQueueCryptoContext (uint32 ssrc) — gets 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 current max receive packet size
  • void setMaxRecvPacketSize (size_t maxsize) — sets the max receive packet size

⭐ Public Member Functions inherited from RTPQueueBase

  • bool setPayloadFormat (const PayloadFormat &pf) — sets the payload format in use, for timing and payload type identification purposes 🎯
  • uint32 getLocalSSRC () const — your local SSRC
  • uint32 getCurrentRTPClockRate () const — gets the 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) — adds a destination, come through 💫
  • bool addDestination (const InetMcastAddress &ia, tpport_t dataPort=DefaultRTPDataPort, tpport_t controlPort=0) — adds a multicast destination
  • bool forgetDestination (const InetHostAddress &ia, tpport_t dataPort=DefaultRTPDataPort, tpport_t controlPort=0) — forgets a destination, we don't know her 💀
  • bool forgetDestination (const InetMcastAddress &ia, tpport_t dataPort=DefaultRTPDataPort, tpport_t controlPort=0) — forgets a multicast destination
  • void addContributor (uint32 csrc) — adds csrc as the CSRC identifier of a new contributor 🫶
  • bool removeContributor (uint32 csrc) — removes CSRC from the list of contributors
  • bool isSending () const — tells you if outgoing packets are waiting to send 📤
  • void putData (uint32 stamp, const unsigned char *data=NULL, size_t len=0) — this is what you use to create a data packet in the send queue ✨
  • void sendImmediate (uint32 stamp, const unsigned char *data=NULL, size_t len=0) — this one creates a data packet and sends it immediately, no waiting around 🔥
  • void setPadding (uint8 paddinglen) — sets padding
  • void setMark (bool mark) — sets the marker bit for the packet that the next data you provide will be sent in 🏷️
  • bool getMark () const — tells you 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) — sets partial data for an already queued packet
  • microtimeout_t getDefaultSchedulingTimeout () const — the default scheduling timeout
  • void setSchedulingTimeout (microtimeout_t to) — sets 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) — sets the 'expired' timer for expiring packets pending in the send queue that have gone unsent and are already 'too late' to be sent now. brutal but necessary 😭
  • microtimeout_t getExpireTimeout () const — the current expire timeout
  • uint32 getSendPacketCount () const — the total number of packets sent so far
  • uint32 getSendOctetCount () const — the total number of octets sent so far, payload only bestie 📦
  • uint16 getSequenceNumber () const — the sequence number of the next outgoing packet
  • void setOutQueueCryptoContext (CryptoContext *cc) — sets the output queue CryptoContext
  • void removeOutQueueCryptoContext (CryptoContext *cc) — removes the output queue CryptoContext
  • CryptoContext * getOutQueueCryptoContext (uint32 ssrc) — gets 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) — sets the maximum payload segment size before sends get fragmented ✂️
  • size_t getMaxSendSegmentSize () — the current max send segment size

🔐 Protected Member Functions

  • bool isPendingData (microtimeout_t timeout) — is there pending data?
  • InetHostAddress getDataSender (tpport_t *port=NULL) const — who's the data sender?
  • size_t getNextDataPacketSize () const — how big is the next data packet?
  • size_t recvData (unsigned char *buffer, size_t len, InetHostAddress &na, tpport_t &tp) — receives data from the data channel/socket 📥
  • void setDataPeer (const InetAddress &host, tpport_t port) — sets the data peer
  • size_t sendData (const unsigned char *const buffer, size_t len) — sends data
  • SOCKET getDataRecvSocket () const — the data receive socket
  • bool isPendingControl (microtimeout_t timeout) — is there pending control?
  • InetHostAddress getControlSender (tpport_t *port=NULL) const — who's the control sender?
  • size_t recvControl (unsigned char *buffer, size_t len, InetHostAddress &na, tpport_t &tp) — receives data from the control channel/socket 📨
  • void setControlPeer (const InetAddress &host, tpport_t port) — sets the control peer
  • size_t sendControl (const unsigned char *const buffer, size_t len) — sends control
  • SOCKET getControlRecvSocket () const — the control receive socket
  • Socket::Error joinGroup (const InetMcastAddress &ia, uint32 iface) — joins a multicast group, welcome to the group chat 🫂
  • Socket::Error leaveGroup (const InetMcastAddress &ia) — leaves a multicast group, she's leaving the group chat 😭
  • void endSocket () — ends the socket

okay that's part 1 bestie, stay tuned for more 💖

🫶 Protected Member Functions inherited from AVPQueue 🫶

okay so these are the ones AVPQueue hands down to you — protected, so they're for you and your subclass besties, not for randos calling in from outside 💅

  • AVPQueue (uint32 size=RTPDataQueue::defaultMembersHashSize, RTPApplication &app=defaultApplication()) — the standard constructor, takes a size and an application and gets you set up.
  • AVPQueue (uint32 ssrc, uint32 size=RTPDataQueue::defaultMembersHashSize, RTPApplication &app=defaultApplication()) — the choose-your-own-SSRC edition ✨ the local SSRC is handed to you instead of being computed by the queue.
  • virtual ~AVPQueue () — destructor, does the tidy-up thing.

💖 Protected Member Functions inherited from QueueRTCPManager 💖

the RTCP control-plane bestie. all the timing rules, the collision detection, the plug-ins — it's giving very much management energy 👑

  • QueueRTCPManager (uint32 size=RTPDataQueue::defaultMembersHashSize, RTPApplication &app=defaultApplication()) — constructor with a size and an app.
  • QueueRTCPManager (uint32 ssrc, uint32 size=RTPDataQueue::defaultMembersHashSize, RTPApplication &app=defaultApplication()) — constructor where you supply the SSRC yourself.
  • virtual ~QueueRTCPManager () — destructor.
  • const RTPApplication & getApplication () — hands you the application, read-only style.
  • void setControlBandwidth (float fraction) — sets the control bandwidth as a fraction.
  • float getControlBandwidth () const — reads that fraction back out.
  • void controlTransmissionService () — builds and sends RTCP packets following the timing rules, including the 'timer reconsideration' algorithm. no cap, that algorithm is real and it matters.
  • void controlReceptionService () — processes the incoming RTCP packets that are sitting pending in the control reception socket.
  • bool checkSSRCInRTCPPkt (SyncSourceLink &sourceLink, bool is_new, InetAddress &na, tpport_t tp) — applies the collision and loop detection and correction algorithm when you're receiving RTCP packets. so important, don't skip it 💀
  • void endQueueRTCPManager () — wraps up the RTCP manager.
  • virtual void onGotSR (SyncSource &source, SendReport &SR, uint8 blocks) — plug-in point for processing an incoming RTCP Sender Report (aka acquiring the info it carries).
  • virtual void onGotRR (SyncSource &source, RecvReport &RR, uint8 blocks) — plug-in point for processing an incoming RTCP Receiver Report.
  • bool onGotSDES (SyncSource &source, RTCPPacket &pkt) — handles an incoming SDES.
  • virtual bool onGotSDESChunk (SyncSource &source, SDESChunk &chunk, size_t len) — plug-in for handling SDES chunks.
  • virtual void onGotAPP (SyncSource &, RTCPCompoundHandler::APPPacket &, size_t) — plug-in for handling APP (application specific) RTCP packets.
  • timeval getRTCPCheckInterval () — gives you the RTCP check interval as a timeval.
  • uint32 getLastSendPacketCount () const — gets the number of data packets that had been sent at the time the last SR was generated.
  • void setPrevMembersNum (uint32 n) — sets the previous members number.
  • uint32 getPrevMembersCount () const — gets the previous members count.
  • size_t sendControlToDestinations (unsigned char *buffer, size_t len) — sends that control data out to the destinations.

🌸 Protected Member Functions inherited from RTPDataQueue 🌸

the big one, the whole queue vibe.

  • 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. cute and specific, love that for you.
  • virtual ~RTPDataQueue () — the queue destructor flushes the queue and stops all services. everything. gone. 🫶
  • virtual void timerTick () — a plugin point for timer tick driven events.
  • void renewLocalSSRC () — regenerates your local SSRC.
  • void endQueue () — this method ends the queue.

🦋 Protected Member Functions inherited from IncomingDataQueue 🦋

the receiving side of the operation. packets come in, packets get checked, packets get queued.

  • IncomingDataQueue (uint32 size) — constructor, takes a size.
  • virtual ~IncomingDataQueue () — destructor.
  • bool checkSSRCInIncomingRTPPkt (SyncSourceLink &sourceLink, bool is_new, InetAddress &na, tpport_t tp) — applies the collision and loop detection and correction algorithm when receiving RTP data packets.
  • void setSourceExpirationPeriod (uint8 intervals) — sets how many RTCP intervals the stack will wait before flipping a source from stateActive to stateInactive, or before deleting the source after it's been sitting in stateInactive. yes, it's literally the grace period 😭
  • 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) — used to fetch a packet out of the receive queue and to expire any packets older than the current timestamp. note the src default is NULL.
  • bool recordReception (SyncSourceLink &srcLink, const IncomingRTPPkt &pkt, const timeval recvtime) — logs the reception of a new RTP packet from this source.
  • void recordExtraction (const IncomingRTPPkt &pkt) — logs the extraction of a packet from this source, out of the scheduled reception queue.
  • void purgeIncomingQueue () — clears out the incoming queue.
  • virtual void onNewSyncSource (const SyncSource &) — virtual that gets called when a new synchronization source has joined the session. welcome to the group chat bestie 🎀
  • virtual bool onRTPPacketRecv (IncomingRTPPkt &) — a virtual function to support parsing of arriving packets, so you can decide whether they should be kept in the queue, and to dispatch events.
  • virtual void onExpireRecv (IncomingRTPPkt &) — a hook to filter the packets in the receive queue that are in the process of expiring.
  • virtual bool onSRTPPacketError (IncomingRTPPkt &pkt, int32 errorCode) — a hook that gets called if the decoding of an incoming SRTP was erroneous. 💀 not the SRTP decode fail
  • bool insertRecvPacket (IncomingRTPPktLink *packetLink) — inserts a just-received packet into the queue — both the general queue and the source specific queues.

✨ 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) — sets the local SSRC.
  • uint32 getLocalSSRCNetwork () const — gets the local SSRC, in network form.
  • virtual ~RTPQueueBase () — destructor.

🍓 Protected Member Functions inherited from MembershipBookkeeping 🍓

who's in the session, who's out, and where all their info lives. very much the roster keeper of the whole thing 📋

  • MembershipBookkeeping (uint32 initialSize=defaultMembersHashSize) — the initial size is a hint, used to allocate the resources needed to keep the members' identifiers and all their associated info.
  • virtual ~MembershipBookkeeping () — purges all the RTPSource structures created during the session, plus the hash table and the list of sources. full reset, no leftovers 🧹
  • SyncSourceLink * getLink (const SyncSource &source) const — gets the link for a source.
  • bool isMine (const SyncSource &source) const — gets whether a synchronization source is recorded in this membership controller.
  • bool isRegistered (uint32 ssrc) — returns whether there's 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. the created flag tells you if it got made on the spot.
  • 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 () — gets the first link.
  • SyncSourceLink * getLast () — gets the last link.
  • uint32 getMembersCount () — how many members, as a number.
  • void setMembersCount (uint32 n) — sets the members count to n.
  • uint32 getSendersCount () — how many senders.
  • size_t getDefaultMembersHashSize () — returns the default members hash size.

🌈 Protected Member Functions inherited from SyncSourceHandler 🌈

  • SyncSourceHandler () — constructor.
  • virtual ~SyncSourceHandler () — destructor.
  • void * getLink (const SyncSource &source) const — this one requires SyncSource – SyncSourceHandler friendship. iykyk 🔥
  • void setLink (SyncSource &source, void *link) — sets the link on a source.
  • void setParticipant (SyncSource &source, Participant &p) — attaches a participant.
  • void setState (SyncSource &source, SyncSource::State ns) — sets the source's state.
  • void setSender (SyncSource &source, bool active) — marks whether the source is an active sender.
  • void setDataTransportPort (SyncSource &source, tpport_t p) — sets the data transport port.
  • void setControlTransportPort (SyncSource &source, tpport_t p) — sets the control transport port.
  • void setNetworkAddress (SyncSource &source, InetAddress addr) — sets the network address.

🎀 Protected Member Functions inherited from ParticipantHandler 🎀

  • ParticipantHandler () — constructor.
  • virtual ~ParticipantHandler () — destructor.
  • void setSDESItem (Participant *part, SDESItemType item, const std::string &val) — sets an SDES item on a participant.
  • void setPRIVPrefix (Participant *part, const std::string val) — sets the PRIV prefix on a participant.

🌟 Protected Member Functions inherited from ApplicationHandler 🌟

  • ApplicationHandler () — constructor.
  • virtual ~ApplicationHandler () — destructor.
  • void addParticipant (RTPApplication &app, Participant &part) — adds a participant to the application.
  • void removeParticipant (RTPApplication &app, RTPApplication::ParticipantLink *pl) — removes a participant from the application.

💅 Protected Member Functions inherited from ConflictHandler 💅

collision drama management. somebody's using your address? this is the department that handles it 🚨

  • ConflictHandler () — constructor.
  • virtual ~ConflictHandler () — destructor.
  • ConflictingTransportAddress * searchDataConflict (InetAddress na, tpport_t dtp) — searches for a data conflict.
  • ConflictingTransportAddress * searchControlConflict (InetAddress na, tpport_t ctp) — searches for a control conflict.
  • void updateConflict (ConflictingTransportAddress &ca) — updates a conflict record.
  • void addConflict (const InetAddress &na, tpport_t dtp, tpport_t ctp) — adds a conflict with the given network address and data/control transport ports.

🧚 Protected Member Functions inherited from OutgoingDataQueue 🧚

the sending side. scheduling, dispatching, sequence numbers — the whole put-it-on-the-wire situation.

  • OutgoingDataQueue () — constructor.
  • virtual ~OutgoingDataQueue () — destructor.
  • void dispatchImmediate (OutgoingRTPPkt *packet) — used to write the RTP data packet out to one or more destinations. right now. immediately. periodt.
  • microtimeout_t getSchedulingTimeout () — computes the timeout period for scheduling the transmission of the next packet sitting 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 way to set the sequence number for the outgoing stream (like, say, implementing the RTSP PLAY command 👀).
  • uint32 getCurrentSeqNum (void) — gets the current sequence number.
  • void setInitialTimestamp (uint32 ts) — sets the initial timestamp.
  • uint32 getInitialTimestamp () — gets the initial timestamp.
  • void purgeOutgoingQueue () — clears out the outgoing queue.

⭐ Protected Member Functions inherited from OutgoingDataQueueBase ⭐

  • OutgoingDataQueueBase () — constructor.
  • virtual ~OutgoingDataQueueBase () — destructor.

🫶 Protected Member Functions inherited from DestinationListHandler 🫶

  • void writeLockDestinationList () const — takes the write lock on the destination list.
  • 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 () — constructor.
  • ~DestinationListHandler () — destructor.
  • bool isSingleDestination () const — gets whether there's only a single destination in the list.
  • TransportAddress * getFirstDestination () const — gets the first destination in the list.
  • void lockDestinationList () const — locks the destination list.
  • void unlockDestinationList () const — unlocks it again.

🌈 Protected Member Functions inherited from RTCPCompoundHandler 🌈

  • RTCPCompoundHandler (uint16 mtu=defaultPathMTU) — constructor, mtu defaults to defaultPathMTU.
  • ~RTCPCompoundHandler () — destructor.
  • bool checkCompoundRTCPHeader (size_t len) — performs the RTCP compound packet header validity check, exactly as specified in draft-ietv-avt-rtp-new.
  • void setPathMTU (uint16 mtu) — sets the path MTU.
  • uint16 getPathMTU () — gets the path MTU.

🎀 Protected Attributes 🎀

the actual variables, just vibing in protected-land:

  • RTPDataChannel * dso — the data socket object.
  • RTCPChannel * cso — the control socket object.

💜 Protected Attributes inherited from IncomingDataQueue 💜

  • ThreadLock recvLock — the receive lock.
  • IncomingRTPPktLink * recvFirst — first packet link in the receive list.
  • IncomingRTPPktLink * recvLast — last packet link in the receive list.
  • uint8 minValidPacketSequence — the minimum valid packet sequence.
  • uint16 maxPacketMisorder — the max packet misorder.
  • uint16 maxPacketDropout — the max packet dropout.
  • uint8 sourceExpirationPeriod — how long a source hangs around before it expires.
  • Mutex cryptoMutex — the mutex guarding the crypto stuff.
  • std::list< CryptoContext * > cryptoContexts — the list of crypto contexts.

💅 Protected Attributes inherited from ConflictHandler 💅

  • ConflictingTransportAddress * firstConflict — first conflict in the list.
  • ConflictingTransportAddress * lastConflict — last conflict in the list.

🛡️ Protected Attributes inherited from OutgoingDataQueue 🛡️

  • Mutex cryptoMutex — a mutex for all the crypto things, bestie. 🔒
  • std::list< CryptoContext * > cryptoContexts — a whole list of crypto contexts, no cap. 🔐

🛡️ Protected Attributes inherited from DestinationListHandler 🛡️

  • std::list< TransportAddress * > destList — the list of destination addresses. 📍

🛡️ Protected Attributes inherited from RTCPCompoundHandler 🛡️

  • unsigned char * rtcpSendBuffer — buffer for sending RTCP. 📤
  • unsigned char * rtcpRecvBuffer — buffer for receiving RTCP. 📥

🤝 Friends 🤝

  • class RTPSessionBaseHandler — it's a friend, periodt. 🫶

🧬 Additional Inherited Members 🧬

🌈 Public Types inherited from RTPDataQueue 🌈

  • enum Tos { tosBestEffort, tosEnhanced } — Type of Service, bestie! Pick tosBestEffort or tosEnhanced. ✨ (from rtp.h cc++/rtp.h)

⚡ Static Public Member Functions inherited from IncomingDataQueue ⚡

  • static size_t getDefaultMembersSize () — gets the default members size. 📏

🛡️ Protected Types inherited from RTCPCompoundHandler 🛡️

  • enum { defaultPathMTU = 1500 } — default path MTU is 1500. 📦

🔒 Static Protected Attributes inherited from IncomingDataQueue 🔒

  • static const uint8 defaultMinValidPacketSequence — minimum valid packet sequence. 🔢
  • static const uint16 defaultMaxPacketMisorder — max packet misorder. 🔄
  • static const uint16 defaultMaxPacketDropout — max packet dropout. 💧
  • static const size_t defaultMembersSize — default members size. 👥

🔒 Static Protected Attributes inherited from MembershipBookkeeping 🔒

  • static const size_t defaultMembersHashSize — default members hash size. #️⃣
  • static const uint32 SEQNUMMOD — sequence number mod. 🧮

🛠️ Constructor & Destructor Documentation 🛠️

🏗️ Constructor 1: TRTPSessionBase (host address) 🏗️

template<class RTPDataChannel  = DualRTPUDPIPv4Channel, class RTCPChannel  = DualRTPUDPIPv4Channel, class ServiceQueue  = AVPQueue> TRTPSessionBase<RTPDataChannel, RTCPChannel, ServiceQueue >::TRTPSessionBase (const InetHostAddress & ia, tpport_t dataPort, tpport_t controlPort, uint32 membersSize, RTPApplication & app) [inline]

Builds a session waiting for packets in a host address. 🏠

Parameters:

  • ia — Network address this socket is to be bound. 📍
  • dataPort — Transport port the data socket is to be bound. 🔌
  • controlPort — Transport port the control socket is to be bound. 🎛️
  • membersSize — Initial size of the membership table. 👥
  • app — Application this session is associated to. 📱

🏗️ Constructor 2: TRTPSessionBase (with ssrc, host address) 🏗️

template<class RTPDataChannel  = DualRTPUDPIPv4Channel, class RTCPChannel  = DualRTPUDPIPv4Channel, class ServiceQueue  = AVPQueue> TRTPSessionBase<RTPDataChannel, RTCPChannel, ServiceQueue >::TRTPSessionBase (uint32 ssrc, const InetHostAddress & ia, tpport_t dataPort, tpport_t controlPort, uint32 membersSize, RTPApplication & app) [inline]

Builds a session with the specified ssrc identifier for the local source. 🆔

Parameters:

  • ssrc — SSRC identifier for the local source. 🆔
  • ia — Network address this socket is to be bound. 📍
  • dataPort — Transport port the data socket is to be bound. 🔌
  • controlPort — Transport port the control socket is to be bound. 🎛️
  • membersSize — Initial size of the membership table. 👥
  • app — Application this session is associated to. 📱

🏗️ Constructor 3: TRTPSessionBase (multicast address) 🏗️

template<class RTPDataChannel  = DualRTPUDPIPv4Channel, class RTCPChannel  = DualRTPUDPIPv4Channel, class ServiceQueue  = AVPQueue> TRTPSessionBase<RTPDataChannel, RTCPChannel, ServiceQueue >::TRTPSessionBase (const InetMcastAddress & ia, tpport_t dataPort, tpport_t controlPort, uint32 membersSize, RTPApplication & app, uint32 iface) [inline]

Builds a session waiting for packets in a multicast address. 📡

TODO: ssrc constructor for multicast! 🚧 — like, it's not here yet, bestie.

Parameters:

  • ia — Multicast address this socket is to be bound. 📡
  • dataPort — Transport port the data socket is to be bound. 🔌
  • controlPort — Transport port the control socket is to be bound. 🎛️
  • membersSize — Initial size of the membership table. 👥
  • app — Application this session is associated to. 📱
  • iface — Index (from 0 to n) of network interface to join to multicast group. 🔢

🏗️ Constructor 4: TRTPSessionBase (with ssrc, multicast address) 🏗️

template<class RTPDataChannel  = DualRTPUDPIPv4Channel, class RTCPChannel  = DualRTPUDPIPv4Channel, class ServiceQueue  = AVPQueue> TRTPSessionBase<RTPDataChannel, RTCPChannel, ServiceQueue >::TRTPSessionBase (uint32 ssrc, const InetMcastAddress & ia, tpport_t dataPort, tpport_t controlPort, uint32 membersSize, RTPApplication & app, uint32 iface) [inline]

Builds a session waiting for packets in a multicast address, with the specified ssrc identifier for the local source. 🆔📡

Parameters:

  • ssrc — SSRC identifier for the local source. 🆔
  • ia — Multicast address this socket is to be bound. 📡
  • dataPort — Transport port the data socket is to be bound. 🔌
  • controlPort — Transport port the control socket is to be bound. 🎛️
  • membersSize — Initial size of the membership table. 👥
  • app — Application this session is associated to. 📱
  • iface — Index (from 0 to n) of network interface to join to multicast group. 🔢

💥 Destructor: ~TRTPSessionBase 💥

template<class RTPDataChannel  = DualRTPUDPIPv4Channel, class RTCPChannel  = DualRTPUDPIPv4Channel, class ServiceQueue  = AVPQueue> virtual TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue >::~TRTPSessionBase () [inline],  [virtual]

This is the destructor, bestie. It cleans up everything. 🧹✨

💖 Member Function Documentation 💖

okay bestie, this is the main character section. every single one of these has the same iconic template preamble, and we are keeping it exactly as written. no cap, no edits, no merging. periodt. 💅

  • dispatchBYE — template<class RTPDataChannel = DualRTPUDPIPv4Channel, class RTCPChannel = DualRTPUDPIPv4Channel, class ServiceQueue = AVPQueue> virtual size_t TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue >::dispatchBYE (const std::string & str) [inline], [virtual] Reimplemented from QueueRTCPManager. Reimplemented in SingleThreadRTPSession< RTPDataChannel, RTCPChannel, ServiceQueue >.
  • endSocket — template<class RTPDataChannel = DualRTPUDPIPv4Channel, class RTCPChannel = DualRTPUDPIPv4Channel, class ServiceQueue = AVPQueue> void TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue >::endSocket () [inline], [protected] no extra description in the manpage, just the protected vibe. 🫶
  • getControlRecvSocket — template<class RTPDataChannel = DualRTPUDPIPv4Channel, class RTCPChannel = DualRTPUDPIPv4Channel, class ServiceQueue = AVPQueue> SOCKET TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue >::getControlRecvSocket () const [inline], [protected] (the manpage is quiet here, so we keep it cute and exact.)
  • getControlSender — template<class RTPDataChannel = DualRTPUDPIPv4Channel, class RTCPChannel = DualRTPUDPIPv4Channel, class ServiceQueue = AVPQueue> InetHostAddress TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue >::getControlSender (tpport_t * port = NULL) const [inline], [protected]
  • getDataRecvSocket — template<class RTPDataChannel = DualRTPUDPIPv4Channel, class RTCPChannel = DualRTPUDPIPv4Channel, class ServiceQueue = AVPQueue> SOCKET TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue >::getDataRecvSocket () const [inline], [protected]
  • getDataSender — template<class RTPDataChannel = DualRTPUDPIPv4Channel, class RTCPChannel = DualRTPUDPIPv4Channel, class ServiceQueue = AVPQueue> InetHostAddress TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue >::getDataSender (tpport_t * port = NULL) const [inline], [protected]
  • getDSO — template<class RTPDataChannel = DualRTPUDPIPv4Channel, class RTCPChannel = DualRTPUDPIPv4Channel, class ServiceQueue = AVPQueue> RTPDataChannel * TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue >::getDSO (void) [inline]
  • getNextDataPacketSize — template<class RTPDataChannel = DualRTPUDPIPv4Channel, class RTCPChannel = DualRTPUDPIPv4Channel, class ServiceQueue = AVPQueue> size_t TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue >::getNextDataPacketSize () const [inline], [protected], [virtual] Implements IncomingDataQueue.
  • isPendingControl — template<class RTPDataChannel = DualRTPUDPIPv4Channel, class RTCPChannel = DualRTPUDPIPv4Channel, class ServiceQueue = AVPQueue> bool TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue >::isPendingControl (microtimeout_t timeout) [inline], [protected], [virtual]
    • Parameters
      • timeout — maximum timeout to wait, in microseconds
    • Returns
      • whether there are packets waiting to be picked Implements QueueRTCPManager.
  • isPendingData — template<class RTPDataChannel = DualRTPUDPIPv4Channel, class RTCPChannel = DualRTPUDPIPv4Channel, class ServiceQueue = AVPQueue> bool TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue >::isPendingData (microtimeout_t timeout) [inline], [protected], [virtual]
    • Parameters
      • timeout — maximum timeout to wait, in microseconds Implements RTPDataQueue.
  • joinGroup — template<class RTPDataChannel = DualRTPUDPIPv4Channel, class RTCPChannel = DualRTPUDPIPv4Channel, class ServiceQueue = AVPQueue> Socket::Error TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue >::joinGroup (const InetMcastAddress & ia, uint32 iface) [inline], [protected] Join a multicast group.
    • Parameters
      • ia — address of the multicast group
    • Returns
      • error code from the socket operation
  • leaveGroup — template<class RTPDataChannel = DualRTPUDPIPv4Channel, class RTCPChannel = DualRTPUDPIPv4Channel, class ServiceQueue = AVPQueue> Socket::Error TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue >::leaveGroup (const InetMcastAddress & ia) [inline], [protected] Leave a multicast group.
    • Parameters
      • ia — address of the multicast group
    • Returns
      • error code from the socket operation
  • recvControl — template<class RTPDataChannel = DualRTPUDPIPv4Channel, class RTCPChannel = DualRTPUDPIPv4Channel, class ServiceQueue = AVPQueue> size_t TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue >::recvControl (unsigned char * buffer, size_t len, InetHostAddress & na, tpport_t & tp) [inline], [protected], [virtual] Receive data from the control channel/socket.
    • Parameters
      • buffer — Buffer where to get data.
      • len — Maximum number of octets to get.
      • na — Source network address.
      • tp — Source transport port.
    • Returns
      • Number of octets actually read. Implements QueueRTCPManager.
  • recvData — template<class RTPDataChannel = DualRTPUDPIPv4Channel, class RTCPChannel = DualRTPUDPIPv4Channel, class ServiceQueue = AVPQueue> size_t TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue >::recvData (unsigned char * buffer, size_t len, InetHostAddress & na, tpport_t & tp) [inline], [protected], [virtual] Receive data from the data channel/socket.
    • Parameters
      • buffer — Memory region to read to.
      • len — Maximum number of octets to get.
      • na — Source network address.
      • tp — Source transport port.
    • Returns
      • Number of octets actually read. Implements IncomingDataQueue.
  • sendControl — template<class RTPDataChannel = DualRTPUDPIPv4Channel, class RTCPChannel = DualRTPUDPIPv4Channel, class ServiceQueue = AVPQueue> size_t TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue >::sendControl (const unsigned char *const buffer, size_t len) [inline], [protected], [virtual]
    • Returns
      • number of octets actually written
    • Parameters
      • buffer
      • len Implements QueueRTCPManager.
  • sendData — template<class RTPDataChannel = DualRTPUDPIPv4Channel, class RTCPChannel = DualRTPUDPIPv4Channel, class ServiceQueue = AVPQueue> size_t TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue >::sendData (const unsigned char *const buffer, size_t len) [inline], [protected], [virtual]
    • Parameters
      • buffer — memory region to write from
      • len — number of octets to write Reimplemented from OutgoingDataQueue.
  • setControlPeer — template<class RTPDataChannel = DualRTPUDPIPv4Channel, class RTCPChannel = DualRTPUDPIPv4Channel, class ServiceQueue = AVPQueue> void TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue >::setControlPeer (const InetAddress & host, tpport_t port) [inline], [protected], [virtual] Reimplemented from OutgoingDataQueue.
  • setDataPeer — template<class RTPDataChannel = DualRTPUDPIPv4Channel, class RTCPChannel = DualRTPUDPIPv4Channel, class ServiceQueue = AVPQueue> void TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue >::setDataPeer (const InetAddress & host, tpport_t port) [inline], [protected], [virtual] Reimplemented from OutgoingDataQueue.
  • setMcastTTL — template<class RTPDataChannel = DualRTPUDPIPv4Channel, class RTCPChannel = DualRTPUDPIPv4Channel, class ServiceQueue = AVPQueue> Socket::Error TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue >::setMcastTTL (uint8 ttl) [inline] Set the value of the TTL field in the sent packets.
    • Parameters
      • ttl — Time To Live
    • Returns
      • error code from the socket operation
  • template<class RTPDataChannel = DualRTPUDPIPv4Channel, class RTCPChannel = DualRTPUDPIPv4Channel, class ServiceQueue = AVPQueue> friend class RTPSessionBaseHandler [friend] a friend class? iconic. the manpage said it, we're just relaying the message. 💖

🌸 Member Data Documentation 🌸

  • cso — template<class RTPDataChannel = DualRTPUDPIPv4Channel, class RTCPChannel = DualRTPUDPIPv4Channel, class ServiceQueue = AVPQueue> RTCPChannel* TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue >::cso [protected]
  • dso — template<class RTPDataChannel = DualRTPUDPIPv4Channel, class RTCPChannel = DualRTPUDPIPv4Channel, class ServiceQueue = AVPQueue> RTPDataChannel* TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue >::dso [protected]

💅 Author 💅

Generated automatically by Doxygen for ccRTP from the source code.

not a human, just doxygen doing its thing, and honestly it ate. 🤖✨

and that's the whole page, bestie! the footer says ccRTP as the source/version, and the date is right there on that last line — go peep it. mwah. 💖🎀🦋

📦 where this page comes from