UCommon
Public Member Functions | Protected Member Functions
ucommon::TCPBuffer Class Reference

A generic tcp socket class that offers i/o buffering. More...

#include <buffer.h>

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

Public Member Functions

void close (void)
 Close active connection.
void open (TCPServer *server, size_t size=536)
 Connect a tcp socket to a client from a listener.
void open (char *host, char *service, size_t size=536)
 Connect a tcp client session to a specific host uri.
 TCPBuffer ()
 Construct an unconnected tcp client and specify our service profile.
 TCPBuffer (TCPServer *server, size_t size=536)
 Construct a tcp server session from a listening socket.
 TCPBuffer (char *host, char *service, size_t size=536)
 Construct a tcp client session connected to a specific host uri.
virtual ~TCPBuffer ()
 Destroy the tcp socket and release all resources.

Protected Member Functions

bool _blocking (void)
 Return true if blocking.
void _buffer (size_t size)
void _clear (void)
 Method to clear low level i/o error.
int _err (void)
virtual bool _pending (void)
 Check for pending tcp or ssl data.
virtual size_t _pull (char *address, size_t size)
 Method to pull buffer from physical i/o (read).
virtual size_t _push (char *address, size_t size)
socket_t getsocket (void)
 Get the low level socket object.

Detailed Description

A generic tcp socket class that offers i/o buffering.

All user i/o operations are directly inherited from the IOBuffer base class public members. Some additional members are added for layering ssl services.

Author:
David Sugar <dyfet@gnutelephony.org>

Definition at line 151 of file buffer.h.


Constructor & Destructor Documentation

ucommon::TCPBuffer::TCPBuffer ( TCPServer server,
size_t  size = 536 
)

Construct a tcp server session from a listening socket.

Parameters:
serversocket we are created from.
sizeof buffer and tcp fragments.
ucommon::TCPBuffer::TCPBuffer ( char *  host,
char *  service,
size_t  size = 536 
)

Construct a tcp client session connected to a specific host uri.

Parameters:
hostand optional :port we are connecting to.
serviceidentifier of our client.
sizeof buffer and tcp fragments.

Member Function Documentation

virtual bool ucommon::TCPBuffer::_pending ( void  ) [protected, virtual]

Check for pending tcp or ssl data.

Returns:
true if data pending.

Reimplemented from ucommon::BufferProtocol.

Reimplemented in ucommon::SSLBuffer.

virtual size_t ucommon::TCPBuffer::_pull ( char *  address,
size_t  size 
) [protected, virtual]

Method to pull buffer from physical i/o (read).

The address is passed to this virtual since it is hidden as private.

Parameters:
addressof buffer to pull data into.
sizeof buffer area being pulled..
Returns:
number of read written, 0 on error or end of data.

Implements ucommon::BufferProtocol.

Reimplemented in ucommon::SSLBuffer.

socket_t ucommon::TCPBuffer::getsocket ( void  ) [inline, protected]

Get the low level socket object.

Returns:
socket we are using.

Definition at line 166 of file buffer.h.

void ucommon::TCPBuffer::open ( TCPServer server,
size_t  size = 536 
)

Connect a tcp socket to a client from a listener.

If the socket was already connected, it is automatically closed first.

Parameters:
serverwe are connected from.
sizeof buffer and tcp fragments.
void ucommon::TCPBuffer::open ( char *  host,
char *  service,
size_t  size = 536 
)

Connect a tcp client session to a specific host uri.

If the socket was already connected, it is automatically closed first.

Parameters:
hostwe are connecting.
serviceto connect to.
sizeof buffer and tcp fragments.

Reimplemented in ucommon::SSLBuffer.


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