Provided by: libcommoncpp2-doc_1.8.1-6ubuntu1_all bug

NAME

       ost::unixstream -

       A more natural C++ 'unixstream' class for use by non-threaded applications.

SYNOPSIS

       #include <unix.h>

       Inherits ost::UnixStream.

   Public Member Functions
       unixstream ()
           Construct an unopened 'tcpstream' object.
       unixstream (const char *pathname, int buffer=512)
           Construct and 'open' (connect) the tcp stream to a remote socket.
       unixstream (UnixSocket &unixsock, int buffer=512)
           Construct and 'accept' (connect) the tcp stream through a server.
       void open (const char *pathname, int buffer=512)
           Open a tcp stream connection.
       void open (UnixSocket &unixsock, int buffer=512)
           Open a tcp stream connection by accepting a tcp socket.
       void close (void)
           Close the active tcp stream connection.
       bool operator! () const
           Test to see if stream is open.

   Additional Inherited Members

Detailed Description

       A more natural C++ 'unixstream' class for use by non-threaded applications.

       This class behaves a lot more like fstream and similar classes.

       Author:
           Alex Pavloff alex@pavloff.net C++ 'fstream' style unixstream class.

Constructor & Destructor Documentation

   ost::unixstream::unixstream ()
       Construct an unopened 'tcpstream' object.

   ost::unixstream::unixstream (const char *pathname, intbuffer = 512)
       Construct and 'open' (connect) the tcp stream to a remote socket.

       Parameters:
           pathname pathname to socket file
           buffer size for streaming (optional).

   ost::unixstream::unixstream (UnixSocket &unixsock, intbuffer = 512)
       Construct and 'accept' (connect) the tcp stream through a server.

       Parameters:
           unixsock socket to accept from.
           buffer size for streaming (optional).

Member Function Documentation

   void ost::unixstream::close (void)
       Close the active tcp stream connection.

   void ost::unixstream::open (const char *pathname, intbuffer = 512) [inline]
       Open a tcp stream connection. This will close the currently active connection first.

       Parameters:
           pathname pathname to socket file
           buffer size for streaming (optional)

       References ost::UnixStream::connect().

   void ost::unixstream::open (UnixSocket &unixsock, intbuffer = 512)
       Open a tcp stream connection by accepting a tcp socket.

       Parameters:
           unixsock socket to accept from.
           buffer size for streaming (optional)

   bool ost::unixstream::operator! () const
       Test to see if stream is open.

Author

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