Bayonne2 / Common C++ 2 Framework
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
SingleRTPSessionPool Class Reference

#include <pool.h>

Inheritance diagram for SingleRTPSessionPool:
Inheritance graph
[legend]
Collaboration diagram for SingleRTPSessionPool:
Collaboration graph
[legend]

Public Types

enum  Throw { throwNothing, throwObject, throwException }
 How to raise error. More...
 
typedef enum Thread::Throw Throw
 How to raise error. More...
 
enum  Cancel {
  cancelInitial =0, cancelDeferred =1, cancelImmediate, cancelDisabled,
  cancelManual, cancelDefault =cancelDeferred
}
 How work cancellation. More...
 
typedef enum Thread::Cancel Cancel
 How work cancellation. More...
 
enum  Suspend { suspendEnable, suspendDisable }
 How work suspend. More...
 
typedef enum Thread::Suspend Suspend
 How work suspend. More...
 

Public Member Functions

 SingleRTPSessionPool (int pri=0)
 
 ~SingleRTPSessionPool ()
 
void startRunning ()
 
bool addSession (RTPSessionBase &session)
 
bool removeSession (RTPSessionBase &session)
 
size_t getPoolLength () const
 
bool isActive ()
 
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
 
int start (Semaphore *start=0)
 When a new thread is created, it does not begin immediate execution. More...
 
int detach (Semaphore *start=0)
 Start a new thread as "detached". More...
 
ThreadgetParent (void)
 Gets the pointer to the Thread class which created the current thread object. More...
 
void suspend (void)
 Suspends execution of the selected thread. More...
 
void resume (void)
 Resumes execution of the selected thread. More...
 
Cancel getCancel (void)
 Used to retrieve the cancellation mode in effect for the selected thread. More...
 
bool isRunning (void) const
 Verifies if the thread is still running or has already been terminated but not yet deleted. More...
 
bool isDetached (void) const
 Check if this thread is detached. More...
 
void join (void)
 Blocking call which unlocks when thread terminates. More...
 
bool isThread (void) const
 Tests to see if the current execution context is the same as the specified thread object. More...
 
cctid_t getId (void) const
 Get system thread numeric identifier. More...
 
const char * getName (void) const
 Get the name string for this thread, to use in debug messages. More...
 

Static Public Member Functions

static Threadget (void)
 
static void setStack (size_t size=0)
 Set base stack limit before manual stack sizes have effect. More...
 
static void sleep (timeout_t msec)
 A thread-safe sleep call. More...
 
static void yield (void)
 Yields the current thread's CPU time slice to allow another thread to begin immediate execution. More...
 
static Throw getException (void)
 Get exception mode of the current thread. More...
 
static void setException (Throw mode)
 Set exception mode of the current thread. More...
 
static Cancel enterCancel (void)
 This is used to help build wrapper functions in libraries around system calls that should behave as cancellation points but don't. More...
 
static void exitCancel (Cancel cancel)
 This is used to restore a cancel block. More...
 

Protected Types

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

Protected Member Functions

void run ()
 Runnable method for the thread. More...
 
void setActive ()
 
timeval getPoolTimeout ()
 
void setPoolTimeout (int sec, int usec)
 
void setPoolTimeout (struct timeval to)
 
void setName (const char *text)
 Set the name of the current thread. More...
 
virtual void final (void)
 A thread that is self terminating, either by invoking exit() or leaving it's run(), will have this method called. More...
 
virtual void initial (void)
 The initial method is called by a newly created thread when it starts execution. More...
 
virtual void * getExtended (void)
 Since getParent() and getThread() only refer to an object of the Thread "base" type, this virtual method can be replaced in a derived class with something that returns data specific to the derived class that can still be accessed through the pointer returned by getParent() and getThread(). More...
 
virtual void notify (Thread *)
 When a thread terminates, it now sends a notification message to the parent thread which created it. More...
 
void exit (void)
 Used to properly exit from a Thread derived run() or initial() method. More...
 
void sync (void)
 Used to wait for a join or cancel, in place of explicit exit. More...
 
