Bayonne2 / Common C++ 2 Framework: SimpleTCPStream Class Reference

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.

enum Socket::Family

inherited

Enumerator
IPV4

Definition at line 122 of file socket.h.

enum Socket::Pending

inherited

Enumerator
pendingInput
pendingOutput
pendingError

Definition at line 174 of file socket.h.

enum Socket::State

protectedinherited

Enumerator
INITIAL
AVAILABLE
BOUND
CONNECTED
CONNECTING
STREAM

Definition at line 182 of file socket.h.

enum Socket::Tos

inherited

Enumerator
tosLowDelay
tosThroughput
tosReliability
tosMinCost
tosInvalid

Definition at line 165 of file socket.h.

Constructor & Destructor Documentation

SimpleTCPStream::SimpleTCPStream ( )

protected

The constructor required for "SimpleTCPStream", a more C++ style version of the SimpleTCPStream class.

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.

Parameters: server bound server tcp socket.

size of streaming input and output buffers.

SimpleTCPStream::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).

Parameters: host address of remote TCP server.

port number to connect.

size of streaming input and output buffers.

SimpleTCPStream::SimpleTCPStream ( const SimpleTCPStream & source )

A copy constructor creates a new stream buffer.

Parameters: source A reference to the SimpleTCPStream to copy.

virtual SimpleTCPStream::~SimpleTCPStream ( )

virtual

Flush and empty all buffers, and then remove the allocated buffers.

Member Function Documentation

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 SimpleTCPStream::Connect ( const IPV4Host & host,

tpport_t port,

size_t size

)

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.

size of streaming input and output buffers.

Error Socket::connectError ( void )

protectedinherited

Used as a common handler for connection failure processing.

Returns: correct failure code to apply.

Error Socket::drop ( const IPV4Multicast & ia )

protectedinherited

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 SimpleTCPStream::endStream ( void )

protected

Used to terminate the buffer space and cleanup the socket connection.

This fucntion is called by the destructor.

Error Socket::error ( Error error,

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.

void SimpleTCPStream::flush ( )

inline

Definition at line 2042 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.

IPV4Host Socket::getIPV4Local ( tpport_t * port = NULL ) const

inherited

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.

IPV4Host Socket::getIPV4NAT ( tpport_t * port = NULL ) const

inherited

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.

IPV4Host Socket::getIPV4Peer ( tpport_t * port = NULL ) const

inherited

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.

virtual IPV4Host Socket::getIPV4Sender ( tpport_t * port = NULL ) const

virtualinherited

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.

IPV4Host Socket::getLocal ( tpport_t * port = NULL ) const

inlineinherited

Definition at line 539 of file socket.h.

IPV4Host Socket::getNAT ( tpport_t * port ) const

inlineinherited

Definition at line 575 of file socket.h.

IPV4Host Socket::getPeer ( tpport_t * port = NULL ) const

inlineinherited

Definition at line 523 of file socket.h.

IPV4Host SimpleTCPStream::getSender ( tpport_t * port ) const

private

long Socket::getSystemError ( void ) const

inlineinherited

Definition at line 678 of file socket.h.

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 SimpleTCPStream::isPending ( Pending pend,

timeout_t timeout = TIMEOUT_INF

)

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.

Parameters: pend Flag indicating means to pend.

timeout The length of time to wait.

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.

Error Socket::join ( const IPV4Multicast & ia )

protectedinherited

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.

ssize_t 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.

Parameters: 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.

Returns: The number of bytes pending on the input queue, 0 on EOF.

ssize_t SimpleTCPStream::read ( char * bytes,

size_t length,

timeout_t timeout = 0

)

Read bytes into a buffer.

<long-description>

Parameters: 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.

Returns: The number of bytes actually read, 0 on EOF.

virtual ssize_t Socket::readData ( void * buf,

size_t len,

char separator = 0,

timeout_t t = 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,

timeout_t timeout = 0

)

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

Set thr receive limit.

Error Socket::receiveTimeout ( timeout_t timer )

protectedinherited

Receive timeout for receiving raw network data.

Returns: errSuccess if set.

Parameters: timer value in milliseconds.

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 limit.

Error Socket::sendTimeout ( timeout_t timer )

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,

Family family = IPV4

)

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,

Family family = IPV4

)

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.

Error Socket::setTimeToLiveByFamily ( unsigned char ttl,

Family fam = IPV4

)

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.

ssize_t SimpleTCPStream::write ( const char * bytes,

size_t length,

timeout_t timeout = 0

)

Write bytes to buffer.

<long-description>

Parameters: 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.

Returns: The number of bytes actually written.

virtual ssize_t Socket::writeData ( const void * buf,

size_t len,

timeout_t t = 0

)

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.

Field Documentation

bool Socket::broadcast

inherited

Definition at line 206 of file socket.h.

bool Socket::completion

inherited

Definition at line 211 of file socket.h.

struct { ... } Socket::flags

bool Socket::keepalive

inherited

Definition at line 208 of file socket.h.

bool Socket::linger

inherited

Definition at line 212 of file socket.h.

bool Socket::loopback

inherited

Definition at line 209 of file socket.h.

bool Socket::multicast

inherited

Definition at line 210 of file socket.h.

Mutex Socket::mutex

staticprotectedinherited

Definition at line 202 of file socket.h.

bool Socket::route

inherited

Definition at line 207 of file socket.h.

SOCKET volatile Socket::so

protectedinherited

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

Definition at line 222 of file socket.h.

bool Socket::thrown

inherited

Definition at line 205 of file socket.h.

unsigned Socket::ttl

inherited

Definition at line 213 of file socket.h.

The documentation for this class was generated from the following file:

socket.h

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