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=((void *) 0)) const
 Used to get local bound address.
 
IPV6Host getRequest (tpport_t *port=((void *) 0)) 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.
 

Additional Inherited Members

- Protected Types inherited from ost::Socket
typedef enum Error Error
 
enum  Error {
  errSuccess = 0, errCreateFailed, errCopyFailed, errInput,
  errInputInterrupt, errResourceFailure, errOutput, errOutputInterrupt,
  errNotConnected, errConnectRefused, errConnectRejected, errConnectTimeout,
  errConnectFailed, errConnectInvalid, errConnectBusy, errConnectNoRoute,
  errBindingFailed, errBroadcastDenied, errRoutingDenied, errKeepaliveDenied,
  errServiceDenied, errServiceUnavailable, errMulticastDisabled, errTimeout,
  errNoDelay, errExtended, errLookupFail, errSearchErr,
  errInvalidValue
}
 
typedef enum Family Family
 
enum  Family { IPV6 = 1, IPV4 = 2 }
 
typedef enum Pending Pending
 
enum  Pending { pendingInput, pendingOutput, pendingError }
 
typedef enum State State
 
enum  State {
  INITIAL, AVAILABLE, BOUND, CONNECTED,
  CONNECTING, STREAM
}
 
typedef enum Tos Tos
 
enum  Tos {
  tosLowDelay = 0, tosThroughput, tosReliability, tosMinCost,
  tosInvalid
}
 
- Protected Types inherited from ucommon::Socket
typedef cidr cidr_t
 
typedef struct hostaddr_internet host_t
 
- Protected Member Functions inherited from ost::Socket
Error bufferSize (unsigned size)
 Set the total protocol stack network kernel buffer size for both send and receive together. More...
 
Error connectError (void) const
 Used as a common handler for connection failure processing. More...
 
Error drop (const ucommon::Socket::address &ia, int iface=0)
 Drop membership from a multicast group. More...
 
Error drop (const IPV4Multicast &ia)
 
Error drop (const IPV6Multicast &ia, int iface=0)
 
void endSocket (void)
 Used as the default destructor for ending a socket. More...
 
Error error (Error error, const char *err=((void *) 0), long systemError=0) const
 This service is used to throw all socket errors which usually occur during the socket constructor. More...
 
void error (const char *err) const
 This service is used to throw application defined socket errors where the application specific error code is a string. More...
 
Error join (const ucommon::Socket::address &ia, int iface=0)
 Join a multicast group. More...
 
Error join (const IPV4Multicast &ia)
 
Error join (const IPV6Multicast &ia, int iface=0)
 
virtual ssize_t readData (void *buf, size_t len, char separator=0, timeout_t t=0)
 Read in a block of len bytes with specific separator. More...
 
ssize_t readLine (char *buf, size_t len, timeout_t timeout=0)
 Process a logical input line from a socket descriptor directly. More...
 
Error receiveBuffer (unsigned size)
 Set the protocol stack network kernel receive buffer size associated with the socket. More...
 
Error receiveLimit (int limit=1)
 Set thr receive limit.
 
Error receiveTimeout (timeout_t timer)
 Receive timeout for receiving raw network data. More...
 
Error sendBuffer (unsigned size)
 Set the protocol stack network kernel send buffer size associated with the socket. More...
 
Error sendLimit (int limit=2048)
 Set the send limit.
 
Error sendTimeout (timeout_t timer)
 Set the send timeout for sending raw network data. More...
 
Error setBroadcast (bool enable)
 Set the subnet broadcast flag for the socket. More...
 
void setError (bool enable)
 This service is used to turn the error handler on or off for "throwing" exceptions by manipulating the thrown flag. More...
 
Error setLoopbackByFamily (bool enable, Family family=IPV4)
 Set the multicast loopback flag for the socket. More...
 
Error setMulticastByFamily (bool enable, Family family=IPV4)
 Setting multicast binds the multicast interface used for the socket to the interface the socket itself has been implicitly bound to. More...
 
Error setNoDelay (bool enable)
 Enable/disable delaying packets (Nagle algorithm) More...
 
