psocksxx::nsockstream Class Reference

Network (IPv4) controller class. More...

#include <nsockstream.h>

Inheritance diagram for psocksxx::nsockstream:

Public Member Functions
	nsockstream (sockstreambuf::socket_type_t type, sockstreambuf::socket_protocol_t proto) throw ( sockexception )
	constructor More...
	nsockstream (sockstreambuf *ssb) throw ()
	constructor More...
virtual	~nsockstream () throw ()
	destructor
void	connect (const nsockaddr *saddr) throw ( sockexception, socktimeoutexception )
	connect to a network address More...
void	connect (const char *node, unsigned int port) throw ( sockexception, socktimeoutexception )
	connect to a network address More...
void	bind (const nsockaddr *saddr, bool reuse_addr=false) throw ( sockexception )
	bind the stream to a network address More...
void	listen (int backlog=0) throw ( sockexception )
	make this stream passive and ready to accept connections More...
nsockstream *	accept () throw ( sockexception )
	accept a connection on a listening (passive) stream More...
Public Member Functions inherited from psocksxx::iosockstream
	iosockstream (sockstreambuf *ssb) throw ()
	constructor More...
virtual	~iosockstream () throw ()
	destructor
bool	timedout () const throw ()
	get the timed-out status for this stream More...
Public Member Functions inherited from psocksxx::isockstream
	isockstream (sockstreambuf *ssb) throw ()
	constructor More...
virtual	~isockstream () throw ()
	destructor
Public Member Functions inherited from psocksxx::iosocks
virtual	~iosocks () throw ()
	destructor More...
bool	timedout () const throw ()
	get the timed-out status flag value More...
const timeval *	timeout (time_t sec, suseconds_t usec) throw ()
	set the timeout value for stream communications More...
void *	clear_timeout () throw ()
	clear the timeout value More...
Public Member Functions inherited from psocksxx::osockstream
	osockstream (sockstreambuf *ssb) throw ()
	constructor More...
virtual	~osockstream () throw ()
	destructor

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

Detailed Description

Network (IPv4) controller class.

This is the base class for network (IP version 4) communications streams.

Constructor & Destructor Documentation

psocksxx::nsockstream::nsockstream	(	sockstreambuf::socket_type_t	type,
		sockstreambuf::socket_protocol_t	proto
	)
throw	(	sockexception
	)

constructor

Parameters

type	socket communications type
proto	socket communications protocol

Exceptions

psocksxx::sockexception

socket exception

Open a network (IPv4) communications stream with the passed in type and protocol.

psocksxx::nsockstream::nsockstream	(	sockstreambuf *	ssb	)
throw	(
	)

constructor

Parameters

ssb	initialised socket stream buffer instance

Initialise a network socket stream by using the passed in socket stream buffer, ssb, as the associated sequence which is assumed to be initialised with the correct type and protocol. The class destructor will delete the psocksxx::sockstreambuf instance pointed by ssb.

Member Function Documentation

nsockstream * psocksxx::nsockstream::accept	(		)
throw	(	sockexception
	)

accept a connection on a listening (passive) stream

Exceptions

psocksxx::sockexception

socket exception

Returns

a new stream instance for the accepted connection

This method will accept an incoming connection on a listening stream and return a newly created stream instance that can be used to communicate with the accepted client connection. Note that the returned stream instance must be deleted by the caller.

void psocksxx::nsockstream::bind	(	const nsockaddr *	saddr,
		bool	reuse_addr = false
	)
throw	(	sockexception
	)

bind the stream to a network address

Parameters

saddr	address information to bind to
reuse_addr	allow address to be re-used

Exceptions

psocksxx::sockexception

socket exception

This binds the network socket stream to the specified network address. If you want to try to bind to any socket that is not actively listening (e.g. TIME_WAIT) then set the reuse_addr parameter to be true.

void psocksxx::nsockstream::connect	(	const nsockaddr *	saddr	)
throw	(	sockexception,
		socktimeoutexception
	)

connect to a network address

Parameters

saddr

destination address information

Exceptions

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

Connect to a IPv4 communication end point making this stream ready for I/O.

void psocksxx::nsockstream::connect	(	const char *	node,
		unsigned int	port
	)
throw	(	sockexception,
		socktimeoutexception
	)

connect to a network address

Parameters

node	node (host name or IP)
port	port number

Exceptions

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

Connect to a IPv4 communication end point making this stream ready for I/O.

void psocksxx::nsockstream::listen	(	int	backlog = 0	)
throw	(	sockexception
	)

make this stream passive and ready to accept connections

Parameters

backlog

maximum length of the queue for pending connections and if this value is 0 (default) then it assumes system default

Exceptions

psocksxx::sockexception

socket exception

Make this network stream passive and ready to accept connections. Before calling this method the stream must be bound to a network address using the bind() method.