ost::TCPStream - TCP streams are used to represent TCP client connections to a server by TCP protocol

       Generated automatically by Doxygen for GNU CommonC++ from the source code.

GNU CommonC++                                    Sun Dec 27 2020                               ost::TCPStream(3)

ost::TCPStream::TCPStream(Familyfamily=IPV4,boolthrowflag=true,timeout_tto=0)
       The constructor required for building other classes or to start an unconnected TCPStream for connect.

   ost::TCPStream::TCPStream(TCPSocket&server,boolthrowflag=true,timeout_ttimeout=0)
       Create a TCP stream by accepting a connection from a bound TCP socket acting as a server. This performs
       an 'accept' call.

       Parametersserver socket listening
           throwflag flag to throw errors.
           timeout for all operations.

   ost::TCPStream::TCPStream(TCPV6Socket&server,boolthrowflag=true,timeout_ttimeout=0)ost::TCPStream::TCPStream(constIPV4Host&host,tpport_tport,unsignedmss=536,boolthrowflag=true,timeout_ttimeout=0)
       Create a TCP stream by connecting to a TCP socket (on a remote machine).

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

   ost::TCPStream::TCPStream(constIPV6Host&host,tpport_tport,unsignedmss=536,boolthrowflag=true,timeout_ttimeout=0)ost::TCPStream::TCPStream(constchar*name,Familyfamily=IPV4,unsignedmss=536,boolthrowflag=false,timeout_ttimer=0)
       Construct a named TCP Socket connected to a remote machine.

       Parametersname of remote service.
           family of protocol.
           mss maximum segment size of streaming buffers.
           throwflag flag to throw errors.
           timer for timeout for all operations.

   ost::TCPStream::TCPStream(constTCPStream&source)
       A copy constructor creates a new stream buffer.

       Parameterssource reference of stream to copy from.

   virtualost::TCPStream::~TCPStream()[virtual]
       Flush and empty all buffers, and then remove the allocated buffers.

       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@ostel.com

       streamable TCP socket connection.

       Examplestcp.cpp, and tcpstr1.cpp.

TCPStream&crlf(TCPStream&)[friend]TCPStream&lfcr(TCPStream&)[friend]

size_tost::TCPStream::bufsize[protected]Familyost::TCPStream::family[protected]char*ost::TCPStream::gbuf[protected]char*ost::TCPStream::pbuf[protected]timeout_tost::TCPStream::timeout[protected]

voidost::TCPStream::allocate(size_tsize)[protected]
       Used to allocate the buffer space needed for iostream operations. This function is called by the
       constructor.

       Parameterssize of stream buffers from constructor.

   voidost::TCPStream::connect(constchar*name,unsignedmss=536)[protected]
       Connect a TCP stream to a named destination host and port number, using getaddrinfo interface if
       available.

       Parametersname of host and service to connect
           mss maximum segment size of stream buffer

   voidost::TCPStream::connect(constIPV4Host&host,tpport_tport,unsignedmss=536)[protected]
       Create a TCP stream by connecting to a TCP socket (on a remote machine).

       Parametershost address of remote TCP server.
           port number to connect.
           mss maximum segment size of streaming buffers.

       Examplestcp.cpp.

   voidost::TCPStream::connect(constIPV6Host&host,tpport_tport,unsignedmss=536)[protected]voidost::TCPStream::connect(TCPSocket&server)
       Accept a connection from a TCP Server.

       Parametersserver socket listening

   voidost::TCPStream::connect(TCPV6Socket&server)voidost::TCPStream::disconnect(void)
       Disconnect the current session and prepare for a new one.

       Examplestcp.cpp, and tcpstr1.cpp.

   voidost::TCPStream::endStream(void)[protected]
       Used to terminate the buffer space and cleanup the socket connection. This fucntion is called by the
       destructor.

   size_tost::TCPStream::getBufferSize(void)const[inline]
       Return the size of the current stream buffering used.

       Returns
           size of stream buffers.

   intost::TCPStream::getSegmentSize(void)
       Get protocol segment size.

       Examplestcp.cpp.

   boolost::TCPStream::isPending(Pendingpend,timeout_ttimeout=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.

       Examplestcp.cpp.

   intost::TCPStream::overflow(intch)[protected]
       This streambuf method is used to write the output buffer through the established tcp connection.

       Parametersch char to push through.

       Returns
           char pushed through.

   ssize_tost::TCPStream::peek(void*buf,size_tlen)[inline]
       Examine contents of next waiting packet.

       Parametersbuf pointer to packet buffer for contents.
           len of packet buffer.

       Returns
           number of bytes examined.

       References _IOLEN64.

   size_tost::TCPStream::printf(constchar*format,...)
       Print content into a socket.

       Returns
           count of bytes sent.

       Parametersformat string

   voidost::TCPStream::setTimeout(timeout_ttimer)[inline]
       Set the I/O operation timeout for socket I/O operations.

       Parameterstimer to change timeout.

   intost::TCPStream::sync(void)
       Flushes the stream input and output buffers, writes pending output.

       Returns
           0 on success.

   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
           stream pointer of this object.

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

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

       ost::TCPStream - TCP streams are used to represent TCP client connections to a server by TCP protocol
       servers for accepting client connections.

       #include <socket.h>

       Inherits streambuf, ost::Socket, and iostream.

       Inherited by ost::SSLStream, ost::TCPSession, and ost::URLStream.

   PublicMemberFunctionsTCPStream (Familyfamily=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_ttimeout=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_ttimeout=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_ttimeout=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_ttimeout=0)
       TCPStream (const char *name, Familyfamily=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_ttimeout=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.

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

   ProtectedAttributestimeout_ttimeout
       size_t bufsizeFamilyfamily
       char * gbuf
       char * pbufFriendsTCPStream & crlf (TCPStream &)
       TCPStream & lfcr (TCPStream &)

   AdditionalInheritedMembers