OPAL  Version 3.10.10
OpalListenerIP Class Reference

#include <transports.h>

Inheritance diagram for OpalListenerIP:
OpalListener OpalListenerTCP OpalListenerUDP

Public Member Functions

Construction
 OpalListenerIP (OpalEndPoint &endpoint, PIPSocket::Address binding=PIPSocket::GetDefaultIpAny(), WORD port=0, PBoolean exclusive=true)
 OpalListenerIP (OpalEndPoint &endpoint, const OpalTransportAddress &binding, OpalTransportAddress::BindOptions option)
Overrides from OpalListener
virtual OpalTransportAddress GetLocalAddress (const OpalTransportAddress &remoteAddress=OpalTransportAddress()) const
Operations
WORD GetListenerPort () const
virtual const char * GetProtoPrefix () const =0
- Public Member Functions inherited from OpalListener
 OpalListener (OpalEndPoint &endpoint)
void PrintOn (ostream &strm) const
virtual PBoolean Open (const PNotifier &acceptHandler, ThreadMode mode=SpawnNewThreadMode)=0
virtual PBoolean IsOpen ()=0
virtual void Close ()=0
virtual OpalTransportAccept (const PTimeInterval &timeout)=0
virtual OpalTransportCreateTransport (const OpalTransportAddress &localAddress, const OpalTransportAddress &remoteAddress) const =0
void CloseWait ()
void CleanUpOnTermination ()

Protected Attributes

PIPSocket::Address localAddress
WORD listenerPort
PBoolean exclusiveListener
- Protected Attributes inherited from OpalListener
OpalEndPointendpoint
PThread * thread
PNotifier acceptHandler
ThreadMode threadMode

Additional Inherited Members

- Public Types inherited from OpalListener
enum  ThreadMode { SpawnNewThreadMode, HandOffThreadMode, SingleThreadMode }
- Protected Member Functions inherited from OpalListener
 PDECLARE_NOTIFIER (PThread, OpalListener, ListenForConnections)
PBoolean StartThread (const PNotifier &acceptHandler, ThreadMode mode)

Constructor & Destructor Documentation

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

Create a new IP listener.

Parameters
endpointEndpoint listener is used for
bindingLocal interface to listen on
portTCP port to listen for connections
exclusiveExclusive listening mode, no other process can accept on the port
OpalListenerIP::OpalListenerIP ( OpalEndPoint endpoint,
const OpalTransportAddress binding,
OpalTransportAddress::BindOptions  option 
)
Parameters
endpointEndpoint listener is used for
bindingLocal interface to listen on
optionOPtions for binding

Member Function Documentation

WORD OpalListenerIP::GetListenerPort ( ) const
inline

References listenerPort.

virtual OpalTransportAddress OpalListenerIP::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.

Implements OpalListener.

Reimplemented in OpalListenerUDP.

virtual const char* OpalListenerIP::GetProtoPrefix ( ) const
pure virtual

Implemented in OpalListenerUDP, and OpalListenerTCP.

Field Documentation

PBoolean OpalListenerIP::exclusiveListener
protected
WORD OpalListenerIP::listenerPort
protected

Referenced by GetListenerPort().

PIPSocket::Address OpalListenerIP::localAddress
protected

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