GNU CommonC++
Public Member Functions

ost::unixstream Class Reference

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

#include <unix.h>

Inheritance diagram for ost::unixstream:
ost::UnixStream ost::Socket

List of all members.

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.

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,
int  buffer = 512 
)

Construct and "open" (connect) the tcp stream to a remote socket.

Parameters:
pathnamepathname to socket file
buffersize for streaming (optional).
ost::unixstream::unixstream ( UnixSocket unixsock,
int  buffer = 512 
)

Construct and "accept" (connect) the tcp stream through a server.

Parameters:
unixsocksocket to accept from.
buffersize for streaming (optional).

Member Function Documentation

void ost::unixstream::close ( void  )

Close the active tcp stream connection.

void ost::unixstream::open ( UnixSocket unixsock,
int  buffer = 512 
)

Open a tcp stream connection by accepting a tcp socket.

Parameters:
unixsocksocket to accept from.
buffersize for streaming (optional)
void ost::unixstream::open ( const char *  pathname,
int  buffer = 512 
) [inline]

Open a tcp stream connection.

This will close the currently active connection first.

Parameters:
pathnamepathname to socket file
buffersize for streaming (optional)

References ost::UnixStream::connect().

bool ost::unixstream::operator! ( ) const

Test to see if stream is open.

Reimplemented from ost::Socket.


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