Error setRouting (bool enable)
 Set the socket routing to indicate if outgoing messages should bypass normal routing (set false). More...
 
Error setTimeToLiveByFamily (uint8_t ttl, Family fam=IPV4)
 Set the multicast time to live for a multicast socket. More...
 
 Socket (int domain, int type, int protocol=0)
 An unconnected socket may be created directly on the local machine. More...
 
 Socket (socket_t fd)
 A socket object may be created from a file descriptor when that descriptor was created either through a socket() or accept() call. More...
 
 Socket ()
 Create an inactive socket object for base constructors.
 
 Socket (const Socket &source)
 A socket can also be constructed from an already existing Socket object. More...
 
virtual ssize_t writeData (const void *buf, size_t len, timeout_t t=0)
 Write a block of len bytes to socket. More...
 
struct in_addr getaddress (const IPV4Address &ia) const
 
struct in6_addr getaddress (const IPV6Address &ia) const
 
Error getErrorNumber (void) const
 Often used by a "catch" to fetch the last error of a thrown socket. More...
 
const char * getErrorString (void) const
 Often used by a "catch" to fetch the user set error string of a thrown socket, but only if EXTENDED error codes are used. More...
 
IPV4Host getIPV4Local (in_port_t *port=((void *) 0)) const
 Get the local address and port number this socket is currently bound to. More...
 
IPV4Host getIPV4Peer (in_port_t *port=((void *) 0)) const
 
virtual IPV4Host getIPV4Sender (in_port_t *port=((void *) 0)) const
 
IPV6Host getIPV6Local (in_port_t *port=((void *) 0)) const
 
IPV6Host getIPV6Peer (in_port_t *port=((void *) 0)) const
 
virtual IPV6Host getIPV6Sender (in_port_t *port=((void *) 0)) const
 
IPV4Host getLocal (in_port_t *port) const
 
ucommon::Socket::address getLocal () const
 
ucommon::Socket::address getPeer () const
 Get the host address and port of the socket this socket is connected to. More...
 
IPV4Host getPeer (in_port_t *port) const
 
ucommon::Socket::address getSender () const
 May be used to examine the origin of data waiting in the socket receive queue. More...
 
IPV4Host getSender (in_port_t *port) const
 
long getSystemError (void) const
 
const char * getSystemErrorString (void) const
 
bool isActive (void) const
 Test to see if the socket is at least operating or if it is mearly initialized. More...
 
bool isBroadcast (void) const
 Return if broadcast has been enabled for the specified socket. More...
 
bool isConnected (void) const
 Can test to see if this socket is "connected", and hence whether a "catch" can safely call getPeer(). More...
 
virtual bool isPending (Pending pend, timeout_t timeout=ucommon::Timer::inf)
 Get the status of pending operations. More...
 
bool isRouted (void) const
 Return if socket routing is enabled. More...
 
 operator bool () const
 
bool operator! () const
 Operator based testing to see if a socket is currently active.
 
Socket & operator= (const Socket &from)
 Sockets may also be duplicated by the assignment operator.
 
void setCompletion (bool immediate)
 Used to specify blocking mode for the socket. More...
 
Error setKeepAlive (bool enable)
 Set the keep-alive status of this socket and if keep-alive messages will be sent. More...
 
Error setLinger (bool linger)
 Enable lingering sockets on close. More...
 
Error setTypeOfService (Tos service)
 Set packet scheduling on platforms which support ip quality of service conventions. More...
 
- Protected Member Functions inherited from ucommon::Socket
int blocking (bool enable)
 Set socket blocking I/O mode. More...
 
int broadcast (bool enable)
 Set socket for unicast mode broadcasts. More...
 
void cancel (void)
 Cancel pending i/o by shutting down the socket.
 
bool ccid (uint8_t id)
 Set ccid of dccp socket. More...
 
bool connected (void) const
 Test if socket is connected. More...
 
int connectto (struct addrinfo *list)
 Connect our socket to a remote host from an address list. More...
 
int disconnect (void)
 Disconnect a connected socket. More...
 
int drop (const struct addrinfo *list, const int ifindex=0)
 Drop socket from multicast group. More...
 
