UCommon
Public Member Functions
ost::TCPV6Socket Class Reference

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

#include <tcp.h>

Inherits ost::Socket.

Public Member Functions

IPV6Host getLocal (tpport_t *port=NULL) const
 Used to get local bound address.
 
IPV6Host getRequest (tpport_t *port=NULL) const
 Return address and port of next connection request. More...
 
int getSegmentSize (void)
 
SOCKET getSocket (void)
 Fetch out the socket.
 
bool isPendingConnection (timeout_t timeout=ucommon::Timer::inf)
 Used to wait for pending connection requests. More...
 
virtual bool onAccept (const IPV6Host &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. More...
 
void reject (void)
 Used to reject the next incoming connection request.
 
 TCPV6Socket (const IPV6Address &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. More...
 
 TCPV6Socket (const char *name, unsigned backlog=5, unsigned mss=536)
 Create a TCP server for a named host interface and service port. More...
 
virtual ~TCPV6Socket ()
 Use base socket handler for ending this socket.
 

Detailed Description

TCPV6 sockets are used for stream based connected sessions between two ipv6 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 TCPV6Socket object exists in Common C++ to represent a bound ipv6 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++ TCPV6Socket 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 TCPV6Socket 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 TCPV6Socket, an accept operation automatically occurs, and the TCPV6Socket 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 217 of file tcp.h.

Constructor & Destructor Documentation

◆ TCPV6Socket() [1/2]

ost::TCPV6Socket::TCPV6Socket ( const IPV6Address 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 of streaming buffer.

◆ TCPV6Socket() [2/2]

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

Create a TCP server for a named host interface and service port.

We use [host/]port for specifying the optional host name and service port since ':' is a valid char for ipv6 addresses.

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

Member Function Documentation

◆ getRequest()

IPV6Host ost::TCPV6Socket::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 284 of file tcp.h.

◆ isPendingConnection()

bool ost::TCPV6Socket::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 305 of file tcp.h.

◆ onAccept()

virtual bool ost::TCPV6Socket::onAccept ( const IPV6Host 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.

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