Public Types | Public Member Functions | Protected Member Functions | Protected Attributes

ucc::filestream Class Reference

Streamable tcp connection between client and server. More...

#include <stream.h>

Inheritance diagram for ucc::filestream:
Inheritance graph
[legend]
Collaboration diagram for ucc::filestream:
Collaboration graph
[legend]

Public Types

enum  access_t { RDONLY, WRONLY, RDWR }

Public Member Functions

void close (void)
 Close an active stream connection.
void create (char *filename, fsys::access_t access, unsigned mode, size_t buffering=512)
 Create a stream connection to a tcp service.
int err (void)
 Get error flag from last i/o operation.
 filestream (filestream &copy)
 Create duplicate stream.
 filestream (char *path, fsys::access_t access, size_t bufsize)
 Open file stream.
 filestream ()
 Create an unopened pipe stream.
 filestream (char *path, fsys::access_t access, unsigned mode, size_t bufsize)
 Create file stream.
void open (char *filename, fsys::access_t access, size_t buffering=512)
 Open a stream connection to a tcp service.
 operator bool ()
 See if stream connection is active.
bool operator! ()
 See if stream is disconnected.
void seek (fsys::offset_t offset)
 Seek position.
virtual ~filestream ()
 Destroy a file stream.

Protected Member Functions

int _getch (void)
 This streambuf method is used to load the input buffer through the established pipe connection.
int _putch (int ch)
 This streambuf method is used to write the output buffer through the established pipe connection.

Protected Attributes

fsys::access_t ac
fsys_t fd

Detailed Description

Streamable tcp connection between client and server.

The tcp stream class can represent a client connection to a server or an instance of a service generated by a tcp listener. As a stream class, data can be manipulated using the << and >> operators.

Author:
David Sugar <dyfet@gnutelephony.org>

Definition at line 331 of file stream.h.


Member Function Documentation

int ucc::filestream::_getch ( void   )  [protected, virtual]

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

Returns:
char from get buffer, EOF if not connected.

Implements ucc::CharacterProtocol.

int ucc::filestream::_putch ( int  ch  )  [protected, virtual]

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

Parameters:
ch char to push through.
Returns:
char pushed through.

Implements ucc::CharacterProtocol.

int ucc::filestream::err ( void   )  [inline]

Get error flag from last i/o operation.

Returns:
last error.

Definition at line 428 of file stream.h.

ucc::filestream::operator bool (  )  [inline]

See if stream connection is active.

Returns:
true if stream is active.

Reimplemented from ucc::StreamProtocol.

Definition at line 394 of file stream.h.

bool ucc::filestream::operator! (  )  [inline]

See if stream is disconnected.

Returns:
true if stream disconnected.

Reimplemented from ucc::StreamProtocol.

Definition at line 401 of file stream.h.


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