Claw  1.7.3
socket_stream.hpp
Go to the documentation of this file.
1 /*
2  CLAW - a C++ Library Absolutely Wonderful
3 
4  CLAW is a free library without any particular aim but being useful to
5  anyone.
6 
7  Copyright (C) 2005-2011 Julien Jorge
8 
9  This library is free software; you can redistribute it and/or
10  modify it under the terms of the GNU Lesser General Public
11  License as published by the Free Software Foundation; either
12  version 2.1 of the License, or (at your option) any later version.
13 
14  This library is distributed in the hope that it will be useful,
15  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  Lesser General Public License for more details.
18 
19  You should have received a copy of the GNU Lesser General Public
20  License along with this library; if not, write to the Free Software
21  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 
23  contact: julien.jorge@gamned.org
24 */
30 #ifndef __CLAW_SOCKET_STREAM_HPP__
31 #define __CLAW_SOCKET_STREAM_HPP__
32 
33 #include <claw/basic_socketbuf.hpp>
34 #include <iostream>
35 
36 namespace claw
37 {
38  namespace net
39  {
44  template< typename CharT, typename Traits = std::char_traits<CharT> >
45  class basic_socket_stream : public std::basic_iostream<CharT, Traits>
46  {
47  public:
49  typedef CharT char_type;
50 
52  typedef Traits traits_type;
53 
55  typedef typename traits_type::int_type int_type;
56 
58  typedef typename traits_type::pos_type pos_type;
59 
61  typedef typename traits_type::off_type off_type;
62 
65 
66  public:
67  explicit basic_socket_stream( int read_delay = -1 );
68  basic_socket_stream( const char* address, int port, int read_delay = -1 );
69 
71 
72  buffer_type* rdbuf() const;
73 
74  bool is_open() const;
75  void set_read_time_limit( int read_limit );
76 
77  void open( const char* address, int port );
78  void open( int fd );
79  void close();
80 
81  private:
83  buffer_type m_buffer;
84  }; // class basic_socket_stream
85 
88 
92 
93  } // namespace net
94 } // namespace claw
95 
97 
98 #endif // __CLAW_SOCKET_STREAM_HPP__
buffer_type * rdbuf() const
Get the buffer.
void open(const char *address, int port)
Connect the socket to an address.
traits_type::off_type off_type
The type used to represent a delta in the positions.
CharT char_type
The type of the characters in the stream.
basic_socket_stream< wchar_t > wsocket_stream
Implementation of the basic_socket_stream for the wide characters.
Implementation of the claw::net::basic_socket_stream class.
basic_socket_stream< char > socket_stream
Implementation of the basic_socket_stream for the char type.
void close()
Close the connection.
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.
A class to use any socket as a classic standard stream.
Socket buffer to be used with std::basic_socket_stream, for easy socket reading and writing...
Traits traits_type
The traits carry some informations about the char_type.
traits_type::pos_type pos_type
The type used to represent a position in the stream.
traits_type::int_type int_type
The type used to represent integers.
basic_socket_stream(int read_delay=-1)
Constructor.
basic_socketbuf< char_type, traits_type > buffer_type
The type of the buffer manipulated by this stream.