#include <stream.h>

Inheritance diagram for ucommon::tcpstream:

Collaboration diagram for ucommon::tcpstream:

Public Member Functions
	tcpstream (const tcpstream &copy)

	tcpstream (const TCPServer *server, unsigned segsize=536, timeout_t timeout=0)

	tcpstream (int family=PF_INET, timeout_t timeout=0)

	tcpstream (Socket::address &address, unsigned segsize=536, timeout_t timeout=0)

virtual	~tcpstream ()

	operator bool () const

bool	operator! () const

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

void	open (const char host, const char service, unsigned segment=536)

void	close (void)

Public Member Functions inherited from ucommon::StreamBuffer
int	sync (void)

bool	is_open (void) const

	operator bool () const

bool	operator! () const

Protected Member Functions
virtual ssize_t	_read (char *buffer, size_t size)

virtual ssize_t	_write (const char *buffer, size_t size)

virtual bool	_wait (void)

void	release (void)

int	underflow (void) __OVERRIDE

int	overflow (int ch) __OVERRIDE

socket_t	getsocket (void) const

Protected Member Functions inherited from ucommon::StreamBuffer
	StreamBuffer ()

int	uflow () __OVERRIDE

void	release (void)

void	allocate (size_t size)

Protected Attributes
socket_t	so

timeout_t	timeout

Protected Attributes inherited from ucommon::StreamBuffer
size_t	bufsize

char *	gbuf

char *	pbuf

Private Member Functions
__LOCAL void	allocate (unsigned size)

__LOCAL void	reset (void)

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 114 of file stream.h.

Constructor & Destructor Documentation

◆ tcpstream() [1/4]

ucommon::tcpstream::tcpstream ( const tcpstream & copy )

Copy constructor...

Parameters

copy	for object.

Definition at line 126 of file stream.cpp.

References ucommon::copy(), ucommon::Socket::create(), ucommon::Socket::family(), so, and timeout.

◆ tcpstream() [2/4]

ucommon::tcpstream::tcpstream	(	const TCPServer *	server,
		unsigned	segsize = `536`,
		timeout_t	timeout = `0`
	)

Create a stream from an existing tcp listener.

Parameters

server	to accept connection from.
segsize	for tcp segments and buffering.
timeout	for socket i/o operations.

Definition at line 148 of file stream.cpp.

References ucommon::ListenSocket::accept(), allocate(), ucommon::clear(), INVALID_SOCKET, so, and timeout.

◆ tcpstream() [3/4]

ucommon::tcpstream::tcpstream	(	int	family = `PF_INET`,
		timeout_t	timeout = `0`
	)

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

Parameters

family	of protocol to create.
timeout	for socket i/o operations.

Definition at line 133 of file stream.cpp.

References ucommon::Socket::create(), so, and timeout.

◆ tcpstream() [4/4]

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

address	of service to connect to.
segsize	for tcp segments and buffering.
timeout	for socket i/o operations.

Definition at line 140 of file stream.cpp.

References ucommon::Socket::create(), ucommon::Socket::address::family(), open(), so, and timeout.

◆ ~tcpstream()

ucommon::tcpstream::~tcpstream ( )

virtual

Destroy a tcp stream.

Definition at line 160 of file stream.cpp.

References release().

Member Function Documentation

◆ _read()

ssize_t ucommon::tcpstream::_read	(	char *	buffer,
		size_t	size
	)

protectedvirtual

Reimplemented in ucommon::sstream.

Definition at line 183 of file stream.cpp.

References buffer, MSG_WAITALL, ucommon::Socket::recvfrom(), and so.

Referenced by ucommon::sstream::_read(), and underflow().

◆ _wait()

bool ucommon::tcpstream::_wait ( void )

protectedvirtual

Reimplemented in ucommon::sstream.

Definition at line 175 of file stream.cpp.

References so, timeout, and ucommon::Socket::wait().

Referenced by ucommon::sstream::_wait(), and underflow().

◆ _write()

ssize_t ucommon::tcpstream::_write	(	const char *	buffer,
		size_t	size
	)

protectedvirtual

Reimplemented in ucommon::sstream.

Definition at line 188 of file stream.cpp.

References buffer, ucommon::Socket::sendto(), and so.

Referenced by ucommon::sstream::_write(), and overflow().

◆ allocate()

void ucommon::tcpstream::allocate ( unsigned size )

private

Definition at line 353 of file stream.cpp.

