OpalTransportTCP Class Reference

#include <transports.h>

Inheritance diagram for OpalTransportTCP:

OpalTransportIP OpalTransport

List of all members.

Public Member Functions

Construction
 OpalTransportTCP (OpalEndPoint &endpoint, PIPSocket::Address binding=PIPSocket::GetDefaultIpAny(), WORD port=0, PBoolean reuseAddr=PFalse)
 OpalTransportTCP (OpalEndPoint &endpoint, PTCPSocket *socket)
 ~OpalTransportTCP ()
 Destroy the TCP channel.
Overides from class OpalTransport
virtual PBoolean IsReliable () const
virtual PBoolean IsCompatibleTransport (const OpalTransportAddress &address) const
virtual PBoolean Connect ()
virtual PBoolean ReadPDU (PBYTEArray &pdu)
virtual PBoolean WritePDU (const PBYTEArray &pdu)

Protected Member Functions

virtual const char * GetProtoPrefix () const
virtual PBoolean OnOpen ()

Protected Attributes

PBoolean reuseAddressFlag


Constructor & Destructor Documentation

OpalTransportTCP::OpalTransportTCP ( OpalEndPoint endpoint,
PIPSocket::Address  binding = PIPSocket::GetDefaultIpAny(),
WORD  port = 0,
PBoolean  reuseAddr = PFalse 
)

Create a new transport channel.

Parameters:
endpoint Endpoint object
binding Local interface to use
port Local port to bind to
reuseAddr Flag for binding to already bound interface

OpalTransportTCP::OpalTransportTCP ( OpalEndPoint endpoint,
PTCPSocket *  socket 
)

Parameters:
endpoint Endpoint object
socket Socket to use

OpalTransportTCP::~OpalTransportTCP (  ) 

Destroy the TCP channel.


Member Function Documentation

virtual PBoolean OpalTransportTCP::Connect (  )  [virtual]

Connect to the remote address.

Implements OpalTransport.

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

Get the prefix for this transports protocol type.

Implements OpalTransportIP.

virtual PBoolean OpalTransportTCP::IsCompatibleTransport ( const OpalTransportAddress address  )  const [virtual]

Check that the transport address is compatible with transport.

Implements OpalTransport.

virtual PBoolean OpalTransportTCP::IsReliable (  )  const [virtual]

Get indication of the type of underlying transport.

Implements OpalTransport.

virtual PBoolean OpalTransportTCP::OnOpen (  )  [protected, virtual]

This callback is executed when the Open() function is called with open channels. It may be used by descendent channels to do any handshaking required by the protocol that channel embodies.

The default behaviour is to simply return PTrue.

Returns:
Returns PTrue if the protocol handshaking is successful.

virtual PBoolean OpalTransportTCP::ReadPDU ( PBYTEArray &  pdu  )  [virtual]

Read a packet from the transport. This will read using the transports mechanism for PDU boundaries, for example UDP is a single Read() call, while for TCP there is a TPKT header that indicates the size of the PDU.

Parameters:
pdu PDU read from transport

Implements OpalTransport.

virtual PBoolean OpalTransportTCP::WritePDU ( const PBYTEArray &  pdu  )  [virtual]

Write a packet to the transport. This will write using the transports mechanism for PDU boundaries, for example UDP is a single Write() call, while for TCP there is a TPKT header that indicates the size of the PDU.

Parameters:
pdu Packet to write

Implements OpalTransport.


Member Data Documentation

PBoolean OpalTransportTCP::reuseAddressFlag [protected]


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

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