CLAW Library (a C++ Library Absolutely Wonderful) 1.5.5
|
A class to use any socket as a classic standard stream. More...
#include <socket_stream.hpp>
Public Types | |
typedef CharT | char_type |
typedef Traits | traits_type |
typedef traits_type::int_type | int_type |
typedef traits_type::pos_type | pos_type |
typedef traits_type::off_type | off_type |
typedef basic_socketbuf < char_type, traits_type > | buffer_type |
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. | |
Private Attributes | |
buffer_type | m_buffer |
The buffer used for operations. |
A class to use any socket as a classic standard stream.
Definition at line 45 of file socket_stream.hpp.
typedef basic_socketbuf<char_type, traits_type> claw::net::basic_socket_stream< CharT, Traits >::buffer_type |
Definition at line 54 of file socket_stream.hpp.
typedef CharT claw::net::basic_socket_stream< CharT, Traits >::char_type |
Definition at line 48 of file socket_stream.hpp.
typedef traits_type::int_type claw::net::basic_socket_stream< CharT, Traits >::int_type |
Definition at line 50 of file socket_stream.hpp.
typedef traits_type::off_type claw::net::basic_socket_stream< CharT, Traits >::off_type |
Definition at line 52 of file socket_stream.hpp.
typedef traits_type::pos_type claw::net::basic_socket_stream< CharT, Traits >::pos_type |
Definition at line 51 of file socket_stream.hpp.
typedef Traits claw::net::basic_socket_stream< CharT, Traits >::traits_type |
Definition at line 49 of file socket_stream.hpp.
claw::net::basic_socket_stream< CharT, Traits >::basic_socket_stream | ( | int | read_delay = -1 | ) | [explicit] |
Constructor.
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.
claw::net::basic_socket_stream< CharT, Traits >::basic_socket_stream | ( | const char * | address, |
int | port, | ||
int | read_delay = -1 |
||
) |
Constructor.
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.
claw::net::basic_socket_stream< CharT, Traits >::~basic_socket_stream | ( | ) |
Destructor.
Definition at line 67 of file socket_stream.tpp.
{ // nothing to do } // basic_socket_stream::~basic_socket_stream()
void claw::net::basic_socket_stream< CharT, Traits >::close | ( | ) |
Close the connection.
Definition at line 142 of file socket_stream.tpp.
bool claw::net::basic_socket_stream< CharT, Traits >::is_open | ( | ) | const |
Tell if the stream is open.
Definition at line 88 of file socket_stream.tpp.
void claw::net::basic_socket_stream< CharT, Traits >::open | ( | int | fd | ) |
Link the socket to a file descriptor.
fd | The file descriptor. |
Definition at line 129 of file socket_stream.tpp.
void claw::net::basic_socket_stream< CharT, Traits >::open | ( | const char * | address, |
int | port | ||
) |
Connect the socket to an address.
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.
claw::net::basic_socket_stream< CharT, Traits >::buffer_type * claw::net::basic_socket_stream< CharT, Traits >::rdbuf | ( | ) | const |
Get the buffer.
Definition at line 78 of file socket_stream.tpp.
{ return const_cast<buffer_type*>(&m_buffer); } // basic_socket_stream::rdbuf()
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.
read_limit | The number of seconds. Negative values mean infinity. |
Definition at line 101 of file socket_stream.tpp.
{ m_buffer.set_read_time_limit(read_limit); } // // basic_socket_stream::set_read_time_limit()
buffer_type claw::net::basic_socket_stream< CharT, Traits >::m_buffer [private] |
The buffer used for operations.
Definition at line 73 of file socket_stream.hpp.