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. void disconnect (void)
Disconnect the current session and prepare for a new one. int getSegmentSize (void)
Get protocol segment size. 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. TCPStream (TCPV6Socket &server, bool throwflag=true, timeout_t timeout=0)
void connect (TCPSocket &server)
Accept a connection from a TCP Server. 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). 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. void setTimeout (timeout_t timer)
Set the I/O operation timeout for socket I/O operations. TCPStream (const TCPStream &source)
A copy constructor creates a new stream buffer. virtual ~TCPStream ()
Flush and empty all buffers, and then remove the allocated buffers. int sync (void)
Flushes the stream input and output buffers, writes pending output. size_t printf (const char *format,...)
Print content into a socket. bool isPending (Pending pend, timeout_t timeout=TIMEOUT_INF)
Get the status of pending stream data. ssize_t peek (void *buf, size_t len)
Examine contents of next waiting packet. size_t getBufferSize (void) const
Return the size of the current stream buffering used.

Protected Member Functions¶

void allocate (size_t size)
Used to allocate the buffer space needed for iostream operations. void endStream (void)
Used to terminate the buffer space and cleanup the socket connection. int underflow ()
This streambuf method is used to load the input buffer through the established tcp socket connection. int uflow ()
This streambuf method is used for doing unbuffered reads through the establish tcp socket connection when in interactive mode. int overflow (int ch)
This streambuf method is used to write the output buffer through the established tcp connection. 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). 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. std::iostream * tcp (void)
Used in derived classes to refer to the current object via it's iostream.

Protected Attributes¶

timeout_t timeout
size_t bufsize
Family family
char * gbuf
char * pbuf

Friends¶

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

Additional Inherited Members¶

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

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

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

ost::TCPStream::TCPStream (const TCPStream & source)¶

A copy constructor creates a new stream buffer.

Parameters

virtual ost::TCPStream::~TCPStream () [virtual]¶

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

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

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

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

Examples
tcp.cpp.

void ost::TCPStream::connect (const IPV6Host & host, tpport_t port, unsigned mss = 536) [protected]¶

void ost::TCPStream::connect (TCPSocket & server)¶

Accept a connection from a TCP Server.

Parameters

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

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

Returns

ssize_t ost::TCPStream::peek (void * buf, size_t len) [inline]¶

Examine contents of next waiting packet.

Parameters

Returns

References _IOLEN64.

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

Print content into a socket.

Returns

Parameters

void ost::TCPStream::setTimeout (timeout_t timer) [inline]¶

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

Parameters

int ost::TCPStream::sync (void)¶

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

Returns

std::iostream* ost::TCPStream::tcp (void) [inline], [protected]¶

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

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

int ost::TCPStream::underflow () [protected]¶

This streambuf method is used to load the input buffer through the established tcp socket connection.

Returns

TCPStream& crlf (TCPStream &) [friend]¶

TCPStream& lfcr (TCPStream &) [friend]¶

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]¶