socket_stream.hpp
Go to the documentation of this file.
/*
CLAW - a C++ Library Absolutely Wonderful
CLAW is a free library without any particular aim but being useful to
anyone.
Copyright (C) 2005-2011 Julien Jorge
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
contact: julien.jorge@gamned.org
*/
#ifndef __CLAW_SOCKET_STREAM_HPP__
#define __CLAW_SOCKET_STREAM_HPP__
#include <claw/basic_socketbuf.hpp>
#include <iostream>
namespace claw
{
namespace net
{
template< typename CharT, typename Traits = std::char_traits<CharT> >
class basic_socket_stream : public std::basic_iostream<CharT, Traits>
{
public:
typedef CharT char_type;
typedef Traits traits_type;
typedef typename traits_type::int_type int_type;
typedef typename traits_type::pos_type pos_type;
typedef typename traits_type::off_type off_type;
typedef basic_socketbuf<char_type, traits_type> buffer_type;
public:
explicit basic_socket_stream( int read_delay = -1 );
basic_socket_stream( const char* address, int port, int read_delay = -1 );
~basic_socket_stream();
buffer_type* rdbuf() const;
bool is_open() const;
void set_read_time_limit( int read_limit );
void open( const char* address, int port );
void open( int fd );
void close();
private:
buffer_type m_buffer;
}; // class basic_socket_stream
typedef basic_socket_stream<char> socket_stream;
typedef basic_socket_stream<wchar_t> wsocket_stream;
} // namespace net
} // namespace claw
#include <claw/impl/socket_stream.tpp>
#endif // __CLAW_SOCKET_STREAM_HPP__
claw::net::basic_socket_stream::off_type
traits_type::off_type off_type
The type used to represent a delta in the positions.
Definition: socket_stream.hpp:61
claw::net::basic_socket_stream::char_type
CharT char_type
The type of the characters in the stream.
Definition: socket_stream.hpp:49
claw::net::wsocket_stream
basic_socket_stream< wchar_t > wsocket_stream
Implementation of the basic_socket_stream for the wide characters.
Definition: socket_stream.hpp:91
claw::net::socket_stream
basic_socket_stream< char > socket_stream
Implementation of the basic_socket_stream for the char type.
Definition: socket_stream.hpp:87
claw::net::basic_socket_stream
A class to use any socket as a classic standard stream.
Definition: socket_stream.hpp:45
basic_socketbuf.hpp
Socket buffer to be used with std::basic_socket_stream, for easy socket reading and writing...
claw::net::basic_socket_stream::traits_type
Traits traits_type
The traits carry some informations about the char_type.
Definition: socket_stream.hpp:52
claw::net::basic_socket_stream::pos_type
traits_type::pos_type pos_type
The type used to represent a position in the stream.
Definition: socket_stream.hpp:58
claw::net::basic_socketbuf< char_type, traits_type >
claw::net::basic_socket_stream::int_type
traits_type::int_type int_type
The type used to represent integers.
Definition: socket_stream.hpp:55
claw
This is the main namespace.
Definition: algorithm.hpp:33
claw::net::basic_socket_stream::buffer_type
basic_socketbuf< char_type, traits_type > buffer_type
The type of the buffer manipulated by this stream.
Definition: socket_stream.hpp:64