int err (void) const
 Get error code.
 
int getError (void) const
 Get socket error code. More...
 
bool is_pending (unsigned value)
 See the number of bytes in the receive queue. More...
 
int join (const struct addrinfo *list, const int ifindex=0)
 Join socket to multicast group. More...
 
int keepalive (bool enable)
 Set socket for keepalive packets. More...
 
int loopback (bool enable)
 Set loopback to read multicast packets we broadcast. More...
 
int multicast (unsigned ttl=1)
 Set multicast mode and multicast broadcast range. More...
 
int nodelay (void) const
 Set nodelay option for tcp socket. More...
 
 operator bool () const
 Test if socket is valid. More...
 
 operator socket_t () const
 Get the socket descriptor by casting. More...
 
bool operator! () const
 Test if socket is invalid. More...
 
socket_t operator* () const
 Get the socket descriptor by pointer reference. More...
 
Socketoperator= (socket_t socket)
 Assign socket from a socket descriptor. More...
 
size_t peek (void *data, size_t number) const
 Peek at data waiting in the socket receive buffer. More...
 
unsigned pending (void) const
 Get the number of bytes of data in the socket receive buffer. More...
 
size_t printf (const char *format,...)
 Print formatted string to socket. More...
 
int priority (int scheduling)
 Set packet priority, 0 to 6 unless privileged. More...
 
size_t readfrom (void *data, size_t number, struct sockaddr_storage *address=((void *) 0))
 Read data from the socket receive buffer. More...
 
size_t readline (char *data, size_t size)
 Read a newline of text data from the socket and save in NULL terminated string. More...
 
size_t readline (String &buffer)
 Read a string of input from the socket and strip trailing newline. More...
 
stringref_t readline (size_t maxsize)
 
int recvsize (unsigned size)
 Set the size of the socket receive buffer. More...
 
void release (void)
 Shutdown and close the socket.
 
unsigned segsize (unsigned size)
 Set segment size and get mtu of a socket. More...
 
int sendsize (unsigned size)
 Set the size of the socket send buffer. More...
 
int sendwait (unsigned size)
 Set the size to wait before sending. More...
 
void shutdown (void)
 Shutdown the socket communication channel.
 
 Socket ()
 Create a socket object for use.
 
 Socket (const Socket &existing)
 Create socket as duped handle of existing socket. More...
 
 Socket (socket_t socket)
 Create socket from existing socket descriptor. More...
 
 Socket (const struct addrinfo *address)
 Create and connect a socket to an address from an address list. More...
 
 Socket (int family, int type, int protocol=0)
 Create an unbound socket of a specific type. More...
 
 Socket (const char *address, const char *port, int family=0, int type=0, int protocol=0)
 Create a bound socket. More...
 
int tos (int type)
 Set the type of service field of outgoing packets. More...
 
int ttl (uint8_t time)
 Set the time to live before packets expire. More...
 
int type (void) const
 Get the type of a socket. More...
 
bool wait (timeout_t timeout=0) const
 Test for pending input data. More...
 
int wait (timeout_t timeout=Timer::inf)
 Socket i/o timer setting. More...
 
bool waitSending (timeout_t timeout=0) const
 Test for output data sent. More...
 
size_t writes (const char *string)
 Write a null terminated string to the socket. More...
 
size_t writeto (const void *data, size_t number, const struct sockaddr *address=((void *) 0))
 Write data to the socket send buffer. More...
 
virtual ~Socket ()
 Shutdown, close, and destroy socket.
 
- Static Protected Member Functions inherited from ost::Socket
static socket_t dupSocket (socket_t s, Socket::State state)
 
static bool check (Family fam)
 See if a specific protocol family is available in the current runtime environment. More...
 
- Static Protected Member Functions inherited from ucommon::Socket
static socket_t acceptfrom (socket_t socket, struct sockaddr_storage *address=((void *) 0))
 Accept a socket connection from a remote host. More...
 
static int bindto (socket_t socket, const char *address, const char *service, int protocol=0)
 Bind the socket descriptor to a known interface and service port. More...
 
