OpalListenerTCP Class Reference

`#include <transports.h>`

Inheritance diagram for OpalListenerTCP:

## Public Member Functions

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

## Protected Member Functions

virtual const char * | GetProtoPrefix () const
Protected Member Functions inherited from OpalListener
| PDECLARE_NOTIFIER (PThread, OpalListener, ListenForConnections)
PBoolean | StartThread (const PNotifier &acceptHandler, ThreadMode mode)

## Protected Attributes

PTCPSocket | listener
Protected Attributes inherited from OpalListenerIP
PIPSocket::Address | localAddress
WORD | listenerPort
PBoolean | exclusiveListener
Protected Attributes inherited from OpalListener
OpalEndPoint & | endpoint
PThread * | thread
PNotifier | acceptHandler
ThreadMode | threadMode

## Additional Inherited Members

Public Types inherited from OpalListener
enum | ThreadMode { SpawnNewThreadMode, HandOffThreadMode, SingleThreadMode }

## Constructor & Destructor Documentation

OpalListenerTCP::OpalListenerTCP | ( | OpalEndPoint & | endpoint,
|  | PIPSocket::Address | binding = `PIPSocket::GetDefaultIpAny()`,
|  | WORD | port = `0`,
|  | PBoolean | 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
  exclusive | Exclusive listening mode, no other process can accept on the port

OpalListenerTCP::OpalListenerTCP | ( | 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

OpalListenerTCP::~OpalListenerTCP | ( |  | ) |

Destroy the listener thread.

## Member Function Documentation

virtual OpalTransport* OpalListenerTCP::Accept | ( | const PTimeInterval & | timeout | ) |

virtual

Accept a new incoming transport.

Parameters

  timeout | Time to wait for incoming connection

Implements OpalListener.

virtual void OpalListenerTCP::Close | ( |  | ) |

virtual

Stop the listener thread and no longer accept incoming connections.

Implements OpalListener.

virtual OpalTransport* OpalListenerTCP::CreateTransport | ( | const OpalTransportAddress & | localAddress,
|  | const OpalTransportAddress & | remoteAddress
| ) |  | const

virtual

Create a transport compatible with this listener.

Implements OpalListener.

virtual const char* OpalListenerTCP::GetProtoPrefix | ( |  | ) | const

protected virtual

Implements OpalListenerIP.

virtual PBoolean OpalListenerTCP::IsOpen | ( |  | ) |

virtual

Indicate if the listener is open.

Implements OpalListener.

virtual PBoolean OpalListenerTCP::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 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
  mode | How handler function is called thread wise

Implements OpalListener.

## Field Documentation

PTCPSocket OpalListenerTCP::listener

protected

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

- transports.h