GNU CommonC++
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
ost::TCPStream Class Reference

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 ost::TCPStream:
ost::Socket ost::SSLStream ost::TCPSession ost::URLStream

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...
 
 TCPStream (TCPV6Socket &server, bool throwflag=true, timeout_t timeout=0)
 
void connect (TCPSocket &server)
 Accept a connection from a TCP Server. More...
 
void connect (TCPV6Socket &server)
 
 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 IPV6Host &host, tpport_t port, unsigned mss=536, bool throwflag=true, timeout_t timeout=0)
 
 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...
 
size_t printf (const char *format,...)
 Print content into a socket. 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...
 
- Public Member Functions inherited from ost::Socket
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...
 
Socketoperator= (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
 
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. More...
 
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. More...
 
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. More...
 
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. 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
 

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 IPV6Host &host, tpport_t port, unsigned mss=536)
 
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...
 
- Protected Member Functions inherited from ost::Socket
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 join (const IPV6Multicast &ia)
 
Error drop (const IPV4Multicast &ia)
 Drop membership from a multicast group. More...
 
Error drop (const IPV6Multicast &ia)
 
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

timeout_t timeout
 
size_t bufsize
 
Family family
 
char * gbuf
 
char * pbuf
 
- Protected Attributes inherited from ost::Socket
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
 

Friends

TCPStreamcrlf (TCPStream &)
 
TCPStreamlfcr (TCPStream &)
 

Additional Inherited Members

- Public Types inherited from ost::Socket
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 Public Member Functions inherited from ost::Socket
static bool check (Family fam)
 See if a specific protocol family is available in the current runtime environment. More...
 
- Protected Types inherited from ost::Socket
enum  State {
  INITIAL, AVAILABLE, BOUND, CONNECTED,
  CONNECTING, STREAM
}
 
typedef enum State State
 
- Static Protected Attributes inherited from ost::Socket
static Mutex mutex
 

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.
Examples:
tcp.cpp, and tcpstr1.cpp.

Constructor & Destructor Documentation

ost::TCPStream::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.

ost::TCPStream::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.

This performs an "accept" call.

Parameters
serversocket listening
throwflagflag to throw errors.
timeoutfor all operations.
ost::TCPStream::TCPStream ( TCPV6Socket server,
bool  throwflag = true,
timeout_t  timeout = 0 
)
ost::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).

Parameters
hostaddress of remote TCP server.
portnumber to connect.
mssmaximum segment size of streaming buffers.
throwflagflag to throw errors.
timeoutfor all operations.
ost::TCPStream::TCPStream ( const IPV6Host host,
tpport_t  port,
unsigned  mss = 536,
bool  throwflag = true,
timeout_t  timeout = 0 
)
ost::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.

Parameters
nameof remote service.
familyof protocol.
mssmaximum segment size of streaming buffers.
throwflagflag to throw errors.
timerfor timeout for all operations.
ost::TCPStream::TCPStream ( const TCPStream source)

A copy constructor creates a new stream buffer.

Parameters
sourcereference of stream to copy from.
virtual ost::TCPStream::~TCPStream ( )
virtual

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

Member Function Documentation

void ost::TCPStream::allocate ( size_t  size)
protected

Used to allocate the buffer space needed for iostream operations.

This function is called by the constructor.

Parameters
sizeof stream buffers from constructor.
void ost::TCPStream::connect ( const IPV4Host host,
tpport_t  port,
unsigned  mss = 536 
)
protected

Create a TCP stream by connecting to a TCP socket (on a remote machine).

Parameters
hostaddress of remote TCP server.
portnumber to connect.
mssmaximum segment size of streaming buffers.
Examples:
tcp.cpp.
void ost::TCPStream::connect ( const IPV6Host host,
tpport_t  port,
unsigned  mss = 536 
)
protected
void ost::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
nameof host and service to connect
mssmaximum segment size of stream buffer
void ost::TCPStream::connect ( TCPSocket server)

Accept a connection from a TCP Server.

Parameters
serversocket listening
void ost::TCPStream::connect ( TCPV6Socket server)
void ost::TCPStream::disconnect ( void  )

Disconnect the current session and prepare for a new one.

Examples:
tcp.cpp, and tcpstr1.cpp.
void ost::TCPStream::endStream ( void  )
protected

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

This fucntion is called by the destructor.

size_t ost::TCPStream::getBufferSize ( void  ) const
inline

Return the size of the current stream buffering used.

Returns
size of stream buffers.
int ost::TCPStream::getSegmentSize ( void  )

Get protocol segment size.

Examples:
tcp.cpp.
bool ost::TCPStream::isPending ( Pending  pend,
timeout_t  timeout = TIMEOUT_INF 
)
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 ost::Socket.

Examples:
tcp.cpp.
int ost::TCPStream::overflow ( int  ch)
protected

This streambuf method is used to write the output buffer through the established tcp connection.

Parameters
chchar to push through.
Returns
char pushed through.
ssize_t ost::TCPStream::peek ( void *  buf,
size_t  len 
)
inline

Examine contents of next waiting packet.

Parameters
bufpointer to packet buffer for contents.
lenof packet buffer.
Returns
number of bytes examined.

References _IOLEN64.

size_t ost::TCPStream::printf ( const char *  format,
  ... 
)

Print content into a socket.

Returns
count of bytes sent.
Parameters
formatstring
void ost::TCPStream::setTimeout ( timeout_t  timer)
inline

Set the I/O operation timeout for socket I/O operations.

Parameters
timerto change timeout.
int ost::TCPStream::sync ( void  )

Flushes the stream input and output buffers, writes pending output.

Returns
0 on success.
std::iostream* ost::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.
int ost::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 ost::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.

Friends And Related Function Documentation

TCPStream& crlf ( TCPStream )
friend
TCPStream& lfcr ( TCPStream )
friend

Member Data Documentation

size_t ost::TCPStream::bufsize
protected
Family ost::TCPStream::family
protected
char* ost::TCPStream::gbuf
protected
char * ost::TCPStream::pbuf
protected
timeout_t ost::TCPStream::timeout
protected

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