rtpext(3)

✨ rtpext — ccRTP Extension classes ✨

okay bestie, welcome to rtpext, a page from the Library Functions Manual 💖 this one's all about ccRTP's extension classes, and yes it's giving very "C++ headers but make it a moment" energy. Let's get into it 🫶

---

🌸 SYNOPSIS 🌸

👑 Classes

• class RTPDuplex — a peer-associated RTP socket pair, for peer hosts that are physically connected to each other. iconic setup, no cap.

🧚 Functions

RTPDuplex::RTPDuplex (const InetAddress &bind, tpport_t local, tpport_t remote)
virtual RTPDuplex::~RTPDuplex ()
UDPTransmit::Error RTPDuplex::connect (const InetHostAddress &host, tpport_t port=0)
bool RTPDuplex::isPendingData (microtimeout_t timeout)
size_t RTPDuplex::sendData (const unsigned char *const buffer, size_t len)
size_t RTPDuplex::recvData (unsigned char *buffer, size_t len, InetHostAddress &na, tpport_t &tp)
void RTPDuplex::setDataPeer (const InetAddress &, tpport_t)
void RTPDuplex::setControlPeer (const InetAddress &, tpport_t)
size_t RTPDuplex::getNextDataPacketSize () const
SyncSource & RTPDuplex::getPeer ()

---

💜 DETAILED DESCRIPTION 💜

so… this section is literally empty in the source, bestie 😭 nothing to report. moving on, periodt 💅

---

🔥 FUNCTION DOCUMENTATION 🔥

🦋 UDPTransmit::Error RTPDuplex::connect (const InetHostAddress & host, tpport_t port = 0)

hooking this socket up to a peer, bestie 🫶

Parameters

• host — the peer address 🏠
• port — the peer port. if you don't specify it, the same as the local one gets used 👀

Returns

• the socket status ⭐

Examples

• rtpduphello.cpp. 💖 go look, it's right there.

---

🎀 size_t RTPDuplex::getNextDataPacketSize () const [inline], [protected], [virtual]

yep. this one implements IncomingDataQueue. that's the whole vibe ✨

---

💅 SyncSource & RTPDuplex::getPeer () [protected]

Returns

• the associated peer information, hand-delivered to you 👑

---

🌈 bool RTPDuplex::isPendingData (microtimeout_t timeout) [inline], [protected], [virtual]

checking if there's anything new waiting for us, we love a vibe check 🧚

Parameters

• timeout — how much time to wait for new data ⏳

Returns

• whether there is some new data 🌟

implements RTPDataQueue.

---

🍓 size_t RTPDuplex::recvData (unsigned char * buffer, size_t len, InetHostAddress & na, tpport_t & tp) [inline], [protected], [virtual]

incoming data, come through 💖

Parameters

• buffer — where to store the retrieved data 📦
• len — how many octets to read 🔢
• na — Source network address 🌐
• tp — Source transport port 🚪

Returns

• number of octets read ✨

implements IncomingDataQueue.

---

👑 RTPDuplex::RTPDuplex (const InetAddress & bind, tpport_t local, tpport_t remote)

the constructor, the main character moment 🎬

Parameters

• bind — network address this socket is to be bound to 🏡
• local — transport port this socket is to be bound to 🔌
• remote — peer transpor port 🚀

ngl that's spelled exactly how the source spells it — transpor — and we're keeping it, character for character 💀

---

⭐ size_t RTPDuplex::sendData (const unsigned char *const buffer, size_t len) [inline], [protected], [virtual]

sending it, slay 📤

Parameters

• buffer — pointer to data to be written ✍️
• len — how many octets to write 🔢

Returns

• number of octets written 💫

reimplemented from OutgoingDataQueue.

---

💜 void RTPDuplex::setControlPeer (const InetAddress &, tpport_t) [inline], [protected], [virtual]

Parameters

• — peer host network address 🌐
• — peer host RTCP transport port 🛰️

reimplemented from OutgoingDataQueue.

---

🦋 void RTPDuplex::setDataPeer (const InetAddress &, tpport_t) [inline], [protected], [virtual]

Parameters

• — peer host network address 🌐
• — peer host RTP data transport port 📡

reimplemented from OutgoingDataQueue.

---

🌸 virtual RTPDuplex::~RTPDuplex () [virtual]

the destructor. she's virtual, she's [virtual] twice, she's leaving the group chat 👋💖

---

🫶 AUTHOR 🫶

Generated automatically by Doxygen for ccRTP from the source code. so like, no human wrote this, it's a robot and honestly? she ate 🤖✨

---

aaaand that's the whole page bestie 🎀 from the ccRTP crew, rtpext(3), closing out the manual — mwah, ily, go read your headers 💜🦋