ecl::SocketClientStream Class Reference

Convenience class for SocketClient TextStream definitions. More...

Inheritance diagram for ecl::SocketClientStream:

Public Member Functions
	SocketClientStream (const std::string &host_name, const unsigned int &port_number) ecl_throw_decl(StandardException)
	Convenience constructor for output file text streams.
	SocketClientStream ()
	Default constructor, underlying device must be manually opened.
virtual	~SocketClientStream ()

Detailed Description

Convenience class for SocketClient TextStream definitions.

This class provides a convenient handle for both writing and opening TextStream<SocketClient> objects. It has no further functionality.

Definition at line 45 of file socket_streams.hpp.

ecl::SocketClientStream::SocketClientStream ( ) [inline]

Default constructor, underlying device must be manually opened.

This must open the device manually via device().open() as you would do if using a TextStream.

Definition at line 53 of file socket_streams.hpp.

ecl::SocketClientStream::SocketClientStream	(	const std::string &	host_name,
		const unsigned int &	port_number
	)			`[inline]`

Convenience constructor for output file text streams.

This constructor enables RAII style construction of the underlying device (this makes it distinct from a generic TextStream<OFile> object).

Parameters:

	host_name	: host to connect to.
	port_number	: port number of the connection.

Exceptions:

StandardException

: throws if the connection failed to open.

Definition at line 66 of file socket_streams.hpp.

virtual ecl::SocketClientStream::~SocketClientStream ( ) [inline, virtual]

Definition at line 76 of file socket_streams.hpp.

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