Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages | Examples

TCPSocket Class Reference

TCP sockets are used for stream based connected sessions between two sockets. bound server for TCP streams and sessions. More...

#include <socket.h>

Inheritance diagram for TCPSocket:

Socket List of all members.

Public Member Functions

 TCPSocket (const IPV4Address &bind, tpport_t port, int backlog=5)
 A TCP "server" is created as a TCP socket that is bound to a hardware address and port number on the local machine and that has a backlog queue to listen for remote connection requests.
IPV4Host getRequest (tpport_t *port=NULL) const
 Return address and port of next connection request.
void reject (void)
 Used to reject the next incoming connection request.
IPV4Host getLocal (tpport_t *port=NULL) const
 Used to get local bound address.
bool isPendingConnection (timeout_t timeout=TIMEOUT_INF)
 Used to wait for pending connection requests.
virtual ~TCPSocket ()
 Use base socket handler for ending this socket.

Protected Member Functions

virtual bool onAccept (const IPV4Host &ia, tpport_t port)
 A method to call in a derived TCPSocket class that is acting as a server when a connection request is being accepted.

Friends

class TCPStream
class SocketPort
class tcpstream
class SimpleTCPStream

Detailed Description

TCP sockets are used for stream based connected sessions between two sockets. bound server for TCP streams and sessions.

Both error recovery and flow control operate transparently for a TCP socket connection. The TCP socket base class is primary used to bind a TCP "server" for accepting TCP streams.

An implicit and unique TCPSocket object exists in Common C++ to represent a bound TCP socket acting as a "server" for receiving connection requests. This class is not part of TCPStream because such objects normally perform no physical I/O (read or write operations) other than to specify a listen backlog queue and perform "accept" operations for pending connections. The Common C++ TCPSocket offers a Peek method to examine where the next pending connection is coming from, and a Reject method to flush the next request from the queue without having to create a session.

The TCPSocket also supports a "OnAccept" method which can be called when a TCPStream related object is created from a TCPSocket. By creating a TCPStream from a TCPSocket, an accept operation automatically occurs, and the TCPSocket can then still reject the client connection through the return status of it's OnAccept method.

Author:
David Sugar <dyfet@tycho.com>
Examples:

SampleSocketPort.cpp, tcp.cpp, tcpservice.cpp, tcpstr1.cpp, and tcpthread.cpp.


Constructor & Destructor Documentation

TCPSocket::TCPSocket const IPV4Address bind,
tpport_t  port,
int  backlog = 5
 

A TCP "server" is created as a TCP socket that is bound to a hardware address and port number on the local machine and that has a backlog queue to listen for remote connection requests.

If the server cannot be created, an exception is thrown.

Parameters:
bind local ip address or interface to use.
port number to bind socket under.
backlog size of connection request queue.

virtual TCPSocket::~TCPSocket  )  [inline, virtual]
 

Use base socket handler for ending this socket.


Member Function Documentation

IPV4Host TCPSocket::getLocal tpport_t port = NULL  )  const [inline]
 

Used to get local bound address.

Reimplemented from Socket.

IPV4Host TCPSocket::getRequest tpport_t port = NULL  )  const [inline]
 

Return address and port of next connection request.

This can be used instead of OnAccept() to pre-evaluate connection requests.

Returns:
host requesting a connection.
Parameters:
port number of requestor.

bool TCPSocket::isPendingConnection timeout_t  timeout = TIMEOUT_INF  )  [inline]
 

Used to wait for pending connection requests.

Returns:
true if data packets available.
Parameters:
timeout in milliseconds. TIMEOUT_INF if not specified.
Examples:
tcpstr1.cpp.

virtual bool TCPSocket::onAccept const IPV4Host ia,
tpport_t  port
[inline, protected, virtual]
 

A method to call in a derived TCPSocket class that is acting as a server when a connection request is being accepted.

The server can implement protocol specific rules to exclude the remote socket from being accepted by returning false. The Peek method can also be used for this purpose.

Returns:
true if client should be accepted.
Parameters:
ia internet host address of the client.
port number of the client.
Examples:
tcp.cpp, and tcpthread.cpp.

void TCPSocket::reject void   ) 
 

Used to reject the next incoming connection request.


Friends And Related Function Documentation

friend class SimpleTCPStream [friend]
 

friend class SocketPort [friend]
 

friend class tcpstream [friend]
 

friend class TCPStream [friend]
 


The documentation for this class was generated from the following file:
Generated on Tue Jan 18 14:32:38 2005 for GNU CommonC++ by  doxygen 1.3.9.1