ucommon
Public Member Functions | Protected Member Functions | Protected Attributes
ucommon::tcpstream Class Reference

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

#include <stream.h>

Inheritance diagram for ucommon::tcpstream:
Inheritance graph
[legend]
Collaboration diagram for ucommon::tcpstream:
Collaboration graph
[legend]

Public Member Functions

void close (void)
 Close an active stream connection.
void open (Socket::address &address, unsigned segment=536)
 Open a stream connection to a tcp service.
void open (char *host, char *service, unsigned segment=536)
 Open a stream connectoion to a host and service.
 operator bool ()
 See if stream connection is active.
bool operator! ()
 See if stream is disconnected.
 tcpstream (tcpstream &copy)
 Copy constructor...
 tcpstream (TCPServer *server, unsigned segsize=536, timeout_t timeout=0)
 Create a stream from an existing tcp listener.
 tcpstream (int family=2, timeout_t timeout=0)
 Create an unconnected tcp stream object that is idle until opened.
 tcpstream (Socket::address &address, unsigned segsize=536, timeout_t timeout=0)
 A convenience constructor that creates a connected tcp stream directly from an address.
virtual ~tcpstream ()
 Destroy a tcp stream.
- Public Member Functions inherited from ucommon::StreamProtocol
bool is_open (void)
int sync (void)
 Flush the stream input and output buffers, writes pending output.
- Public Member Functions inherited from ucommon::CharacterProtocol
int get (void)
 Get the next character.
int put (int code)
 Put the next character.

Protected Member Functions

int _getch (void)
 This streambuf method is used to load the input buffer through the established tcp socket connection.
int _putch (int ch)
 This streambuf method is used to write the output buffer through the established tcp connection.
virtual ssize_t _read (char *buffer, size_t size)
virtual bool _wait (void)
virtual ssize_t _write (char *buffer, size_t size)
socket_t getsocket (void)
void release (void)
 Release the tcp stream and destroy the underlying socket.
- Protected Member Functions inherited from ucommon::StreamProtocol
void allocate (size_t size)
int overflow (int code)
int uflow ()
 This streambuf method is used for doing unbuffered reads through the establish tcp socket connection when in interactive mode.
int underflow ()

Protected Attributes

socket_t so
timeout_t timeout
- Protected Attributes inherited from ucommon::StreamProtocol
size_t bufsize
char * gbuf
char * pbuf

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.nosp@m.@gnu.nosp@m.telep.nosp@m.hony.nosp@m..org

Definition at line 109 of file stream.h.

Constructor & Destructor Documentation

ucommon::tcpstream::tcpstream ( tcpstream copy)

Copy constructor...

Parameters
copyfor object.
ucommon::tcpstream::tcpstream ( TCPServer server,
unsigned  segsize = 536,
timeout_t  timeout = 0 
)

Create a stream from an existing tcp listener.

Parameters
serverto accept connection from.
segsizefor tcp segments and buffering.
timeoutfor socket i/o operations.
ucommon::tcpstream::tcpstream ( int  family = 2,
timeout_t  timeout = 0 
)

Create an unconnected tcp stream object that is idle until opened.

Parameters
familyof protocol to create.
timeoutfor socket i/o operations.
ucommon::tcpstream::tcpstream ( Socket::address address,
unsigned  segsize = 536,
timeout_t  timeout = 0 
)

A convenience constructor that creates a connected tcp stream directly from an address.

The socket is constructed to match the type of the the address family in the socket address that is passed.

Parameters
addressof service to connect to.
segsizefor tcp segments and buffering.
timeoutfor socket i/o operations.

Member Function Documentation

int ucommon::tcpstream::_getch ( void  )
protectedvirtual

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.

Implements ucommon::CharacterProtocol.

int ucommon::tcpstream::_putch ( int  ch)
protectedvirtual

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

Parameters
chchar to push through.
Returns
char pushed through.

Implements ucommon::CharacterProtocol.

void ucommon::tcpstream::close ( void  )

Close an active stream connection.

This does not release the socket but is a disconnect.

Reimplemented in ucommon::sstream.

void ucommon::tcpstream::open ( Socket::address address,
unsigned  segment = 536 
)

Open a stream connection to a tcp service.

Parameters
addressof service to access.
segmentbuffering size to use.
void ucommon::tcpstream::open ( char *  host,
char *  service,
unsigned  segment = 536 
)

Open a stream connectoion to a host and service.

Parameters
hostto connect to.
serviceto connect to by name or number as string.
segmentbuffering size to use.
ucommon::tcpstream::operator bool ( )
inline

See if stream connection is active.

Returns
true if stream is active.

Reimplemented from ucommon::StreamProtocol.

Definition at line 190 of file stream.h.

bool ucommon::tcpstream::operator! ( )
inline

See if stream is disconnected.

Returns
true if stream disconnected.

Reimplemented from ucommon::StreamProtocol.

Definition at line 197 of file stream.h.


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