TCP streams are used to represent TCP client connections to a server by TCP protocol servers for accepting client connections.
More...
#include <socket.h>
Inheritance diagram for TCPStream:
Collaboration diagram for TCPStream:
Public Types
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
}
Public Member Functions
The constructor required for building other classes or to start an unconnected
TCPStream for connect.
More...
Disconnect the current session and prepare for a new one.
More...
Create a TCP stream by accepting a connection from a bound TCP socket acting as a server.
More...
Accept a connection from a TCP Server.
More...
Create a TCP stream by connecting to a TCP socket (on a remote machine).
More...
Construct a named TCP
Socket connected to a remote machine.
More...
Set the I/O operation timeout for socket I/O operations.
More...
A copy constructor creates a new stream buffer.
More...
Flush and empty all buffers, and then remove the allocated buffers.
More...
Flushes the stream input and output buffers, writes pending output.
More...
Get the status of pending stream data.
More...
ssize_t
peek (void *buf, size_t len)
Examine contents of next waiting packet.
More...
Return the size of the current stream buffering used.
More...
May be used to examine the origin of data waiting in the socket receive queue.
More...
Get the host address and port of the socket this socket is connected to.
More...
Get the local address and port number this socket is currently bound to.
More...
Perform NAT table lookup for this socket.
More...
Used to specify blocking mode for the socket.
More...
Enable lingering sockets on close.
More...
Set the keep-alive status of this socket and if keep-alive messages will be sent.
More...
Set packet scheduling on platforms which support ip quality of service conventions.
More...
Can test to see if this socket is "connected", and hence whether a "catch" can safely call
getPeer().
More...
Test to see if the socket is at least operating or if it is mearly initialized.
More...
Operator based testing to see if a socket is currently active.
More...
Return if broadcast has been enabled for the specified socket.
More...
Return if socket routing is enabled.
More...
Often used by a "catch" to fetch the last error of a thrown socket.
More...
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...
Static Public Member Functions
See if a specific protocol family is available in the current runtime environment.
More...
Protected Types
Protected Member Functions
Used to allocate the buffer space needed for iostream operations.
More...
Used to terminate the buffer space and cleanup the socket connection.
More...
This streambuf method is used to load the input buffer through the established tcp socket connection.
More...
This streambuf method is used for doing unbuffered reads through the establish tcp socket connection when in interactive mode.
More...
This streambuf method is used to write the output buffer through the established tcp connection.
More...
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...
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...
This service is used to turn the error handler on or off for "throwing" exceptions by manipulating the thrown flag.
More...
Used as the default destructor for ending a socket.
More...
Used as a common handler for connection failure processing.
More...
Set the send timeout for sending raw network data.
More...
Receive timeout for receiving raw network data.
More...
Set the protocol stack network kernel send buffer size associated with the socket.
More...
Set the protocol stack network kernel receive buffer size associated with the socket.
More...
Set the total protocol stack network kernel buffer size for both send and receive together.
More...
Set the subnet broadcast flag for the socket.
More...
Setting multicast binds the multicast interface used for the socket to the interface the socket itself has been implicitly bound to.
More...
Set the multicast loopback flag for the socket.
More...
Set the multicast time to live for a multicast socket.
More...
Drop membership from a multicast group.
More...
Set the socket routing to indicate if outgoing messages should bypass normal routing (set false).
More...
Enable/disable delaying packets (Nagle algorithm)
More...
Process a logical input line from a socket descriptor directly.
More...
Read in a block of len bytes with specific separator.
More...
Write a block of len bytes to socket.
More...
Protected Attributes
struct {
the actual socket descriptor, in Windows, unlike posix it
cannot be used as an file descriptor that way madness lies – jfc
More...
Static Protected Attributes
Private Member Functions
Friends
Detailed Description
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.
- Author
- David Sugar dyfet.nosp@m.@ost.nosp@m.el.co.nosp@m.m streamable TCP socket connection.
Definition at line 1631 of file socket.h.
Member Typedef Documentation
Member Enumeration Documentation
| Enumerator |
|---|
| errSuccess |
| 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 |
Definition at line 131 of file socket.h.
| Enumerator |
|---|
| pendingInput |
| pendingOutput |
| pendingError |
Definition at line 174 of file socket.h.
| Enumerator |
|---|
| INITIAL |
| AVAILABLE |
| BOUND |
| CONNECTED |
| CONNECTING |
| STREAM |
Definition at line 182 of file socket.h.
| Enumerator |
|---|
| tosLowDelay |
| tosThroughput |
| tosReliability |
| tosMinCost |
| tosInvalid |
Definition at line 165 of file socket.h.
Constructor & Destructor Documentation
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.
- Parameters
-
server socket listening
throwflag flag to throw errors.
timeout for all operations.
TCPStream::TCPStream
(
const
IPV4Host &
host,
unsigned
mss = 536,
bool
throwflag = true,
)
Create a TCP stream by connecting to a TCP socket (on a remote machine).
- Parameters
-
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,
unsigned
mss = 536,
bool
throwflag = false,
)
Construct a named TCP Socket connected to a remote machine.
- Parameters
-
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.
- Parameters
-
source reference of stream to copy from.
virtual TCPStream::~TCPStream
(
)
virtual |
Flush and empty all buffers, and then remove the allocated buffers.
Member Function Documentation
void TCPStream::allocate
(
size_t
size )
protected |
Used to allocate the buffer space needed for iostream operations.
This function is called by the constructor.
- Parameters
-
size of stream buffers from constructor.
Error Socket::bufferSize
(
unsigned
size )
protectedinherited |
Set the total protocol stack network kernel buffer size for both send and receive together.
- Returns
- errSuccess on success
- Parameters
-
size of buffer.
static bool Socket::check
(
Family
fam )
staticinherited |
See if a specific protocol family is available in the current runtime environment.
- Returns
- true if family available.
void TCPStream::connect
(
const
IPV4Host &
host,
unsigned
mss = 536
)
protected |
Create a TCP stream by connecting to a TCP socket (on a remote machine).
- Parameters
-
host address of remote TCP server.
port number to connect.
mss maximum segment size of streaming buffers.
void TCPStream::connect
(
const char *
name,
unsigned
mss = 536
)
protected |
Connect a TCP stream to a named destination host and port number, using getaddrinfo interface if available.
- Parameters
-
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.
- Parameters
-
server socket listening
Error Socket::connectError
(
void
)
protectedinherited |
Used as a common handler for connection failure processing.
- Returns
- correct failure code to apply.
void TCPStream::disconnect
(
void
)
Disconnect the current session and prepare for a new one.
int TCPStream::doallocate
(
)
private |
Drop membership from a multicast group.
- Returns
- 0 (errSuccess) on success, else error code.
- Parameters
-
ia address of multicast group to drop.
void Socket::endSocket
(
void
)
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.
void TCPStream::endStream
(
void
)
protected |
Used to terminate the buffer space and cleanup the socket connection.
This fucntion is called by the destructor.
const char *
err = NULL,
long
systemError = 0
)
const
protectedinherited |
This service is used to throw all socket errors which usually occur during the socket constructor.
- Parameters
-
error defined socket error id.
err string or message to pass.
systemError the system error# that caused the error
void Socket::error
(
const char *
err )
const
inlineprotectedinherited |
This service is used to throw application defined socket errors where the application specific error code is a string.
- Parameters
-
err string or message to pass.
Definition at line 240 of file socket.h.
size_t TCPStream::getBufferSize
(
void
)
const
inline |
Return the size of the current stream buffering used.
- Returns
- size of stream buffers.
Definition at line 1853 of file socket.h.
Error Socket::getErrorNumber
(
void
)
const
inlineinherited |
Often used by a "catch" to fetch the last error of a thrown socket.
- Returns
- error number of Error error.
Definition at line 668 of file socket.h.
const char* Socket::getErrorString
(
void
)
const
inlineinherited |
Often used by a "catch" to fetch the user set error string of a thrown socket, but only if EXTENDED error codes are used.
- Returns
- string for error message.
Definition at line 676 of file socket.h.
Get the local address and port number this socket is currently bound to.
- Parameters
-
port ptr to port number on local host.
- Returns
- host address of interface this socket is bound to.
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.
- Warning
- When using IPFilter and Packet Filter, application data model must be the same as the running kernel (32/64 bits).
- Parameters
-
port ptr to NATed port number on local host.
- Returns
- NATed host address that this socket is related to.
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.
- Parameters
-
port ptr to port number of remote socket.
- Returns
- host address 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.
- Parameters
-
port ptr to port number of sender.
- Returns
- host address, test with "isInetAddress()".
Reimplemented in DCCPSocket.
int TCPStream::getSegmentSize
(
void
)
Get protocol segment size.
long Socket::getSystemError
(
void
)
const
inlineinherited |
const char* Socket::getSystemErrorString
(
void
)
const
inherited |
bool Socket::isActive
(
void
)
const
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.
- Returns
- true if not in initial state.
bool Socket::isBroadcast
(
void
)
const
inlineinherited |
Return if broadcast has been enabled for the specified socket.
- Returns
- true if broadcast socket.
Definition at line 651 of file socket.h.
bool Socket::isConnected
(
void
)
const
inherited |
Can test to see if this socket is "connected", and hence whether a "catch" can safely call getPeer().
Of course, an unconnected socket will return a 0.0.0.0 address from getPeer() as well.
- Returns
- true when socket is connected to a peer.
bool TCPStream::isPending
(
Pending
pend,
)
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.
bool Socket::isRouted
(
void
)
const
inlineinherited |
Return if socket routing is enabled.
- Returns
- true if routing enabled.
Definition at line 659 of file socket.h.
Join a multicast group.
- Returns
- 0 (errSuccess) on success, else error code.
- Parameters
-
ia address of multicast group to join.
bool Socket::operator!
(
)
const
inherited |
Operator based testing to see if a socket is currently active.
int TCPStream::overflow
(
int
ch )
protected |
This streambuf method is used to write the output buffer through the established tcp connection.
- Parameters
-
ch char to push through.
- Returns
- char pushed through.
ssize_t TCPStream::peek
(
void *
buf,
size_t
len
)
inline |
Examine contents of next waiting packet.
- Parameters
-
buf pointer to packet buffer for contents.
len of packet buffer.
- Returns
- number of bytes examined.
Definition at line 1845 of file socket.h.
virtual ssize_t Socket::readData
(
void *
buf,
size_t
len,
char
separator = 0,
)
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.
- Parameters
-
buf pointer to byte allocation.
len maximum length to read.
separator separator for a particular ASCII character
t timeout for pending data in milliseconds.
- Returns
- number of bytes actually read.
ssize_t Socket::readLine
(
char *
buf,
size_t
len,
)
protectedinherited |
Process a logical input line from a socket descriptor directly.
- Parameters
-
buf pointer to string.
len maximum length to read.
timeout for pending data in milliseconds.
- Returns
- number of bytes actually read.
Error Socket::receiveBuffer
(
unsigned
size )
protectedinherited |
Set the protocol stack network kernel receive buffer size associated with the socket.
- Returns
- errSuccess on success, or error.
- Parameters
-
size of buffer in bytes.
Error Socket::receiveLimit
(
int
limit =
1 )
protectedinherited |
Receive timeout for receiving raw network data.
- Returns
- errSuccess if set.
- Parameters
-
timer value in milliseconds.
void TCPStream::segmentBuffering
(
unsigned
mss )
private |
Error Socket::sendBuffer
(
unsigned
size )
protectedinherited |
Set the protocol stack network kernel send buffer size associated with the socket.
- Returns
- errSuccess on success, or error.
- Parameters
-
size of buffer in bytes.
Error Socket::sendLimit
(
int
limit =
2048 )
protectedinherited |
Set the send timeout for sending raw network data.
- Returns
- errSuccess if set.
- Parameters
-
timer value in millisec.
Error Socket::setBroadcast
(
bool
enable )
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.
- Returns
- 0 (errSuccess) on success, else error code.
- Parameters
-
enable when set to true.
void Socket::setCompletion
(
bool
immediate )
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.
- Parameters
-
immediate mode specify socket I/O call blocking mode.
void Socket::setError
(
bool
enable )
inlineprotectedinherited |
This service is used to turn the error handler on or off for "throwing" exceptions by manipulating the thrown flag.
- Parameters
-
enable true to enable handler.
Definition at line 249 of file socket.h.
Error Socket::setKeepAlive
(
bool
enable )
inherited |
Set the keep-alive status of this socket and if keep-alive messages will be sent.
- Returns
- 0 on success.
- Parameters
-
enable keep alive messages.
Error Socket::setLinger
(
bool
linger )
inherited |
Enable lingering sockets on close.
- Parameters
-
linger specify linger enable.
Error Socket::setLoopbackByFamily
(
bool
enable,
)
protectedinherited |
Set the multicast loopback flag for the socket.
Loopback enables a socket to hear what it is sending.
- Returns
- 0 (errSuccess) on success, else error code.
- Parameters
-
enable when set to true.
family of protocol.
Error Socket::setMulticastByFamily
(
bool
enable,
)
protectedinherited |
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.
- Returns
- 0 (errSuccess) on success, else error code.
- Parameters
-
enable when set to true.
family of protocol.
Error Socket::setNoDelay
(
bool
enable )
protectedinherited |
Enable/disable delaying packets (Nagle algorithm)
- Returns
- 0 on success.
- Parameters
-
enable disable Nagle algorithm when set to true.
Error Socket::setRouting
(
bool
enable )
protectedinherited |
Set the socket routing to indicate if outgoing messages should bypass normal routing (set false).
- Returns
- 0 on success.
- Parameters
-
enable normal routing when set to true.
void TCPStream::setTimeout
(
timeout_t
timer )
inline |
Set the I/O operation timeout for socket I/O operations.
- Parameters
-
timer to change timeout.
Definition at line 1794 of file socket.h.
Error Socket::setTimeToLiveByFamily
(
unsigned char
ttl,
)
protectedinherited |
Set the multicast time to live for a multicast socket.
- Returns
- 0 (errSuccess) on success, else error code.
- Parameters
-
ttl time to live.
fam family of protocol.
Error Socket::setTypeOfService
(
Tos
service )
inherited |
Set packet scheduling on platforms which support ip quality of service conventions.
This effects how packets in the queue are scheduled through the interface.
- Returns
- 0 on success, error code on failure.
- Parameters
-
service type of service enumerated type.
int TCPStream::sync
(
void
)
Flushes the stream input and output buffers, writes pending output.
- Returns
- 0 on success.
std::iostream* TCPStream::tcp
(
void
)
inlineprotected |
Used in derived classes to refer to the current object via it's iostream.
For example, to send a set of characters in a derived method, one might use *tcp() << "test".
- Returns
- stream pointer of this object.
Definition at line 1735 of file socket.h.
int TCPStream::uflow
(
)
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.
- Returns
- char from tcp socket connection, EOF if not connected.
int TCPStream::underflow
(
)
protected |
This streambuf method is used to load the input buffer through the established tcp socket connection.
- Returns
- char from get buffer, EOF if not connected.
virtual ssize_t Socket::writeData
(
const void *
buf,
size_t
len,
)
protectedvirtualinherited |
Write a block of len bytes to socket.
- Parameters
-
buf pointer to byte allocation.
len maximum length to write.
t timeout for pending data in milliseconds.
- Returns
- number of bytes actually written.
Friends And Related Function Documentation
Field Documentation
bool Socket::broadcast
inherited |
size_t TCPStream::bufsize
protected |
bool Socket::completion
inherited |
struct { ... } Socket::flags
char* TCPStream::gbuf
protected |
bool Socket::keepalive
inherited |
bool Socket::linger
inherited |
bool Socket::loopback
inherited |
bool Socket::multicast
inherited |
char * TCPStream::pbuf
protected |
bool Socket::route
inherited |
the actual socket descriptor, in Windows, unlike posix it cannot be used as an file descriptor that way madness lies – jfc
Definition at line 221 of file socket.h.
State volatile Socket::state
protectedinherited |
bool Socket::thrown
inherited |
unsigned Socket::ttl
inherited |
The documentation for this class was generated from the following file:
Generated on Dec 21, 2017 for
commoncpp2-1.8.1,
ccrtp-1.7.2,
libzrtpcpp-2.3.4,
ccscript3-1.1.7,
ccaudio2-1.0.0 and
bayonne2-2.3.2
(after installation in /usr/local/)
by
doxygen 1.8.6