References ucommon::StreamBuffer::allocate(), ucommon::StreamBuffer::bufsize, ucommon::max(), ucommon::Socket::recvsize(), ucommon::Socket::sendsize(), ucommon::Socket::sendwait(), and so.

Referenced by open(), and tcpstream().

◆ close()

void ucommon::tcpstream::close ( void )

Close an active stream connection. This does not release the socket but is a disconnect.

Definition at line 334 of file stream.cpp.

References ucommon::StreamBuffer::bufsize, ucommon::clear(), ucommon::Socket::disconnect(), ucommon::StreamBuffer::gbuf, ucommon::StreamBuffer::pbuf, so, and ucommon::StreamBuffer::sync().

Referenced by ucommon::sstream::close(), and open().

◆ getsocket()

socket_t ucommon::tcpstream::getsocket ( void ) const

inlineprotected

Definition at line 151 of file stream.h.

◆ open() [1/2]

void ucommon::tcpstream::open	(	const char *	host,
		const char *	service,
		unsigned	segment = `536`
	)

Open a stream connectoion to a host and service.

Parameters

host	to connect to.
service	to connect to by name or number as string.
segment	buffering size to use.

Definition at line 299 of file stream.cpp.

References allocate(), ucommon::StreamBuffer::bufsize, close(), ucommon::Socket::connectto(), ucommon::Socket::query(), ucommon::Socket::release(), and so.

◆ open() [2/2]

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

Open a stream connection to a tcp service.

Parameters

address	of service to access.
segment	buffering size to use.

Definition at line 288 of file stream.cpp.

References allocate(), ucommon::StreamBuffer::bufsize, close(), ucommon::Socket::connectto(), and so.

Referenced by ucommon::sstream::open(), and tcpstream().

◆ operator bool()

ucommon::tcpstream::operator bool ( ) const

inline

See if stream connection is active.

Returns: true if stream is active.

Definition at line 196 of file stream.h.

References INVALID_SOCKET.

◆ operator!()

bool ucommon::tcpstream::operator! ( void ) const

inline

See if stream is disconnected.

Returns: true if stream disconnected.

Definition at line 204 of file stream.h.

References INVALID_SOCKET.

◆ overflow()

int ucommon::tcpstream::overflow ( int ch )

protected

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

Parameters

ch	char to push through.

Returns: char pushed through.

Definition at line 240 of file stream.cpp.

References _write(), ucommon::StreamBuffer::bufsize, ch, EOF, IS_EOF, ucommon::StreamBuffer::pbuf, PUT, and reset().

◆ release()

void ucommon::tcpstream::release ( void )

protected

Release the tcp stream and destroy the underlying socket.

Definition at line 165 of file stream.cpp.

References ucommon::StreamBuffer::release(), ucommon::Socket::release(), and so.

Referenced by ~tcpstream().

◆ reset()

void ucommon::tcpstream::reset ( void )

private

Definition at line 317 of file stream.cpp.

References ucommon::StreamBuffer::bufsize, ucommon::clear(), ucommon::Socket::disconnect(), ucommon::StreamBuffer::gbuf, ucommon::StreamBuffer::pbuf, and so.

Referenced by overflow(), and underflow().

◆ underflow()

int ucommon::tcpstream::underflow ( void )

protected

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.

Definition at line 193 of file stream.cpp.

References _read(), _wait(), ucommon::StreamBuffer::bufsize, ch, ucommon::clear(), EOF, ucommon::StreamBuffer::gbuf, GET, and reset().

Member Data Documentation

◆ so

socket_t ucommon::tcpstream::so

protected

Definition at line 121 of file stream.h.

Referenced by _read(), _wait(), _write(), allocate(), close(), open(), ucommon::sstream::open(), release(), reset(), ucommon::sstream::sstream(), and tcpstream().

◆ timeout

timeout_t ucommon::tcpstream::timeout

protected

Definition at line 122 of file stream.h.

Referenced by _wait(), and tcpstream().

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

inc/ucommon/stream.h
corelib/stream.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ tcpstream() [1/4]

◆ tcpstream() [2/4]

◆ tcpstream() [3/4]

◆ tcpstream() [4/4]

◆ ~tcpstream()

Member Function Documentation

◆ _read()

◆ _wait()

◆ _write()

◆ allocate()

◆ close()

◆ getsocket()

◆ open() [1/2]

◆ open() [2/2]

◆ operator bool()

◆ operator!()

◆ overflow()

◆ release()

◆ reset()

◆ underflow()

Member Data Documentation

◆ so

◆ timeout