UCommon
ost::TCPSocket Class Reference

TCP sockets are used for stream based connected sessions between two sockets. More...

#include <tcp.h>

Inherits ost::Socket.

Public Member Functions

IPV4Host getLocal (tpport_t *port=NULL) const
 Used to get local bound address.
 
IPV4Host getRequest (tpport_t *port=NULL) const
 Return address and port of next connection request.
 
int getSegmentSize (void) const
 Get the buffer size for servers.
 
SOCKET getSocket (void) const
 Fetch out the socket.
 
bool isPendingConnection (timeout_t timeout=ucommon::Timer::inf)
 Used to wait for pending connection requests.
 
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.
 
void reject (void)
 Used to reject the next incoming connection request.
 
 TCPSocket (const char *name, unsigned backlog=5, unsigned mss=536)
 Create a named tcp socket by service and/or interface id.
 
 TCPSocket (const IPV4Address &bind, tpport_t port, unsigned backlog=5, unsigned mss=536)
 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.
 
virtual ~TCPSocket ()
 Use base socket handler for ending this socket.
 

Protected Member Functions

TCPSocketoperator= (const TCPSocket &)
 
void setSegmentSize (unsigned mss)
 
 TCPSocket (const TCPSocket &)
 

Protected Attributes

int segsize
 

Detailed Description

TCP sockets are used for stream based connected sessions between two sockets.

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.nosp@m.@tyc.nosp@m.ho.co.nosp@m.m

bound server for TCP streams and sessions.

Definition at line 91 of file tcp.h.

Constructor & Destructor Documentation

◆ TCPSocket() [1/2]

ost::TCPSocket::TCPSocket ( const IPV4Address & bind,
tpport_t port,
unsigned backlog = 5,
unsigned mss = 536 )

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
bindlocal ip address or interface to use.
portnumber to bind socket under.
backlogsize of connection request queue.
mssmaximum segment size for accepted streams.

◆ TCPSocket() [2/2]

ost::TCPSocket::TCPSocket ( const char * name,
unsigned backlog = 5,
unsigned mss = 536 )

Create a named tcp socket by service and/or interface id.

For IPV4 we use [host:]svc or [host/]svc for the string. If we have getaddrinfo, we use that to obtain the addr to bind for.

Parameters
nameof host interface and service port to bind.
backlogsize of connection request queue.
mssmaximum segment size for streaming buffers.

Member Function Documentation

◆ getLocal()

IPV4Host ost::TCPSocket::getLocal ( tpport_t * port = NULL) const
inline

Used to get local bound address.

Definition at line 173 of file tcp.h.

◆ getRequest()

IPV4Host ost::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
portnumber of requestor.

Definition at line 161 of file tcp.h.

◆ getSegmentSize()

int ost::TCPSocket::getSegmentSize ( void ) const
inline

Get the buffer size for servers.

Definition at line 123 of file tcp.h.

◆ getSocket()

SOCKET ost::TCPSocket::getSocket ( void ) const
inline

Fetch out the socket.

Definition at line 116 of file tcp.h.

◆ isPendingConnection()

bool ost::TCPSocket::isPendingConnection ( timeout_t timeout = ucommon::Timer::inf)
inline

Used to wait for pending connection requests.

Returns
true if data packets available.
Parameters
timeoutin milliseconds. TIMEOUT_INF if not specified.

Definition at line 182 of file tcp.h.

◆ onAccept()

virtual bool ost::TCPSocket::onAccept ( const IPV4Host & ia,
tpport_t port )
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
iainternet host address of the client.
portnumber of the client.

Field Documentation

◆ segsize

int ost::TCPSocket::segsize
protected

Definition at line 94 of file tcp.h.


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