psocksxx::lsockstream Class Reference

Local (unix) socket controller class. More...

#include <lsockstream.h>

Inheritance diagram for psocksxx::lsockstream:

Public Member Functions
	lsockstream () throw ( sockexception )
	constructor
virtual	~lsockstream () throw ()
	destructor
void	connect (const char *path) throw ( sockexception, socktimeoutexception )
	connect to a local socket
void	connect (const lsockaddr *saddr) throw ( sockexception, socktimeoutexception )
	connect to a local socket
Public Member Functions inherited from psocksxx::iosockstream
	iosockstream (sockstreambuf *ssb) throw ()
	constructor
virtual	~iosockstream () throw ()
	destructor
bool	timedout () const throw ()
	get the timed-out status for this stream
Public Member Functions inherited from psocksxx::isockstream
	isockstream (sockstreambuf *ssb) throw ()
	constructor
virtual	~isockstream () throw ()
	destructor
Public Member Functions inherited from psocksxx::iosocks
virtual	~iosocks () throw ()
	destructor
bool	timedout () const throw ()
	get the timed-out status flag value
const timeval *	timeout (time_t sec, suseconds_t usec) throw ()
	set the timeout value for stream communications
void *	clear_timeout () throw ()
	clear the timeout value
Public Member Functions inherited from psocksxx::osockstream
	osockstream (sockstreambuf *ssb) throw ()
	constructor
virtual	~osockstream () throw ()
	destructor

Additional Inherited Members
Protected Member Functions inherited from psocksxx::iosocks
	iosocks () throw ()
	empty default constructor

Detailed Description

Local (unix) socket controller class.

This class acts as a controller for communicating through a local (unix) socket and uses an instance of psocksxx::sockstreambuf as the underlying / associated sequence.

Constructor & Destructor Documentation

lsockstream()

psocksxx::lsockstream::lsockstream	(		)
throw	(	sockexception )

constructor

Exceptions

psocksxx::sockexception

socket exception

Initialise a local (unix) communication stream.

Member Function Documentation

connect() [1/2]

void psocksxx::lsockstream::connect	(	const char *	path	)
throw	(	sockexception,
		socktimeoutexception )

connect to a local socket

Parameters

path	local socket path

Exceptions

psocksxx::sockexception	socket exception
psocksxx::socktimeoutexception	connection timeout exception

Connect a to local socket at the given path. It is assumed that the socket is ready to accept connections.

connect() [2/2]

void psocksxx::lsockstream::connect	(	const lsockaddr *	saddr	)
throw	(	sockexception,
		socktimeoutexception )

connect to a local socket

Parameters

saddr

local socket address instance

Exceptions

psocksxx::sockexception	socket exception
psocksxx::socktimeoutexception	connection timeout exception

Connect to a local socket using the passed in socket address object.