RTPSessionPool(3)

💖 RTPSessionPool(3) — bestie edition 💖

okay so this is a page from the Library Functions Manual, and the star of the show is RTPSessionPool. pull up a chair, grab a boba, we're doing this 🧋✨

---

✨ NAME ✨

RTPSessionPool — this class is a base class for classes that define a group of RTP sessions that will be served by one or more execution threads. it's giving "manager of a whole friend group" energy fr 💅

---

🦋 SYNOPSIS 🦋

#include <pool.h>

Inherits RTPSessionBaseHandler.

Inherited by SingleRTPSessionPool.

🌸 Public Member Functions 🌸

• RTPSessionPool ()
• virtual ~RTPSessionPool ()
• bool addSession (RTPSessionBase &session)
• bool removeSession (RTPSessionBase &session)
• size_t getPoolLength () const
• virtual void startRunning ()=0
• bool isActive ()

🫶 Public Member Functions inherited from RTPSessionBaseHandler 🫶

• microtimeout_t getSchedulingTimeout (RTPSessionBase &s)
• timeval getRTCPCheckInterval (RTPSessionBase &s)
• size_t takeInDataPacket (RTPSessionBase &s)
• size_t dispatchDataPacket (RTPSessionBase &s)
• void controlReceptionService (RTPSessionBase &s)
• void controlTransmissionService (RTPSessionBase &s)
• SOCKET getDataRecvSocket (RTPSessionBase &s) const
• SOCKET getControlRecvSocket (RTPSessionBase &s) const

🎀 Protected Types 🎀

• typedef std::list< SessionListElement * >::iterator PoolIterator

💜 Protected Member Functions 💜

• void setActive ()
• timeval getPoolTimeout ()
• void setPoolTimeout (int sec, int usec)
• void setPoolTimeout (struct timeval to)

🌈 Protected Attributes 🌈

• std::list< SessionListElement * > sessionList
• ThreadLock poolLock
• fd_set recvSocketSet
• SOCKET highestSocket

---

👑 DETAILED DESCRIPTION 👑

This class is a base class for classes that define a group of RTP sessions that will be served by one or more execution threads.

Derived classes are responsible for serving each RTP session with a thread at least. (yes, at least — the bar is on the floor but it's there, no cap)

In order to use the RTP session 'pool' you just have to build RTPSessionBase objects for each RTP session (instead of RTPSession objects). Then, add the RTPSessionBase objects to an RTP session 'pool' and call startRunning() method of the session pool. that's it, that's the whole recipe, slay 🔥

⭐ Author ⭐

• Federico Montesino Pouzols fedemp@altern.org

---

🧚 MEMBER TYPEDEF DOCUMENTATION 🧚

typedef std::list<SessionListElement*>::iterator RTPSessionPool::PoolIterator [protected]

it's a typedef, it's protected, it's an iterator over a std::list of SessionListElement*. iconic behavior honestly.

---

💅 CONSTRUCTOR & DESTRUCTOR DOCUMENTATION 💅

• RTPSessionPool::RTPSessionPool ()
• virtual RTPSessionPool::~RTPSessionPool () [inline], [virtual]

---

🌸 MEMBER FUNCTION DOCUMENTATION 🌸

• bool RTPSessionPool::addSession (RTPSessionBase & session)
• size_t RTPSessionPool::getPoolLength () const
• timeval RTPSessionPool::getPoolTimeout () [inline], [protected]
• bool RTPSessionPool::isActive () [inline]
• bool RTPSessionPool::removeSession (RTPSessionBase & session)
• void RTPSessionPool::setActive () [inline], [protected]
• void RTPSessionPool::setPoolTimeout (int sec, int usec) [inline], [protected]
• void RTPSessionPool::setPoolTimeout (struct timeval to) [inline], [protected]
• virtual void RTPSessionPool::startRunning () [pure virtual]

Implemented in SingleRTPSessionPool.

---

🍓 MEMBER DATA DOCUMENTATION 🍓

• SOCKET RTPSessionPool::highestSocket [protected]
• ThreadLock RTPSessionPool::poolLock [mutable], [protected]
• fd_set RTPSessionPool::recvSocketSet [protected]
• std::list<SessionListElement*> RTPSessionPool::sessionList [protected]

---

🦋 AUTHOR 🦋

Generated automatically by Doxygen for ccRTP from the source code.

---

and that's the whole page bestie, no notes, you ate 💖 mwah! this lil manual page came from ccRTP and it's dated RTPSessionPool(3) — see you in the next one, love u, bye! 🎀✨