GNU CommonC++
|
Simple TCP Stream, to be used with Common C++ Library. More...
#include <socket.h>
Public Member Functions | |
SimpleTCPStream (TCPSocket &server, size_t size=512) | |
Create a TCP stream by accepting a connection from a bound TCP socket acting as a server. | |
SimpleTCPStream (const IPV4Host &host, tpport_t port, size_t size=512) | |
Create a TCP stream by connecting to a TCP socket (on a remote machine). | |
SimpleTCPStream (const SimpleTCPStream &source) | |
A copy constructor creates a new stream buffer. | |
virtual | ~SimpleTCPStream () |
Flush and empty all buffers, and then remove the allocated buffers. | |
bool | isPending (Pending pend, timeout_t timeout=TIMEOUT_INF) |
Get the status of pending stream data. | |
void | flush () |
ssize_t | read (char *bytes, size_t length, timeout_t timeout=0) |
Read bytes into a buffer. | |
ssize_t | write (const char *bytes, size_t length, timeout_t timeout=0) |
Write bytes to buffer. | |
ssize_t | peek (char *bytes, size_t length, timeout_t timeout=0) |
Peek at the incoming data. | |
![]() | |
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. | |
Socket & | operator= (const Socket &from) |
Sockets may also be duplicated by the assignment operator. | |
virtual IPV4Host | getIPV4Sender (tpport_t *port=NULL) const |
May be used to examine the origin of data waiting in the socket receive queue. | |
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. | |
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. | |
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. | |
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. | |
Error | setLinger (bool linger) |
Enable lingering sockets on close. | |
Error | setKeepAlive (bool enable) |
Set the keep-alive status of this socket and if keep-alive messages will be sent. | |
Error | setTypeOfService (Tos service) |
Set packet scheduling on platforms which support ip quality of service conventions. | |
bool | isConnected (void) const |
Can test to see if this socket is "connected", and hence whether a "catch" can safely call getPeer(). | |
bool | isActive (void) const |
Test to see if the socket is at least operating or if it is mearly initialized. | |
bool | operator! () const |
Operator based testing to see if a socket is currently active. | |
bool | isBroadcast (void) const |
Return if broadcast has been enabled for the specified socket. | |
bool | isRouted (void) const |
Return if socket routing is enabled. | |
Error | getErrorNumber (void) const |
Often used by a "catch" to fetch the last error of a thrown socket. | |
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. | |
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. | |
Protected Member Functions | |
SimpleTCPStream () | |
The constructor required for "SimpleTCPStream", a more C++ style version of the SimpleTCPStream class. | |
void | endStream (void) |
Used to terminate the buffer space and cleanup the socket connection. | |
void | Connect (const IPV4Host &host, tpport_t port, size_t size) |
Create a TCP stream by connecting to a TCP socket (on a remote machine). | |
![]() | |
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. | |
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. | |
void | setError (bool enable) |
This service is used to turn the error handler on or off for "throwing" exceptions by manipulating the thrown flag. | |
void | endSocket (void) |
Used as the default destructor for ending a socket. | |
Error | connectError (void) |
Used as a common handler for connection failure processing. | |
Error | sendLimit (int limit=2048) |
Set the send limit. | |
Error | receiveLimit (int limit=1) |
Set thr receive limit. | |
Error | sendTimeout (timeout_t timer) |
Set the send timeout for sending raw network data. | |
Error | receiveTimeout (timeout_t timer) |
Receive timeout for receiving raw network data. | |
Error | sendBuffer (unsigned size) |
Set the protocol stack network kernel send buffer size associated with the socket. | |
Error | receiveBuffer (unsigned size) |
Set the protocol stack network kernel receive buffer size associated with the socket. | |
Error | bufferSize (unsigned size) |
Set the total protocol stack network kernel buffer size for both send and receive together. | |
Error | setBroadcast (bool enable) |
Set the subnet broadcast flag for the socket. | |
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. | |
Error | setLoopbackByFamily (bool enable, Family family=IPV4) |
Set the multicast loopback flag for the socket. | |
Error | setTimeToLiveByFamily (unsigned char ttl, Family fam=IPV4) |
Set the multicast time to live for a multicast socket. | |
Error | join (const IPV4Multicast &ia) |
Join a multicast group. | |
Error | join (const IPV6Multicast &ia) |
Error | drop (const IPV4Multicast &ia) |
Drop membership from a multicast group. | |
Error | drop (const IPV6Multicast &ia) |
Error | setRouting (bool enable) |
Set the socket routing to indicate if outgoing messages should bypass normal routing (set false). | |
Error | setNoDelay (bool enable) |
Enable/disable delaying packets (Nagle algorithm) | |
Socket (int domain, int type, int protocol=0) | |
An unconnected socket may be created directly on the local machine. | |
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. | |
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. | |
ssize_t | readLine (char *buf, size_t len, timeout_t timeout=0) |
Process a logical input line from a socket descriptor directly. | |
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. | |
virtual ssize_t | writeData (const void *buf, size_t len, timeout_t t=0) |
Write a block of len bytes to socket. | |
Additional Inherited Members | ||
![]() | ||
enum | Family { IPV6 = AF_INET6 , 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 | |
![]() | ||
static bool | check (Family fam) | |
See if a specific protocol family is available in the current runtime environment. | ||
![]() | ||
enum | State { INITIAL , AVAILABLE , BOUND , CONNECTED , CONNECTING , STREAM } | |
typedef enum State | State | |
![]() | ||
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 | ||
State volatile | state | |
![]() | ||
static Mutex | mutex | |
Simple TCP Stream, to be used with Common C++ Library.
This source is derived from a proposal made by Ville Vainio (vvain.nosp@m.io@t.nosp@m.p.spt.nosp@m..fi).
|
protected |
The constructor required for "SimpleTCPStream", a more C++ style version of the SimpleTCPStream class.
ost::SimpleTCPStream::SimpleTCPStream | ( | TCPSocket & | server, |
size_t | size = 512 |
||
) |
Create a TCP stream by accepting a connection from a bound TCP socket acting as a server.
This performs an "accept" call.
server | bound server tcp socket. |
size | of streaming input and output buffers. |
Create a TCP stream by connecting to a TCP socket (on a remote machine).
host | address of remote TCP server. |
port | number to connect. |
size | of streaming input and output buffers. |
ost::SimpleTCPStream::SimpleTCPStream | ( | const SimpleTCPStream & | source | ) |
A copy constructor creates a new stream buffer.
source | A reference to the SimpleTCPStream to copy. |
|
virtual |
Flush and empty all buffers, and then remove the allocated buffers.
Create a TCP stream by connecting to a TCP socket (on a remote machine).
host | address of remote TCP server. |
port | number to connect. |
size | of streaming input and output buffers. |
|
protected |
Used to terminate the buffer space and cleanup the socket connection.
This fucntion is called by the destructor.
|
inline |
|
virtual |
Get the status of pending stream data.
This method 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. If write buffer contains data, it is first flushed and then checked.
pend | Flag indicating means to pend. |
timeout | The length of time to wait. |
Reimplemented from ost::Socket.
ssize_t ost::SimpleTCPStream::peek | ( | char * | bytes, |
size_t | length, | ||
timeout_t | timeout = 0 |
||
) |
Peek at the incoming data.
The data is copied into the buffer but is not removed from the input queue. The function then returns the number of bytes currently pending to receive.
bytes | A pointer to buffer that will contain the bytes read. |
length | The number of bytes to read (exactly). |
timeout | Period to time out, in milleseconds. |
ssize_t ost::SimpleTCPStream::read | ( | char * | bytes, |
size_t | length, | ||
timeout_t | timeout = 0 |
||
) |
Read bytes into a buffer.
<long-description>
bytes | A pointer to buffer that will contain the bytes read. |
length | The number of bytes to read (exactly). |
timeout | Period to time out, in milleseconds. |
ssize_t ost::SimpleTCPStream::write | ( | const char * | bytes, |
size_t | length, | ||
timeout_t | timeout = 0 |
||
) |
Write bytes to buffer.
<long-description>
bytes | A pointer to a buffer containing the bytes to write. |
length | The number of bytes to write (exactly). |
timeout | Period to time out, in milleseconds. |