Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Class Members | File Members

PTCPSocket Class Reference

#include <tcpsock.h>

Inheritance diagram for PTCPSocket:

PIPSocket PSocket PChannel PObject PSocksSocket PTelnetSocket PSocks4Socket PSocks5Socket List of all members.

Public Member Functions

virtual BOOL Read (void *buf, PINDEX len)
Construction.
 PTCPSocket (WORD port=0)
 PTCPSocket (const PString &service)
 PTCPSocket (const PString &address, WORD port)
 PTCPSocket (const PString &address, const PString &service)
 PTCPSocket (PSocket &socket)
 PTCPSocket (PTCPSocket &tcpSocket)
Overrides from class PObject.
virtual PObjectClone () const
Overrides from class PChannel.
virtual BOOL Write (const void *buf, PINDEX len)
Overrides from class PSocket.
virtual BOOL Listen (unsigned queueSize=5, WORD port=0, Reusability reuse=AddressIsExclusive)
virtual BOOL Listen (const Address &bind, unsigned queueSize=5, WORD port=0, Reusability reuse=AddressIsExclusive)
virtual BOOL Accept (PSocket &socket)
New functions for class.
virtual BOOL WriteOutOfBand (const void *buf, PINDEX len)
virtual void OnOutOfBand (const void *buf, PINDEX len)

Protected Member Functions

virtual BOOL OpenSocket ()
virtual BOOL OpenSocket (int ipAdressFamily)
virtual const char * GetProtocolName () const

Detailed Description

A socket that uses the TCP transport on the Internet Protocol.


Constructor & Destructor Documentation

PTCPSocket::PTCPSocket WORD  port = 0  ) 
 

Create a TCP/IP protocol socket channel. If a remote machine address or a "listening" socket is specified then the channel is also opened.

Note that what looks like a "copy" constructor here is really a the accept of a "listening" socket the same as the PSocket & parameter version constructor.

Parameters:
port  Port number to use for the connection.

PTCPSocket::PTCPSocket const PString service  ) 
 

Parameters:
service  Service name to use for the connection.

PTCPSocket::PTCPSocket const PString address,
WORD  port
 

Parameters:
port  Address of remote machine to connect to. Port number to use for the connection.

PTCPSocket::PTCPSocket const PString address,
const PString service
 

Parameters:
service  Address of remote machine to connect to. Service name to use for the connection.

PTCPSocket::PTCPSocket PSocket socket  ) 
 

Parameters:
socket  Listening socket making the connection.

PTCPSocket::PTCPSocket PTCPSocket tcpSocket  ) 
 

Parameters:
tcpSocket  Listening socket making the connection.


Member Function Documentation

virtual BOOL PTCPSocket::Accept PSocket socket  )  [virtual]
 

Open a socket to a remote host on the specified port number. This is an "accepting" socket. When a "listening" socket has a pending connection to make, this will accept a connection made by the "connecting" socket created to establish a link.

The port that the socket uses is the one used in the Listen()# command of the socket# parameter.

Note that this function will block until a remote system connects to the port number specified in the "listening" socket.

Returns:
TRUE if the channel was successfully opened.
Parameters:
socket  Listening socket making the connection.

Reimplemented from PSocket.

Reimplemented in PSocksSocket, and PTelnetSocket.

virtual PObject* PTCPSocket::Clone  )  const [virtual]
 

Create a copy of the class on the heap. The exact semantics of the descendent class determine what is required to make a duplicate of the instance. Not all classes can even { do} a clone operation.

The main user of the clone function is the PDictionary# class as it requires copies of the dictionary keys.

The default behaviour is for this function to assert.

Returns:
pointer to new copy of the class instance.

Reimplemented from PObject.

Reimplemented in PSocks4Socket, and PSocks5Socket.

virtual const char* PTCPSocket::GetProtocolName  )  const [protected, virtual]
 

This function returns the protocol name for the socket type.

Implements PSocket.

virtual BOOL PTCPSocket::Listen const Address &  bind,
unsigned  queueSize = 5,
WORD  port = 0,
Reusability  reuse = AddressIsExclusive
[virtual]
 

Parameters:
queueSize  Local interface address to bind to.
port  Number of pending accepts that may be queued.
reuse  Port number to use for the connection. Can/Can't listen more than once.

virtual BOOL PTCPSocket::Listen unsigned  queueSize = 5,
WORD  port = 0,
Reusability  reuse = AddressIsExclusive
[virtual]
 

Listen on a socket for a remote host on the specified port number. This may be used for server based applications. A "connecting" socket begins a connection by initiating a connection to this socket. An active socket of this type is then used to generate other "accepting" sockets which establish a two way communications channel with the "connecting" socket.

If the port# parameter is zero then the port number as defined by the object instance construction or the PIPSocket::SetPort()# function.

Returns:
TRUE if the channel was successfully opened.
Parameters:
port  Number of pending accepts that may be queued.
reuse  Port number to use for the connection. Can/Can't listen more than once.

Reimplemented from PIPSocket.

Reimplemented in PSocksSocket.

virtual void PTCPSocket::OnOutOfBand const void *  buf,
PINDEX  len
[virtual]
 

This is callback function called by the system whenever out of band data from the TCP/IP stream is received. A descendent class may interpret this data according to the semantics of the high level protocol.

The default behaviour is for the out of band data to be ignored.

Parameters:
len  Data to be received as URGENT TCP data. Number of bytes pointed to by buf#.

Reimplemented in PTelnetSocket.

virtual BOOL PTCPSocket::OpenSocket int  ipAdressFamily  )  [protected, virtual]
 

Implements PIPSocket.

virtual BOOL PTCPSocket::OpenSocket  )  [protected, virtual]
 

Implements PSocket.

virtual BOOL PTCPSocket::Read void *  buf,
PINDEX  len
[virtual]
 

Low level read from the channel. This function may block until the requested number of characters were read or the read timeout was reached. The GetLastReadCount() function returns the actual number of bytes read.

The GetErrorCode() function should be consulted after Read() returns FALSE to determine what caused the failure.

Returns:
TRUE indicates that at least one character was read from the channel. FALSE means no bytes were read due to timeout or some other I/O error.

Reimplemented from PSocket.

Reimplemented in PTelnetSocket.

virtual BOOL PTCPSocket::Write const void *  buf,
PINDEX  len
[virtual]
 

Low level write to the channel. This function will block until the requested number of characters are written or the write timeout is reached. The GetLastWriteCount() function returns the actual number of bytes written.

The GetErrorCode() function should be consulted after Write() returns FALSE to determine what caused the failure.

This override repeatedly writes if there is no error until all of the requested bytes have been written.

Returns:
TRUE if at least len bytes were written to the channel.
Parameters:
len  Pointer to a block of memory to write. Number of bytes to write.

Reimplemented from PChannel.

Reimplemented in PTelnetSocket.

virtual BOOL PTCPSocket::WriteOutOfBand const void *  buf,
PINDEX  len
[virtual]
 

Write out of band data from the TCP/IP stream. This data is sent as TCP URGENT data which does not follow the usual stream sequencing of the normal channel data.

This is subject to the write timeout and sets the lastWriteCount# member variable in the same way as usual PChannel::Write()# function.

Returns:
TRUE if all the bytes were sucessfully written.
Parameters:
len  Data to be written as URGENT TCP data. Number of bytes pointed to by buf#.


The documentation for this class was generated from the following file:
Generated on Wed Sep 28 10:27:37 2005 for PWLib by  doxygen 1.4.4