bool testCancel (void)
 test a cancellation point for deferred thread cancellation. More...
 
void setCancel (Cancel mode)
 Sets thread cancellation mode. More...
 
void setSuspend (Suspend mode)
 Sets the thread's ability to be suspended from execution. More...
 
void terminate (void)
 Used by another thread to terminate the current thread. More...
 
void clrParent (void)
 clear parent thread relationship. More...
 

Protected Attributes

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

Detailed Description

Definition at line 208 of file pool.h.

Member Typedef Documentation

typedef enum Thread::Cancel Thread::Cancel
inherited

How work cancellation.

typedef std::list<SessionListElement*>::iterator RTPSessionPool::PoolIterator
protectedinherited

Definition at line 193 of file pool.h.

typedef enum Thread::Suspend Thread::Suspend
inherited

How work suspend.

typedef enum Thread::Throw Thread::Throw
inherited

How to raise error.

Member Enumeration Documentation

enum Thread::Cancel
inherited

How work cancellation.

Enumerator
cancelInitial 

used internally, do not use

cancelDeferred 

exit thread on cancellation pointsuch as yield

cancelImmediate 

exit befor cancellation

cancelDisabled 

ignore cancellation

cancelManual 

unimplemented (working in progress)

Todo:
implement
cancelDefault 

default you should use this for compatibility instead of deferred

Definition at line 1108 of file thread.h.

enum Thread::Suspend
inherited

How work suspend.

Enumerator
suspendEnable 

suspend enabled

suspendDisable 

suspend disabled, Suspend do nothing

Definition at line 1122 of file thread.h.

enum Thread::Throw
inherited

How to raise error.

Enumerator
throwNothing 

continue without throwing error

throwObject 

throw object that cause error (throw this)

throwException 

throw an object relative to error

Definition at line 1099 of file thread.h.

Constructor & Destructor Documentation

SingleRTPSessionPool::SingleRTPSessionPool ( int  pri = 0)
inline
Parameters
prioptional thread priority value.

Definition at line 216 of file pool.h.

SingleRTPSessionPool::~SingleRTPSessionPool ( )
inline

Definition at line 221 of file pool.h.

Member Function Documentation

bool RTPSessionPool::addSession ( RTPSessionBase session)
inherited
void Thread::clrParent ( void  )
inlineprotectedinherited

clear parent thread relationship.

Definition at line 1295 of file thread.h.

void RTPSessionBaseHandler::controlReceptionService ( RTPSessionBase s)
inlineinherited

Definition at line 74 of file pool.h.

void RTPSessionBaseHandler::controlTransmissionService ( RTPSessionBase s)
inlineinherited

Definition at line 78 of file pool.h.

int Thread::detach ( Semaphore start = 0)
inherited

Start a new thread as "detached".

This is an alternative start() method that resolves some issues with later glibc implimentations which incorrectly impliment self-detach.

Returns
error code if execution fails.
Parameters
startoptional starting semaphore to alternately use.
size_t RTPSessionBaseHandler::dispatchDataPacket ( RTPSessionBase s)
inlineinherited

Definition at line 70 of file pool.h.

static Cancel Thread::enterCancel ( void  )
staticinherited

This is used to help build wrapper functions in libraries around system calls that should behave as cancellation points but don't.

Returns
saved cancel type.
void Thread::exit ( void  )
protectedinherited

Used to properly exit from a Thread derived run() or initial() method.

Terminates execution of the current thread and calls the derived classes final() method.

static void Thread::exitCancel ( Cancel  cancel)
staticinherited

This is used to restore a cancel block.

Parameters
canceltype that was saved.
virtual void Thread::final ( void  )
protectedvirtualinherited

A thread that is self terminating, either by invoking exit() or leaving it's run(), will have this method called.

It can be used to self delete the current object assuming the object was created with new on the heap rather than stack local, hence one may often see final defined as "delete this" in a derived thread class. A final method, while running, cannot be terminated or cancelled by another thread. Final is called for all cancellation type (even immediate).