static int bindto (socket_t socket, const struct sockaddr *address)
 Bind the socket descriptor to a known interface. More...
 
static int blocking (socket_t socket, bool enable)
 Set socket blocking I/O mode of socket descriptor. More...
 
static int broadcast (socket_t socket, bool enable)
 Set socket for unicast mode broadcasts on socket descriptor. More...
 
static void cancel (socket_t socket)
 Cancel pending i/o by shutting down the socket. More...
 
static bool ccid (socket_t socket, uint8_t id)
 Set congestion control id. More...
 
static int connectto (socket_t socket, struct addrinfo *list)
 Connect socket descriptor to a remote host from an address list. More...
 
static unsigned copy (struct sockaddr *target, const struct sockaddr *origin)
 Copy a socket address. More...
 
static socket_t create (int family, int type, int protocol)
 Create a socket object unbound. More...
 
static socket_t create (const struct addrinfo *address, int type, int protocol)
 Create a connected socket. More...
 
static socket_t create (const char *iface, const char *service, int family=0, int type=0, int protocol=0)
 Create a bound socket for a service. More...
 
static socket_t create (const Socket::address &address)
 Create a connected socket for a service. More...
 
static int disconnect (socket_t socket)
 Disconnect a connected socket descriptor. More...
 
static int drop (socket_t socket, const struct addrinfo *list, const int ifindex=0)
 Drop socket descriptor from multicast group. More...
 
static bool eq_from (const struct sockaddr_storage *address1, const struct sockaddr_storage *address2)
 Compare socket addresses. More...
 
static bool eq_host (const struct sockaddr *address1, const struct sockaddr *address2)
 Compare socket host addresses. More...
 
static bool eq_inet (const struct sockaddr_internet *address1, const struct sockaddr_internet *address2)
 Compare socket addresses. More...
 
static bool eq_subnet (const struct sockaddr *address1, const struct sockaddr *address2)
 See if both addresses are in the same subnet. More...
 
static bool equal (const struct sockaddr *address1, const struct sockaddr *address2)
 Compare socket addresses. More...
 
static int error (const socket_t socket)
 Get socket error code of socket descriptor. More...
 
static int error (void)
 Return error code of last socket operation,. More...
 
static int family (socket_t socket)
 Get the address family of the socket descriptor. More...
 
static int family (const struct sockaddr_storage &address)
 Get the address family of a socket address object. More...
 
static int family (const struct sockaddr_internet &address)
 Get the address family of an internet socket address object. More...
 
static struct addrinfohinting (socket_t socket, struct addrinfo *hint)
 Create an address info lookup hint based on the family and type properties of a socket descriptor. More...
 
static char * hostname (const struct sockaddr *address, char *buffer, size_t size)
 Lookup and return the host name associated with a socket address. More...
 
static void init (void)
 Initialize socket subsystem.
 
static bool is_null (const char *string)
 Simple function to validate that a given IP address string is a "zero" address. More...
 
static bool is_numeric (const char *string)
 Simple function to validate that a given IP address string is a numeric address. More...
 
static int join (socket_t socket, const struct addrinfo *list, const int ifindex=0)
 Join socket descriptor to multicast group. More...
 
static int keepalive (socket_t socket, bool enable)
 Set socket for keepalive packets for socket descriptor. More...
 
static unsigned keyhost (const struct sockaddr *address, unsigned size)
 Convert a socket host address into a hash map index. More...
 
static unsigned keyindex (const struct sockaddr *address, unsigned size)
 Convert a socket address and service into a hash map index. More...
 
static socklen_t len (const struct sockaddr *address)
 Get the size of a socket address. More...
 
static int listento (socket_t socket, const struct sockaddr *address, int backlog=5)
 Bind the socket descriptor to a known interface listen on service port. More...
 
static int local (socket_t socket, struct sockaddr_storage *address)
 Get local address to which the socket is bound. More...
 
static int loopback (socket_t socket, bool enable)
 Set loopback to read multicast packets socket descriptor broadcasts. More...
 
static int multicast (socket_t socket, unsigned ttl=1)
 Set multicast mode and multicast broadcast range for socket descriptor. More...
 
