|
Bayonne2 / Common C++ 2 Framework
|
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
Bayonne2 / Common C++ 2 Framework
|
The Socket is used as the base for all Internet protocol services under Common C++. More...
#include <socket.h>
Public Types | |
| enum | Family { IPV4 = AF_INET } |
| 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 } |
| enum | Tos { tosLowDelay = 0, tosThroughput, tosReliability, tosMinCost, tosInvalid } |
| enum | Pending { pendingInput, pendingOutput, pendingError } |
| typedef enum Family | Family |
| typedef enum Error | Error |
| typedef enum Tos | Tos |
| typedef enum Pending | Pending |
Public Member Functions | |
| 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 |
| 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 |
| 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 |
| IPV4Host | getIPV4NAT (tpport_t *port=NULL) const |
| Perform NAT table lookup for this socket. More... | |
| IPV4Host | getNAT (tpport_t *port) 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... | |
Static Public Member Functions | |
| static bool | check (Family fam) |
| See if a specific protocol family is available in the current runtime environment. More... | |
Protected Types | |
| enum | State { INITIAL, AVAILABLE, BOUND, CONNECTED, CONNECTING, STREAM } |
| typedef enum State | State |
Protected Member Functions | |
| 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 | drop (const IPV4Multicast &ia) |
| Drop membership from a multicast group. More... | |
| 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... | |
Protected Attributes | |
| 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 |
Static Protected Attributes | |
| static Mutex | mutex |
Private Member Functions | |
| void | setSocket (void) |
Private Attributes | |
| Error | errid |
| const char * | errstr |
| long | syserr |
Friends | |
| SOCKET | dupSocket (SOCKET s, Socket::State state) |
The Socket is used as the base for all Internet protocol services under Common C++.
A socket is a system resource (or winsock descriptor) that occupies a specific port address (and may be bound to a specific network interface) on the local machine. The socket may also be directly connected to a specific socket on a remote internet host.
This base class is not directly used, but is provided to offer properties common to other Common C++ socket classes, including the socket exception model and the ability to set socket properties such as QoS, "sockopts" properties like Dont-Route and Keep-Alive, etc.
| typedef enum Error Socket::Error |
| typedef enum Family Socket::Family |
| typedef enum Pending Socket::Pending |
|
protected |
| typedef enum Tos Socket::Tos |
| enum Socket::Error |
| enum Socket::Family |
| enum Socket::Pending |
|
protected |
| enum Socket::Tos |
|
protected |
An unconnected socket may be created directly on the local machine.
Sockets can occupy both the internet domain (AF_INET) and UNIX socket domain (AF_UNIX) under unix. The socket type (SOCK_STREAM, SOCK_DGRAM) and protocol may also be specified. If the socket cannot be created, an exception is thrown.
| domain | socket domain to use. |
| type | base type and protocol family of the socket. |
| protocol | specific protocol to apply. |
|
protected |
A socket object may be created from a file descriptor when that descriptor was created either through a socket() or accept() call.
This constructor is mostly for internal use.
| fd | file descriptor of an already existing socket. |
|
protected |
Create an inactive socket object for base constructors.
|
protected |
A socket can also be constructed from an already existing Socket object.
On POSIX systems, the socket file descriptor is dup()'d. On Win32, DuplicateHandle() is used.
| source | of existing socket to clone. |
|
virtual |
The socket base class may be "thrown" as a result of an error, and the "catcher" may then choose to destroy the object.
By assuring the socket base class is a virtual destructor, we can assure the full object is properly terminated.
|
protected |
Set the total protocol stack network kernel buffer size for both send and receive together.
| size | of buffer. |
|
static |
See if a specific protocol family is available in the current runtime environment.
|
protected |
Used as a common handler for connection failure processing.
|
protected |
Drop membership from a multicast group.
| ia | address of multicast group to drop. |
|
protected |
Used as the default destructor for ending a socket.
This will cleanly terminate the socket connection. It is provided for use in derived virtual destructors.
This service is used to throw all socket errors which usually occur during the socket constructor.
| error | defined socket error id. |
| err | string or message to pass. |
| systemError | the system error# that caused the error |
|
inlineprotected |
|
inline |
|
inline |
Get the local address and port number this socket is currently bound to.
| port | ptr to port number on local host. |
Perform NAT table lookup for this socket.
Used to allow an application to know the original ip:port pair the the client "thinks" it is connecting to. Used mostly to transparently impersonate a remote server/service.
On error, 0.0.0.0:0 is returned and one of the following error codes is set: errServiceUnavailable - if nat is not supported on the current platform or if it was not compiled; errLookupFail - if the nat syscall failed for some reason (extended error code); errSearchErr - if the socket does not have nat information (i.e. is not nated).
NAT lookup is supported on NetFilter for ipv4 and ipv6 (Linux), IPFilter for ipv4 (Solaris, *BSD except OpenBSD, HP-UX, etc.) and Packet Filter for ipv4 and ipv6 (OpenBSD). When using IPFilter or Packet Filter, the first NAT lookup must be performed as root (the NAT device is read only for root and is opened once, unless an error occurs). Permissions on the nat device may be changed to solve this.
| port | ptr to NATed port number on local host. |
Get the host address and port of the socket this socket is connected to.
If the socket is currently not in a connected state, then a host address of 0.0.0.0 is returned.
| port | ptr to port number of remote socket. |
May be used to examine the origin of data waiting in the socket receive queue.
This can tell a TCP server where pending "connect" requests are coming from, or a UDP socket where it's next packet arrived from.
| port | ptr to port number of sender. |
Reimplemented in DCCPSocket.
| const char* Socket::getSystemErrorString | ( | void | ) | const |
| bool Socket::isActive | ( | void | ) | const |
Test to see if the socket is at least operating or if it is mearly initialized.
"initialized" sockets may be the result of failed constructors.
|
inline |
| bool Socket::isConnected | ( | void | ) | const |
|
virtual |
Get the status of pending operations.
This can be used to examine if input or output is waiting, or if an error has occured on the descriptor.
| pend | ready check to perform. |
| timeout | in milliseconds, inf. if not specified. |
Reimplemented in SimpleTCPStream, TCPStream, and UnixStream.
|
inline |
|
protected |
Join a multicast group.
| ia | address of multicast group to join. |
| bool Socket::operator! | ( | ) | const |
Operator based testing to see if a socket is currently active.
Sockets may also be duplicated by the assignment operator.
|
protectedvirtual |
Read in a block of len bytes with specific separator.
Can be zero, or any other char. If \n or \r, it's treated just like a readLine(). Otherwise it looks for the separator.
| buf | pointer to byte allocation. |
| len | maximum length to read. |
| separator | separator for a particular ASCII character |
| t | timeout for pending data in milliseconds. |
|
protected |
Process a logical input line from a socket descriptor directly.
| buf | pointer to string. |
| len | maximum length to read. |
| timeout | for pending data in milliseconds. |
|
protected |
Set the protocol stack network kernel receive buffer size associated with the socket.
| size | of buffer in bytes. |
|
protected |
Set thr receive limit.
Receive timeout for receiving raw network data.
| timer | value in milliseconds. |
|
protected |
Set the protocol stack network kernel send buffer size associated with the socket.
| size | of buffer in bytes. |
|
protected |
Set the send limit.
Set the send timeout for sending raw network data.
| timer | value in millisec. |
|
protected |
Set the subnet broadcast flag for the socket.
This enables sending to a subnet and may require special image privileges depending on the operating system.
| enable | when set to true. |
| void Socket::setCompletion | ( | bool | immediate | ) |
Used to specify blocking mode for the socket.
A socket can be made non-blocking by setting setCompletion(false) or set to block on all access with setCompletion(true). I do not believe this form of non-blocking socket I/O is supported in winsock, though it provides an alternate asynchronous set of socket services.
| immediate | mode specify socket I/O call blocking mode. |
|
inlineprotected |
| Error Socket::setKeepAlive | ( | bool | enable | ) |
Set the keep-alive status of this socket and if keep-alive messages will be sent.
| enable | keep alive messages. |
| Error Socket::setLinger | ( | bool | linger | ) |
Enable lingering sockets on close.
| linger | specify linger enable. |
Set the multicast loopback flag for the socket.
Loopback enables a socket to hear what it is sending.
| enable | when set to true. |
| family | of protocol. |
Setting multicast binds the multicast interface used for the socket to the interface the socket itself has been implicitly bound to.
It is also used as a check flag to make sure multicast is enabled before multicast operations are used.
| enable | when set to true. |
| family | of protocol. |
|
protected |
Enable/disable delaying packets (Nagle algorithm)
| enable | disable Nagle algorithm when set to true. |
|
protected |
Set the socket routing to indicate if outgoing messages should bypass normal routing (set false).
| enable | normal routing when set to true. |
|
private |
Set the multicast time to live for a multicast socket.
| ttl | time to live. |
| fam | family of protocol. |
Set packet scheduling on platforms which support ip quality of service conventions.
This effects how packets in the queue are scheduled through the interface.
| service | type of service enumerated type. |
|
protectedvirtual |
Write a block of len bytes to socket.
| buf | pointer to byte allocation. |
| len | maximum length to write. |
| t | timeout for pending data in milliseconds. |
|
friend |
| struct { ... } Socket::flags |
|
protected |
1.8.6