You can safe delete thread ("delete this") class on final, but you should exit ASAP (or do not try to call CommonC++ methods...)

Note
A thread cannot delete its own context or join itself. To make a thread that is a self running object that self-deletes, one has to detach the thread by using detach() instead of start().
See Also
exit
run

Reimplemented in ThreadQueue.

static Thread* Thread::get ( void  )
staticinherited
Cancel Thread::getCancel ( void  )
inlineinherited

Used to retrieve the cancellation mode in effect for the selected thread.

Returns
cancellation mode constant.

Definition at line 1419 of file thread.h.

SOCKET RTPSessionBaseHandler::getControlRecvSocket ( RTPSessionBase s) const
inlineinherited

Definition at line 84 of file pool.h.

SOCKET RTPSessionBaseHandler::getDataRecvSocket ( RTPSessionBase s) const
inlineinherited

Definition at line 81 of file pool.h.

static Throw Thread::getException ( void  )
staticinherited

Get exception mode of the current thread.

Returns
exception mode.
virtual void* Thread::getExtended ( void  )
protectedvirtualinherited

Since getParent() and getThread() only refer to an object of the Thread "base" type, this virtual method can be replaced in a derived class with something that returns data specific to the derived class that can still be accessed through the pointer returned by getParent() and getThread().

Returns
pointer to derived class specific data.
cctid_t Thread::getId ( void  ) const
inherited

Get system thread numeric identifier.

Returns
numeric identifier of this thread.
const char* Thread::getName ( void  ) const
inlineinherited

Get the name string for this thread, to use in debug messages.

Returns
debug name.

Definition at line 1463 of file thread.h.

Thread* Thread::getParent ( void  )
inlineinherited

Gets the pointer to the Thread class which created the current thread object.

Returns
a Thread *, or "(Thread *)this" if no parent.

Definition at line 1397 of file thread.h.

size_t RTPSessionPool::getPoolLength ( ) const
inherited
timeval RTPSessionPool::getPoolTimeout ( )
inlineprotectedinherited

Definition at line 183 of file pool.h.

timeval RTPSessionBaseHandler::getRTCPCheckInterval ( RTPSessionBase s)
inlineinherited

Definition at line 62 of file pool.h.

microtimeout_t RTPSessionBaseHandler::getSchedulingTimeout ( RTPSessionBase s)
inlineinherited

Definition at line 59 of file pool.h.

virtual void Thread::initial ( void  )
protectedvirtualinherited

The initial method is called by a newly created thread when it starts execution.

This method is ran with deferred cancellation disabled by default. The Initial method is given a separate handler so that it can create temporary objects on it's own stack frame, rather than having objects created on run() that are only needed by startup and yet continue to consume stack space.

See Also
run
final

Reimplemented in TCPSession, and UnixSession.

bool RTPSessionPool::isActive ( void  )
inlineinherited

Definition at line 176 of file pool.h.

bool Thread::isDetached ( void  ) const
inherited

Check if this thread is detached.

Returns
true if the thread is detached.
bool Thread::isRunning ( void  ) const
inherited

Verifies if the thread is still running or has already been terminated but not yet deleted.

Returns
true if the thread is still executing.
bool Thread::isThread ( void  ) const
inherited

Tests to see if the current execution context is the same as the specified thread object.

Returns
true if the current context is this object.
void Thread::join ( void  )
inherited

Blocking call which unlocks when thread terminates.

virtual void Thread::notify ( Thread )
protectedvirtualinherited

When a thread terminates, it now sends a notification message to the parent thread which created it.

The actual use of this notification is left to be defined in a derived class.

Parameters
-the thread that has terminated.
bool RTPSessionPool::removeSession ( RTPSessionBase session)
inherited
void Thread::resume ( void  )
inherited

Resumes execution of the selected thread.

void SingleRTPSessionPool::run ( )
protectedvirtual

Runnable method for the thread.

This thread serves all the RTP sessions.added to this pool.

Implements Thread.

