libt2n::client_connection Class Reference

a (generic) connection from client to server. Abstract. More...

#include <client.hxx>

Inheritance diagram for libt2n::client_connection:

Public Member Functions
	client_connection ()
void	set_logging (std::ostream *_logstream, log_level_values _log_level)
	activate logging to the given stream. everything above the given level is logged.
std::ostream *	get_logstream (log_level_values level)
	get pointer to logging stream, returns NULL if no logging needed
bool	is_closed ()
	is this connection closed or not
virtual void	close ()
	close this connection
virtual bool	fill_buffer (long long usec_timeout=-1, long long *usec_timeout_remaining=NULL)=0
	look for new data and store it in the local buffer
bool	get_packet (std::string &data)
	read a complete data packet from the buffer. The packet is removed from the connection buffer.
unsigned int	peek_packet (std::string &data)
	get (maybe incomplete) data of the next packet from the buffer. Does not remove the data from the connection buffer.
bool	packet_available ()
	returns true if a complete data packet is in the buffer. retrieve it with get_packet().
void	write (const std::string &data)
	send a blob to the peer
void	add_callback (callback_event_type event, const boost::function< void()> &func)
	add a callback
std::list< boost::function < void()> >	get_callback_list (callback_event_type event)
	get the callbacks in place for one event
Protected Types
typedef uint32_t	packet_size_indicator
Protected Member Functions
packet_size_indicator	bytes_available ()
	get the number of bytes being available as next complete packet
virtual void	real_write (const std::string &data)=0
void	do_callbacks (callback_event_type event)
	an event has occured, execute the callbacks that are registered for this event
void	reopen (void)
	reopen a already closed connection, removes incomplete packets from the buffer
void	remove_incomplete_packets ()
	remove all data from buffer that is not a complete packet
Protected Attributes
std::string	buffer
Private Attributes
log_level_values	log_level
std::ostream *	logstream

Detailed Description

a (generic) connection from client to server. Abstract.

Member Typedef Documentation

typedef uint32_t libt2n::connection::packet_size_indicator [protected, inherited]

Constructor & Destructor Documentation

libt2n::client_connection::client_connection ( )

References libt2n::none, and set_logging().

Member Function Documentation

void libt2n::connection::add_callback	(	callback_event_type	event,
		const boost::function< void()> &	func
	)			`[inherited]`

add a callback

Parameters:

	event	event the function will be called at
	func	functor (see boost function) that will be called

Note:: use boost::bind to bind to member functions and parameters like this: 17 is a fixed parameter that is always added to the call c.add_callback(connection_closed,bind(&my_class::func_to_call_back, boost::ref(*this), 17));

Reimplemented in libt2n::server_connection.

References libt2n::connection::callbacks.

Referenced by libt2n::command_client::command_client(), and libt2n::command_client::replace_connection().

connection::packet_size_indicator libt2n::connection::bytes_available ( ) [protected, inherited]

get the number of bytes being available as next complete packet

References libt2n::connection::buffer.

Referenced by libt2n::connection::get_packet(), and libt2n::connection::packet_available().

void libt2n::connection::close ( ) [virtual, inherited]

close this connection

Reimplemented in libt2n::socket_client_connection, and libt2n::socket_server_connection.

References libt2n::connection::closed, libt2n::connection_closed, libt2n::connection::do_callbacks(), and libt2n::connection::is_closed().

Referenced by libt2n::server_connection::check_timeout(), libt2n::command_client::command_client(), libt2n::dummy_client_connection::dummy_client_connection(), and libt2n::command_server::handle().

void libt2n::connection::do_callbacks ( callback_event_type event ) [protected, inherited]

an event has occured, execute the callbacks that are registered for this event

Parameters:

event

event type that has occured

References libt2n::connection::callbacks.

Referenced by libt2n::connection::close(), libt2n::connection::reopen(), libt2n::socket_client_connection::socket_client_connection(), and libt2n::connection::~connection().

virtual bool libt2n::connection::fill_buffer	(	long long	usec_timeout = `-1`,
		long long *	usec_timeout_remaining = `NULL`
	)			`[pure virtual, inherited]`

look for new data and store it in the local buffer

Parameters:

	usec_timeout	wait until new data is found, max timeout usecs. -1: wait endless 0: return instantly
	usec_timeout_remaining	if non-NULL the function will write the not used time to the given target

Return values:

true

if new data was found (does not mean that the received data is a complete packet though)

Implemented in libt2n::socket_client_connection, libt2n::socket_server_connection, and libt2n::dummy_client_connection.

Referenced by libt2n::command_client::read_hello(), and libt2n::command_client::read_packet().

std::list< boost::function< void()> > libt2n::connection::get_callback_list ( callback_event_type event ) [inherited]

get the callbacks in place for one event

Parameters:

event

event the callbacks should be registered for