claw::net::basic_socket_stream< CharT, Traits > Class Template Reference

A class to use any socket as a classic standard stream. More...

#include <socket_stream.hpp>

Public Types
typedef CharT	char_type
	The type of the characters in the stream.
typedef Traits	traits_type
	The traits carry some informations about the char_type.
typedef traits_type::int_type	int_type
	The type used to represent integers.
typedef traits_type::pos_type	pos_type
	The type used to represent a position in the stream.
typedef traits_type::off_type	off_type
	The type used to represent a delta in the positions.
typedef basic_socketbuf < char_type, traits_type >	buffer_type
	The type of the buffer manipulated by this stream.

Public Member Functions
	basic_socket_stream (int read_delay=-1)
	Constructor.
	basic_socket_stream (const char *address, int port, int read_delay=-1)
	Constructor.
	~basic_socket_stream ()
	Destructor.
buffer_type *	rdbuf () const
	Get the buffer.
bool	is_open () const
	Tell if the stream is open.
void	set_read_time_limit (int read_limit)
	Set the number of second to wait before considering nothing will come in the socket.
void	open (const char *address, int port)
	Connect the socket to an address.
void	open (int fd)
	Link the socket to a file descriptor.
void	close ()
	Close the connection.

Detailed Description

template<typename CharT, typename Traits = std::char_traits<CharT>>
class claw::net::basic_socket_stream< CharT, Traits >

A class to use any socket as a classic standard stream.

Author

Julien Jorge

Definition at line 45 of file socket_stream.hpp.

Constructor & Destructor Documentation

template<typename CharT , typename Traits >

claw::net::basic_socket_stream< CharT, Traits >::basic_socket_stream ( int  read_delay = -1 )

explicit

Constructor.

Parameters

read_delay

Number of second to wait before considering nothing will come in the socket. Negative values mean infinity.

Definition at line 39 of file socket_stream.tpp.

template<typename CharT , typename Traits >

claw::net::basic_socket_stream< CharT, Traits >::basic_socket_stream	(	const char *	address,
		int	port,
		int	read_delay = -1
	)

Constructor.

Parameters

address	The address to which we will connect.
port	The port number to use for the connection.
read_delay	Number of second to wait before considering nothing will come in the socket. Negative values mean infinity.

Definition at line 55 of file socket_stream.tpp.

Member Function Documentation

template<typename CharT , typename Traits >

void claw::net::basic_socket_stream< CharT, Traits >::open	(	const char *	address,
		int	port
	)

Connect the socket to an address.

Parameters

address	The address to which we will connect.
port	The port number to use for the connection.

Definition at line 114 of file socket_stream.tpp.

template<typename CharT , typename Traits >

void claw::net::basic_socket_stream< CharT, Traits >::open

(

int

fd

)

Link the socket to a file descriptor.

Parameters

fd	The file descriptor.

Remarks

This method should be only called by claw::net::socket_server.

Definition at line 129 of file socket_stream.tpp.

template<typename CharT , typename Traits >

void claw::net::basic_socket_stream< CharT, Traits >::set_read_time_limit

(

int

read_limit

)

Set the number of second to wait before considering nothing will come in the socket.

Parameters

read_limit

The number of seconds. Negative values mean infinity.

Definition at line 101 of file socket_stream.tpp.

---

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

• socket_stream.hpp
• impl/socket_stream.tpp