void RTPSessionPool::setActive ( )
inlineprotectedinherited

Definition at line 180 of file pool.h.

void Thread::setCancel ( Cancel  mode)
protectedinherited

Sets thread cancellation mode.

Threads can either be set immune to termination (cancelDisabled), can be set to terminate when reaching specific "thread cancellation points" (cancelDeferred) or immediately when Terminate is requested (cancelImmediate).

Parameters
modefor cancellation of the current thread.
static void Thread::setException ( Throw  mode)
staticinherited

Set exception mode of the current thread.

Returns
exception mode.
void Thread::setName ( const char *  text)
protectedinherited

Set the name of the current thread.

If the name is passed as NULL, then the default name is set (usually object pointer).

Parameters
textname to use.
void RTPSessionPool::setPoolTimeout ( int  sec,
int  usec 
)
inlineprotectedinherited

Definition at line 186 of file pool.h.

void RTPSessionPool::setPoolTimeout ( struct timeval  to)
inlineprotectedinherited

Definition at line 189 of file pool.h.

static void Thread::setStack ( size_t  size = 0)
inlinestaticinherited

Set base stack limit before manual stack sizes have effect.

Parameters
sizestack size to set, or use 0 to clear autostack.

Definition at line 1347 of file thread.h.

void Thread::setSuspend ( Suspend  mode)
protectedinherited

Sets the thread's ability to be suspended from execution.

The thread may either have suspend enabled (suspendEnable) or disabled (suspendDisable).

Parameters
modefor suspend.
static void Thread::sleep ( timeout_t  msec)
staticinherited

A thread-safe sleep call.

On most Posix systems, "sleep()" is implimented with SIGALRM making it unusable from multipe threads. Pthread libraries often define an alternate "sleep" handler such as usleep(), nanosleep(), or nap(), that is thread safe, and also offers a higher timer resolution.

Parameters
msectimeout in milliseconds.
int Thread::start ( Semaphore start = 0)
inherited

When a new thread is created, it does not begin immediate execution.

This is because the derived class virtual tables are not properly loaded at the time the C++ object is created within the constructor itself, at least in some compiler/system combinations. The thread can either be told to wait for an external semaphore, or it can be started directly after the constructor completes by calling the start() method.

Returns
error code if execution fails.
Parameters
startoptional starting semaphore to alternately use.
void SingleRTPSessionPool::startRunning ( )
inlinevirtual

Implements RTPSessionPool.

Definition at line 224 of file pool.h.

void Thread::suspend ( void  )
inherited

Suspends execution of the selected thread.

Pthreads do not normally support suspendable threads, so the behavior is simulated with signals. On systems such as Linux that define threads as processes, SIGSTOP and SIGCONT may be used.

void Thread::sync ( void  )
protectedinherited

Used to wait for a join or cancel, in place of explicit exit.

size_t RTPSessionBaseHandler::takeInDataPacket ( RTPSessionBase s)
inlineinherited

Definition at line 66 of file pool.h.

void Thread::terminate ( void  )
protectedinherited

Used by another thread to terminate the current thread.

Termination actually occurs based on the current setCancel() mode. When the current thread does terminate, control is returned to the requesting thread. terminate() should always be called at the start of any destructor of a class derived from Thread to assure the remaining part of the destructor is called without the thread still executing.

bool Thread::testCancel ( void  )
protectedinherited

test a cancellation point for deferred thread cancellation.

static void Thread::yield ( void  )
staticinherited

Yields the current thread's CPU time slice to allow another thread to begin immediate execution.

Field Documentation

SOCKET RTPSessionPool::highestSocket
protectedinherited

Definition at line 199 of file pool.h.

ThreadLock RTPSessionPool::poolLock
mutableprotectedinherited

Definition at line 195 of file pool.h.

fd_set RTPSessionPool::recvSocketSet
protectedinherited

Definition at line 198 of file pool.h.

std::list<SessionListElement*> RTPSessionPool::sessionList
protectedinherited

Definition at line 192 of file pool.h.


The documentation for this class was generated from the following file: