OpalListenerUDP Class Reference

#include <transports.h>

Inheritance diagram for OpalListenerUDP:

OpalListenerIP OpalListener List of all members.

Public Member Functions

Construction
 OpalListenerUDP (OpalEndPoint &endpoint, PIPSocket::Address binding=PIPSocket::GetDefaultIpAny(), WORD port=0, BOOL exclusive=TRUE)
 ~OpalListenerUDP ()
Overrides from OpalListener
virtual BOOL Open (const PNotifier &acceptHandler, BOOL singleThread=TRUE)
virtual BOOL IsOpen ()
virtual void Close ()
virtual OpalTransportAccept (const PTimeInterval &timeout)

Protected Member Functions

virtual const char * GetProtoPrefix () const
BOOL OpenOneSocket (const PIPSocket::Address &address)

Protected Attributes

PSocketList listeners

Constructor & Destructor Documentation

OpalListenerUDP::OpalListenerUDP ( OpalEndPoint endpoint,
PIPSocket::Address  binding = PIPSocket::GetDefaultIpAny(),
WORD  port = 0,
BOOL  exclusive = TRUE 
)

Create a new listener.

Parameters:
endpoint  Endpoint listener is used for
binding  Local interface to listen on
port  TCP port to listen for connections

OpalListenerUDP::~OpalListenerUDP (  ) 

Destroy the listener thread.


Member Function Documentation

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

Accept a new incoming transport.

Parameters:
timeout  Time to wait for incoming connection

Implements OpalListener.

virtual void OpalListenerUDP::Close (  )  [virtual]

Stop the listener thread and no longer accept incoming connections.

Implements OpalListener.

virtual const char* OpalListenerUDP::GetProtoPrefix (  )  const [protected, virtual]

Implements OpalListenerIP.

virtual BOOL OpalListenerUDP::IsOpen (  )  [virtual]

Indicate if the listener is open.

Implements OpalListener.

virtual BOOL OpalListenerUDP::Open ( const PNotifier &  acceptHandler,
BOOL  singleThread = TRUE 
) [virtual]

Open the listener. Listen for an incoming connection and create a OpalTransport of the appropriate subclass.

If notifier function acceptHandler is non-NULL a thread is spawned to listen for incoming connections. The 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 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.

If acceptHandler is NULL, then no thread is started and it is assumed that the caller is responsible for calling Accept() and waiting for the new connection.

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

Implements OpalListener.

BOOL OpalListenerUDP::OpenOneSocket ( const PIPSocket::Address &  address  )  [protected]


Member Data Documentation

PSocketList OpalListenerUDP::listeners [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