|
Bayonne2 / Common C++ 2 Framework
|
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
Bayonne2 / Common C++ 2 Framework
|
TCP streams are used to represent TCP client connections to a server by TCP protocol servers for accepting client connections. More...
#include <socket.h>
Public Types | |
| enum | Family { IPV4 = AF_INET } |
| typedef enum Family | Family |
| 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 Error | Error |
| enum | Tos { tosLowDelay = 0, tosThroughput, tosReliability, tosMinCost, tosInvalid } |
| typedef enum Tos | Tos |
| enum | Pending { pendingInput, pendingOutput, pendingError } |
| typedef enum Pending | Pending |
Public Member Functions | |
| TCPStream (Family family=IPV4, bool throwflag=true, timeout_t to=0) | |
| The constructor required for building other classes or to start an unconnected TCPStream for connect. More... | |
| void | disconnect (void) |
| Disconnect the current session and prepare for a new one. More... | |
| int | getSegmentSize (void) |
| Get protocol segment size. More... | |
| TCPStream (TCPSocket &server, bool throwflag=true, timeout_t timeout=0) | |
| Create a TCP stream by accepting a connection from a bound TCP socket acting as a server. More... | |
| void | connect (TCPSocket &server) |
| Accept a connection from a TCP Server. More... | |
| TCPStream (const IPV4Host &host, tpport_t port, unsigned mss=536, bool throwflag=true, timeout_t timeout=0) | |
| Create a TCP stream by connecting to a TCP socket (on a remote machine). More... | |
| TCPStream (const char *name, Family family=IPV4, unsigned mss=536, bool throwflag=false, timeout_t timer=0) | |
| Construct a named TCP Socket connected to a remote machine. More... | |
| void | setTimeout (timeout_t timer) |
| Set the I/O operation timeout for socket I/O operations. More... | |
| TCPStream (const TCPStream &source) | |
| A copy constructor creates a new stream buffer. More... | |
| virtual | ~TCPStream () |
| Flush and empty all buffers, and then remove the allocated buffers. More... | |
| int | sync (void) |
| Flushes the stream input and output buffers, writes pending output. More... | |
| bool | isPending (Pending pend, timeout_t timeout=TIMEOUT_INF) |
| Get the status of pending stream data. More... | |
| ssize_t | peek (void *buf, size_t len) |
| Examine contents of next waiting packet. More... | |
| size_t | getBufferSize (void) const |
| Return the size of the current stream buffering used. 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 |
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 | |
| void | allocate (size_t size) |
| Used to allocate the buffer space needed for iostream operations. More... | |
| void | endStream (void) |
| Used to terminate the buffer space and cleanup the socket connection. More... | |
| int | underflow () |
| This streambuf method is used to load the input buffer through the established tcp socket connection. More... | |
| int | uflow () |
| This streambuf method is used for doing unbuffered reads through the establish tcp socket connection when in interactive mode. More... | |
| int | overflow (int ch) |
| This streambuf method is used to write the output buffer through the established tcp connection. More... | |
| void | connect (const IPV4Host &host, tpport_t port, unsigned mss=536) |
| Create a TCP stream by connecting to a TCP socket (on a remote machine). More... | |
| void | connect (const char *name, unsigned mss=536) |
| Connect a TCP stream to a named destination host and port number, using getaddrinfo interface if available. More... | |
| std::iostream * | tcp (void) |
| Used in derived classes to refer to the current object via it's iostream. More... | |
| 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... | |
| 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 | |
| timeout_t | timeout |
| size_t | bufsize |
| Family | family |
| char * | gbuf |
| char * | pbuf |
| 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 | |
| int | doallocate () |
| void | segmentBuffering (unsigned mss) |
Friends | |
| TCPStream & | crlf (TCPStream &) |
| TCPStream & | lfcr (TCPStream &) |
TCP streams are used to represent TCP client connections to a server by TCP protocol servers for accepting client connections.
The TCP stream is a C++ "stream" class, and can accept streaming of data to and from other C++ objects using the << and >> operators.
TCPStream itself can be formed either by connecting to a bound network address of a TCP server, or can be created when "accepting" a network connection from a TCP server.
|
inherited |
|
inherited |
|
inherited |
|
protectedinherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
protectedinherited |
|
inherited |
The constructor required for building other classes or to start an unconnected TCPStream for connect.
Create a TCP stream by accepting a connection from a bound TCP socket acting as a server.
This performs an "accept" call.
| server | socket listening |
| throwflag | flag to throw errors. |
| timeout | for all operations. |
| TCPStream::TCPStream | ( | const IPV4Host & | host, |
| tpport_t | port, | ||
| unsigned | mss = 536, |
||
| bool | throwflag = true, |
||
| timeout_t | timeout = 0 |
||
| ) |
Create a TCP stream by connecting to a TCP socket (on a remote machine).
| host | address of remote TCP server. |
| port | number to connect. |
| mss | maximum segment size of streaming buffers. |
| throwflag | flag to throw errors. |
| timeout | for all operations. |
| TCPStream::TCPStream | ( | const char * | name, |
| Family | family = IPV4, |
||
| unsigned | mss = 536, |
||
| bool | throwflag = false, |
||
| timeout_t | timer = 0 |
||
| ) |
Construct a named TCP Socket connected to a remote machine.
| name | of remote service. |
| family | of protocol. |
| mss | maximum segment size of streaming buffers. |
| throwflag | flag to throw errors. |
| timer | for timeout for all operations. |
| TCPStream::TCPStream | ( | const TCPStream & | source | ) |
A copy constructor creates a new stream buffer.
| source | reference of stream to copy from. |
|
virtual |
Flush and empty all buffers, and then remove the allocated buffers.
|
protected |
Used to allocate the buffer space needed for iostream operations.
This function is called by the constructor.
| size | of stream buffers from constructor. |
|
protectedinherited |
Set the total protocol stack network kernel buffer size for both send and receive together.
| size | of buffer. |
|
staticinherited |
See if a specific protocol family is available in the current runtime environment.
Create a TCP stream by connecting to a TCP socket (on a remote machine).
| host | address of remote TCP server. |
| port | number to connect. |
| mss | maximum segment size of streaming buffers. |
|
protected |
Connect a TCP stream to a named destination host and port number, using getaddrinfo interface if available.
| name | of host and service to connect |
| mss | maximum segment size of stream buffer |
| void TCPStream::connect | ( | TCPSocket & | server | ) |
Accept a connection from a TCP Server.
| server | socket listening |
|
protectedinherited |
Used as a common handler for connection failure processing.
| void TCPStream::disconnect | ( | void | ) |
Disconnect the current session and prepare for a new one.
|
private |
|
protectedinherited |
Drop membership from a multicast group.
| ia | address of multicast group to drop. |
|
protectedinherited |
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.
|
protected |
Used to terminate the buffer space and cleanup the socket connection.
This fucntion is called by the destructor.
|
protectedinherited |
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 |
|
inlineprotectedinherited |
|
inline |
|
inlineinherited |
|
inlineinherited |
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.
| int TCPStream::getSegmentSize | ( | void | ) |
Get protocol segment size.
|
inherited |
|
inherited |
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.
|
inlineinherited |
|
inherited |
|
virtual |
Get the status of pending stream data.
This can be used to examine if input or output is waiting, or if an error or disconnect has occured on the stream. If a read buffer contains data then input is ready and if write buffer contains data it is first flushed and then checked.
Reimplemented from Socket.
|
inlineinherited |
|
protectedinherited |
Join a multicast group.
| ia | address of multicast group to join. |
|
inherited |
Operator based testing to see if a socket is currently active.
|
protected |
This streambuf method is used to write the output buffer through the established tcp connection.
| ch | char to push through. |
|
inline |
|
protectedvirtualinherited |
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. |
|
protectedinherited |
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. |
|
protectedinherited |
Set the protocol stack network kernel receive buffer size associated with the socket.
| size | of buffer in bytes. |
|
protectedinherited |
Set thr receive limit.
Receive timeout for receiving raw network data.
| timer | value in milliseconds. |
|
private |
|
protectedinherited |
Set the protocol stack network kernel send buffer size associated with the socket.
| size | of buffer in bytes. |
|
protectedinherited |
Set the send limit.
Set the send timeout for sending raw network data.
| timer | value in millisec. |
|
protectedinherited |
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. |
|
inherited |
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. |
|
inlineprotectedinherited |
|
inherited |
Set the keep-alive status of this socket and if keep-alive messages will be sent.
| enable | keep alive messages. |
|
inherited |
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. |
|
protectedinherited |
Enable/disable delaying packets (Nagle algorithm)
| enable | disable Nagle algorithm when set to true. |
|
protectedinherited |
Set the socket routing to indicate if outgoing messages should bypass normal routing (set false).
| enable | normal routing when set to true. |
|
inline |
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. |
| int TCPStream::sync | ( | void | ) |
Flushes the stream input and output buffers, writes pending output.
|
inlineprotected |
|
protected |
This streambuf method is used for doing unbuffered reads through the establish tcp socket connection when in interactive mode.
Also this method will handle proper use of buffers if not in interative mode.
|
protected |
This streambuf method is used to load the input buffer through the established tcp socket connection.
|
protectedvirtualinherited |
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. |
| struct { ... } Socket::flags |
|
protectedinherited |
1.8.6