OpalListener Class Reference

#include <transports.h>

Inheritance diagram for OpalListener:

OpalListenerIP OpalListenerTCP OpalListenerUDP List of all members.

Public Member Functions

Construction
 OpalListener (OpalEndPoint &endpoint)
Overrides from PObject
void PrintOn (ostream &strm) const
Operations
virtual BOOL Open (const PNotifier &acceptHandler, BOOL singleThread=FALSE)=0
virtual BOOL IsOpen ()=0
virtual void Close ()=0
virtual OpalTransportAccept (const PTimeInterval &timeout)=0
virtual OpalTransportAddress GetLocalAddress (const OpalTransportAddress &preferredAddress=OpalTransportAddress()) const =0
OpalTransportAddress GetTransportAddress () const
void CloseWait ()
void CleanUpOnTermination ()

Protected Member Functions

 PDECLARE_NOTIFIER (PThread, OpalListener, ListenForConnections)
BOOL StartThread (const PNotifier &acceptHandler, BOOL singleThread)

Protected Attributes

OpalEndPointendpoint
PThread * thread
PNotifier acceptHandler
BOOL singleThread

Detailed Description

This class describes a "listener" on a transport protocol. A "listener" is an object that listens for incoming connections on the particular transport. It is executed as a separate thread.

The Main() function is used to handle incoming connections and dispatch them in new threads based on the actual OpalTransport class. This is defined in the descendent class that knows what the low level transport is, eg OpalListenerIP for the TCP/IP protocol.

An application may create a descendent off this class and override functions as required for operating the channel protocol.


Constructor & Destructor Documentation

OpalListener::OpalListener ( OpalEndPoint endpoint  ) 

Create a new listener.

Parameters:
endpoint  Endpoint listener is used for


Member Function Documentation

virtual OpalTransport* OpalListener::Accept ( const PTimeInterval &  timeout  )  [pure virtual]

Accept a new incoming transport.

Parameters:
timeout  Time to wait for incoming connection

Implemented in OpalListenerTCP, and OpalListenerUDP.

void OpalListener::CleanUpOnTermination (  )  [inline]

Close channel and wait for associated thread to terminate. For backward compatibility with OpenH323, now deprecated.

virtual void OpalListener::Close (  )  [pure virtual]

Stop the listener thread and no longer accept incoming connections.

Implemented in OpalListenerTCP, and OpalListenerUDP.

void OpalListener::CloseWait (  ) 

Close channel and wait for associated thread to terminate.

virtual OpalTransportAddress OpalListener::GetLocalAddress ( const OpalTransportAddress preferredAddress = OpalTransportAddress()  )  const [pure virtual]

Get the local transport address on which this listener may be accessed.

Implemented in OpalListenerIP.

OpalTransportAddress OpalListener::GetTransportAddress (  )  const [inline]

Get the local transport address on which this listener may be accessed. For backward compatibility with OpenH323, now deprecated.

virtual BOOL OpalListener::IsOpen (  )  [pure virtual]

Indicate if the listener is open.

Implemented in OpalListenerTCP, and OpalListenerUDP.

virtual BOOL OpalListener::Open ( const PNotifier &  acceptHandler,
BOOL  singleThread = FALSE 
) [pure virtual]

Open the listener. A thread is spawned to listen for incoming connections. The notifier function acceptHandler is called when a new connection is created. The INT parameter to the acceptHandler is a pointer to the new OpalTransport instance created by the listener. If this is NULL then it indicates an error occurred during the accept.

If singleThread is FALSE the acceptHandler function is called in the context of a new thread and the continues to listen for more connections. If TRUE, then the acceptHandler function is called from within the listener threads context and no more connections are created. That is only a single connection is ever created by this listener.

Parameters:
acceptHandler  Handler function for new connections
singleThread  If handler function called in this thread

Implemented in OpalListenerTCP, and OpalListenerUDP.

OpalListener::PDECLARE_NOTIFIER ( PThread  ,
OpalListener  ,
ListenForConnections   
) [protected]

Handle incoming connections and dispatch them in new threads based on the OpalTransport class. This is defined in the descendent class that knows what the low level transport is, eg OpalListenerTCP for the TCP/IP protocol.

Note this function does not return until the Close() function is called or there is some other error.

void OpalListener::PrintOn ( ostream &  strm  )  const

Print the description of the listener to the stream.

BOOL OpalListener::StartThread ( const PNotifier &  acceptHandler,
BOOL  singleThread 
) [protected]

Parameters:
acceptHandler  Handler function for new connections
singleThread  If handler function called in this thread


Member Data Documentation

PNotifier OpalListener::acceptHandler [protected]

OpalEndPoint& OpalListener::endpoint [protected]

BOOL OpalListener::singleThread [protected]

PThread* OpalListener::thread [protected]


The documentation for this class was generated from the following file:
Generated on Mon Sep 25 16:21:51 2006 for OPAL by  doxygen 1.4.7