static int nodelay (socket_t socket)
 Set tcp nodelay option on socket descriptor. More...
 
static unsigned pending (socket_t socket)
 Get the number of bytes pending in the receive buffer of a socket descriptor. More...
 
static in_port_t port (const struct sockaddr *address)
 Get the service port of a socket. More...
 
static in_port_t port (const struct sockaddr_internet *address)
 Get the service port of an inet socket. More...
 
static ssize_t printf (socket_t socket, const char *format,...)
 Print formatted string to socket. More...
 
static int priority (socket_t socket, int scheduling)
 Set packet priority of socket descriptor. More...
 
static struct addrinfoquery (const char *host, const char *service, int type=SOCK_STREAM, int protocol=0)
 Get an address list directly. More...
 
static socklen_t query (socket_t socket, struct sockaddr_storage *address, const char *hostname, const char *service)
 Lookup a host name and service address based on the addressing family and socket type of a socket descriptor. More...
 
static char * query (const struct sockaddr *address, char *buffer, socklen_t size)
 Get the hostname of a socket address. More...
 
static void query (int family)
 Set default socket family preference for query options when the socket type is otherwise not specified. More...
 
static ssize_t readline (socket_t socket, char *data, size_t size, timeout_t timeout=Timer::inf)
 Read a newline of text data from the socket and save in NULL terminated string. More...
 
static ssize_t recvfrom (socket_t socket, void *buffer, size_t size, int flags=0, struct sockaddr_storage *address=((void *) 0))
 Get data waiting in receive queue. More...
 
static int recvsize (socket_t socket, unsigned size)
 Set the receive size of a socket descriptor. More...
 
static void release (struct addrinfo *list)
 Release an address list directly. More...
 
static void release (socket_t socket)
 Release (close) a socket. More...
 
static int remote (socket_t socket, struct sockaddr_storage *address)
 Get remote address to which the socket is connected. More...
 
static ssize_t replyto (socket_t socket, const void *buffer, size_t size, int flags, const struct sockaddr_storage *address)
 Send reply on socket. More...
 
static unsigned segsize (socket_t socket, unsigned size=0)
 Set segment size and get MTU. More...
 
static int sendsize (socket_t socket, unsigned size)
 Set the send size of a socket descriptor. More...
 
static ssize_t sendto (socket_t socket, const void *buffer, size_t size, int flags=0, const struct sockaddr *address=((void *) 0))
 Send data on socket. More...
 
static int sendwait (socket_t socket, unsigned size)
 Set the size to wait before sending. More...
 
static unsigned store (struct sockaddr_storage *storage, const struct sockaddr *address)
 Store an address into an address object. More...
 
static unsigned store (struct sockaddr_internet *storage, const struct sockaddr *address)
 Store an address into an internet address object. More...
 
static int tos (socket_t socket, int type)
 Set type of service of socket descriptor. More...
 
static int ttl (socket_t socket, uint8_t time)
 Set the time to live for the socket descriptor. More...
 
static int type (const socket_t socket)
 Get the type of a socket. More...
 
static void v4mapping (bool enable)
 Set the default socket behavior for v6-v4 mapping. More...
 
static int via (struct sockaddr *address, const struct sockaddr *target, socklen_t size=0)
 Get the socket address of the interface needed to reach a destination address. More...
 
static bool wait (socket_t socket, timeout_t timeout=0)
 Test for pending input data. More...
 
- Protected Attributes inherited from ost::Socket
struct {
   bool   broadcast: 1
 
   bool   completion: 1
 
   bool   keepalive: 1
 
   bool   linger: 1
 
   bool   loopback: 1
 
   bool   multicast: 1
 
   bool   route: 1
 
   bool   thrown: 1
 
   unsigned   ttl: 8
 
flags
 
State volatile state
 
- Protected Attributes inherited from ucommon::Socket
int ioerr
 
timeout_t iowait
 
socket_t so
 

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

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.
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

IPV6Host ost::TCPV6Socket::getRequest ( tpport_t *  port = ((void*)0)) 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.

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.

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: