GNU CommonC++
|
TCP sockets are used for stream based connected sessions between two sockets. More...
#include <socket.h>
Public 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. More... | |
SOCKET | getSocket (void) |
Fetch out the socket. More... | |
int | getSegmentSize (void) |
Get the buffer size for servers. More... | |
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. More... | |
TCPSocket (const char *name, unsigned backlog=5, unsigned mss=536) | |
Create a named tcp socket by service and/or interface id. More... | |
IPV4Host | getRequest (tpport_t *port=NULL) const |
Return address and port of next connection request. More... | |
void | reject (void) |
Used to reject the next incoming connection request. More... | |
IPV4Host | getLocal (tpport_t *port=NULL) const |
Used to get local bound address. More... | |
bool | isPendingConnection (timeout_t timeout=TIMEOUT_INF) |
Used to wait for pending connection requests. More... | |
virtual | ~TCPSocket () |
Use base socket handler for ending this socket. More... | |
Protected Member Functions | |
void | setSegmentSize (unsigned mss) |
![]() | |
Error | error (Error error, const char *err=NULL, 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... | |
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... | |
void | endSocket (void) |
Used as the default destructor for ending a socket. More... | |
Error | connectError (void) |
Used as a common handler for connection failure processing. More... | |
Error | sendLimit (int limit=2048) |
Set the send limit. More... | |
Error | receiveLimit (int limit=1) |
Set thr receive limit. More... | |
Error | sendTimeout (timeout_t timer) |
Set the send timeout for sending raw network data. More... | |
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 | receiveBuffer (unsigned size) |
Set the protocol stack network kernel receive buffer size associated with the socket. More... | |
Error | bufferSize (unsigned size) |
Set the total protocol stack network kernel buffer size for both send and receive together. More... | |
Error | setBroadcast (bool enable) |
Set the subnet broadcast 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 | setLoopbackByFamily (bool enable, Family family=IPV4) |
Set the multicast loopback flag for the socket. More... | |
Error | setTimeToLiveByFamily (unsigned char ttl, Family fam=IPV4) |
Set the multicast time to live for a multicast socket. More... | |
Error | join (const IPV4Multicast &ia) |
Join a multicast group. More... | |
Error | join (const IPV6Multicast &ia) |
Error | drop (const IPV4Multicast &ia) |
Drop membership from a multicast group. More... | |
Error | drop (const IPV6Multicast &ia) |
Error | setRouting (bool enable) |
Set the socket routing to indicate if outgoing messages should bypass normal routing (set false). More... | |
Error | setNoDelay (bool enable) |
Enable/disable delaying packets (Nagle algorithm) More... | |
Socket (int domain, int type, int protocol=0) | |
An unconnected socket may be created directly on the local machine. More... | |
Socket (SOCKET 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. More... | |
Socket (const Socket &source) | |
A socket can also be constructed from an already existing Socket object. More... | |
ssize_t | readLine (char *buf, size_t len, timeout_t timeout=0) |
Process a logical input line from a socket descriptor directly. More... | |
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... | |
virtual ssize_t | writeData (const void *buf, size_t len, timeout_t t=0) |
Write a block of len bytes to socket. More... | |
virtual | ~Socket () |
The socket base class may be "thrown" as a result of an error, and the "catcher" may then choose to destroy the object. More... | |
Socket & | operator= (const Socket &from) |
Sockets may also be duplicated by the assignment operator. More... | |
virtual IPV4Host | getIPV4Sender (tpport_t *port=NULL) const |
May be used to examine the origin of data waiting in the socket receive queue. More... | |
IPV4Host | getSender (tpport_t *port=NULL) const |
virtual IPV6Host | getIPV6Sender (tpport_t *port=NULL) const |
IPV4Host | getIPV4Peer (tpport_t *port=NULL) const |
Get the host address and port of the socket this socket is connected to. More... | |
IPV4Host | getPeer (tpport_t *port=NULL) const |
IPV6Host | getIPV6Peer (tpport_t *port=NULL) const |
IPV4Host | getIPV4Local (tpport_t *port=NULL) const |
Get the local address and port number this socket is currently bound to. More... | |
IPV4Host | getLocal (tpport_t *port=NULL) const |
IPV6Host | getIPV6Local (tpport_t *port=NULL) const |
IPV4Host | getIPV4NAT (tpport_t *port=NULL) const |
Perform NAT table lookup for this socket. More... | |
IPV4Host | getNAT (tpport_t *port) const |
IPV6Host | getIPV6NAT (tpport_t *port=NULL) const |
void | setCompletion (bool immediate) |
Used to specify blocking mode for the socket. More... | |
Error | setLinger (bool linger) |
Enable lingering sockets on close. More... | |
Error | setKeepAlive (bool enable) |
Set the keep-alive status of this socket and if keep-alive messages will be sent. More... | |
Error | setTypeOfService (Tos service) |
Set packet scheduling on platforms which support ip quality of service conventions. More... | |
bool | isConnected (void) const |
Can test to see if this socket is "connected", and hence whether a "catch" can safely call getPeer(). More... | |
bool | isActive (void) const |
Test to see if the socket is at least operating or if it is mearly initialized. More... | |
bool | operator! () const |
Operator based testing to see if a socket is currently active. More... | |
bool | isBroadcast (void) const |
Return if broadcast has been enabled for the specified socket. More... | |
bool | isRouted (void) const |
Return if socket routing is enabled. More... | |
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... | |
long | getSystemError (void) const |
const char * | getSystemErrorString (void) const |
virtual bool | isPending (Pending pend, timeout_t timeout=TIMEOUT_INF) |
Get the status of pending operations. More... | |
Protected Attributes | |
int | segsize |
![]() | |
struct { | |
bool thrown: 1 | |
bool broadcast: 1 | |
bool route: 1 | |
bool keepalive: 1 | |
bool loopback: 1 | |
bool multicast: 1 | |
bool completion: 1 | |
bool linger: 1 | |
unsigned ttl: 8 | |
} | flags |
SOCKET volatile | so |
the actual socket descriptor, in Windows, unlike posix it cannot be used as an file descriptor that way madness lies – jfc More... | |
State volatile | state |
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.
bound server for TCP streams and sessions.
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.
bind | local ip address or interface to use. |
port | number to bind socket under. |
backlog | size of connection request queue. |
mss | maximum segment size for accepted streams. |
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.
name | of host interface and service port to bind. |
backlog | size of connection request queue. |
mss | maximum segment size for streaming buffers. |
|
virtual |
Use base socket handler for ending this socket.
Used to get local bound address.
References ost::Socket::getIPV4Local().
Return address and port of next connection request.
This can be used instead of OnAccept() to pre-evaluate connection requests.
port | number of requestor. |
References ost::Socket::getIPV4Sender().
|
inline |
Get the buffer size for servers.
|
inline |
Fetch out the socket.
|
inline |
Used to wait for pending connection requests.
timeout | in milliseconds. TIMEOUT_INF if not specified. |
References ost::Socket::isPending(), and ost::Socket::pendingInput.
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.
ia | internet host address of the client. |
port | number of the client. |
void ost::TCPSocket::reject | ( | void | ) |
Used to reject the next incoming connection request.
|
protected |
|
protected |