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, PBoolean exclusive=PTrue)
 OpalListenerUDP (OpalEndPoint &endpoint, const OpalTransportAddress &binding, OpalTransportAddress::BindOptions option)
 ~OpalListenerUDP ()
Overrides from OpalListener
virtual PBoolean Open (const PNotifier &acceptHandler, ThreadMode mode=SpawnNewThreadMode)
virtual PBoolean IsOpen ()
virtual void Close ()
virtual OpalTransportAccept (const PTimeInterval &timeout)
virtual OpalTransportCreateTransport (const OpalTransportAddress &localAddress, const OpalTransportAddress &remoteAddress) const
virtual OpalTransportAddress GetLocalAddress (const OpalTransportAddress &remoteAddress=OpalTransportAddress()) const

Protected Member Functions

virtual const char * GetProtoPrefix () const

Protected Attributes

PMonitoredSocketsPtr listenerBundle


Constructor & Destructor Documentation

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

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 ( OpalEndPoint endpoint,
const OpalTransportAddress binding,
OpalTransportAddress::BindOptions  option 
)

Parameters:
endpoint Endpoint listener is used for
binding Local interface to listen on
option OPtions for binding

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 OpalTransport* OpalListenerUDP::CreateTransport ( const OpalTransportAddress localAddress,
const OpalTransportAddress remoteAddress 
) const [virtual]

Create a transport compatible with this listener.

Implements OpalListener.

virtual OpalTransportAddress OpalListenerUDP::GetLocalAddress ( const OpalTransportAddress remoteAddress = OpalTransportAddress()  )  const [virtual]

Get the local transport address on which this listener may be accessed. If remoteAddress is present and is an address that requires NAT for connectivity, then the returned address is adjusted to return the external address and port.

Reimplemented from OpalListenerIP.

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

Implements OpalListenerIP.

virtual PBoolean OpalListenerUDP::IsOpen (  )  [virtual]

Indicate if the listener is open.

Implements OpalListener.

virtual PBoolean OpalListenerUDP::Open ( const PNotifier &  acceptHandler,
ThreadMode  mode = SpawnNewThreadMode 
) [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 PFalse the acceptHandler function is called in the context of a new thread and the continues to listen for more connections. If PTrue, 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
mode How handler function is called thread wise

Implements OpalListener.


Member Data Documentation

PMonitoredSocketsPtr OpalListenerUDP::listenerBundle [protected]


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

Generated on Tue Jul 21 02:52:18 2009 for OPAL by  doxygen 1.5.9