WebSocket++  0.8.2
C++ websocket client/server library
none.hpp
1 /*
2  * Copyright (c) 2015, Peter Thorson. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  * * Redistributions of source code must retain the above copyright
7  * notice, this list of conditions and the following disclaimer.
8  * * Redistributions in binary form must reproduce the above copyright
9  * notice, this list of conditions and the following disclaimer in the
10  * documentation and/or other materials provided with the distribution.
11  * * Neither the name of the WebSocket++ Project nor the
12  * names of its contributors may be used to endorse or promote products
13  * derived from this software without specific prior written permission.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED. IN NO EVENT SHALL PETER THORSON BE LIABLE FOR ANY
19  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  */
27 
28 #ifndef WEBSOCKETPP_TRANSPORT_SECURITY_NONE_HPP
29 #define WEBSOCKETPP_TRANSPORT_SECURITY_NONE_HPP
30 
31 #include <websocketpp/uri.hpp>
32 
33 #include <websocketpp/transport/base/connection.hpp>
34 #include <websocketpp/transport/asio/security/base.hpp>
35 
36 #include <websocketpp/common/asio.hpp>
37 #include <websocketpp/common/memory.hpp>
38 
39 #include <sstream>
40 #include <string>
41 
42 namespace websocketpp {
43 namespace transport {
44 namespace asio {
47 namespace basic_socket {
48 
50 typedef lib::function<void(connection_hdl,lib::asio::ip::tcp::socket&)>
52 
54 
58 class connection : public lib::enable_shared_from_this<connection> {
59 public:
61  typedef connection type;
63  typedef lib::shared_ptr<type> ptr;
64 
66  typedef lib::asio::io_service* io_service_ptr;
68  typedef lib::shared_ptr<lib::asio::io_service::strand> strand_ptr;
70  typedef lib::asio::ip::tcp::socket socket_type;
72  typedef lib::shared_ptr<socket_type> socket_ptr;
73 
74  explicit connection() : m_state(UNINITIALIZED) {
75  //std::cout << "transport::asio::basic_socket::connection constructor"
76  // << std::endl;
77  }
78 
81  return shared_from_this();
82  }
83 
85 
88  bool is_secure() const {
89  return false;
90  }
91 
93 
101  m_socket_init_handler = h;
102  }
103 
105 
108  lib::asio::ip::tcp::socket & get_socket() {
109  return *m_socket;
110  }
111 
113 
116  lib::asio::ip::tcp::socket & get_next_layer() {
117  return *m_socket;
118  }
119 
121 
124  lib::asio::ip::tcp::socket & get_raw_socket() {
125  return *m_socket;
126  }
127 
129 
138  std::string get_remote_endpoint(lib::error_code & ec) const {
139  std::stringstream s;
140 
141  lib::asio::error_code aec;
142  lib::asio::ip::tcp::endpoint ep = m_socket->remote_endpoint(aec);
143 
144  if (aec) {
146  s << "Error getting remote endpoint: " << aec
147  << " (" << aec.message() << ")";
148  return s.str();
149  } else {
150  ec = lib::error_code();
151  s << ep;
152  return s.str();
153  }
154  }
155 protected:
157 
165  lib::error_code init_asio (io_service_ptr service, strand_ptr, bool)
166  {
167  if (m_state != UNINITIALIZED) {
168  return socket::make_error_code(socket::error::invalid_state);
169  }
170 
171  m_socket.reset(new lib::asio::ip::tcp::socket(*service));
172 
173  if (m_socket_init_handler) {
174  m_socket_init_handler(m_hdl, *m_socket);
175  }
176 
177  m_state = READY;
178 
179  return lib::error_code();
180  }
181 
183 
193  void set_uri(uri_ptr) {}
194 
196 
204  void pre_init(init_handler callback) {
205  if (m_state != READY) {
206  callback(socket::make_error_code(socket::error::invalid_state));
207  return;
208  }
209 
210  m_state = READING;
211 
212  callback(lib::error_code());
213  }
214 
216 
223  void post_init(init_handler callback) {
224  callback(lib::error_code());
225  }
226 
228 
235  m_hdl = hdl;
236  }
237 
239 
247  lib::asio::error_code cancel_socket() {
248  lib::asio::error_code ec;
249  m_socket->cancel(ec);
250  return ec;
251  }
252 
253  void async_shutdown(socket::shutdown_handler h) {
254  lib::asio::error_code ec;
255  m_socket->shutdown(lib::asio::ip::tcp::socket::shutdown_both, ec);
256  h(ec);
257  }
258 
259  lib::error_code get_ec() const {
260  return lib::error_code();
261  }
262 
263 public:
265 
282  template <typename ErrorCodeType>
283  static
284  lib::error_code translate_ec(ErrorCodeType) {
285  // We don't know any more information about this error so pass through
286  return make_error_code(transport::error::pass_through);
287  }
288 
289  static
292  lib::error_code translate_ec(lib::error_code ec) {
293  // We don't know any more information about this error, but the error is
294  // the same type as the one we are translating to, so pass through
295  // untranslated.
296  return ec;
297  }
298 private:
299  enum state {
300  UNINITIALIZED = 0,
301  READY = 1,
302  READING = 2
303  };
304 
305  socket_ptr m_socket;
306  state m_state;
307 
308  connection_hdl m_hdl;
309  socket_init_handler m_socket_init_handler;
310 };
311 
313 
317 class endpoint {
318 public:
320  typedef endpoint type;
321 
327 
328  explicit endpoint() {}
329 
331 
334  bool is_secure() const {
335  return false;
336  }
337 
339 
347  m_socket_init_handler = h;
348  }
349 protected:
351 
359  lib::error_code init(socket_con_ptr scon) {
360  scon->set_socket_init_handler(m_socket_init_handler);
361  return lib::error_code();
362  }
363 private:
364  socket_init_handler m_socket_init_handler;
365 };
366 
367 } // namespace basic_socket
368 } // namespace asio
369 } // namespace transport
370 } // namespace websocketpp
371 
372 #endif // WEBSOCKETPP_TRANSPORT_SECURITY_NONE_HPP
websocketpp::transport::asio::error::make_error_code
lib::error_code make_error_code(error::value e)
Create an error code with the given value and the asio transport category.
Definition: base.hpp:217
websocketpp::transport::asio::basic_socket::endpoint::socket_con_ptr
socket_con_type::ptr socket_con_ptr
Definition: none.hpp:326
websocketpp::transport::asio::basic_socket::endpoint::init
lib::error_code init(socket_con_ptr scon)
Initialize a connection.
Definition: none.hpp:359
websocketpp::transport::asio::basic_socket::connection::get_next_layer
lib::asio::ip::tcp::socket & get_next_layer()
Retrieve a pointer to the underlying socket.
Definition: none.hpp:116
websocketpp::transport::asio::error::pass_through
@ pass_through
there was an error in the underlying transport library
Definition: base.hpp:171
websocketpp::uri_ptr
lib::shared_ptr< uri > uri_ptr
Pointer to a URI.
Definition: uri.hpp:352
websocketpp::transport::asio::basic_socket::connection::pre_init
void pre_init(init_handler callback)
Pre-initialize security policy.
Definition: none.hpp:204
websocketpp::transport::asio::basic_socket::connection::translate_ec
static lib::error_code translate_ec(ErrorCodeType)
Translate any security policy specific information about an error code.
Definition: none.hpp:284
websocketpp::transport::asio::basic_socket::endpoint::type
endpoint type
The type of this endpoint socket component.
Definition: none.hpp:320
websocketpp::transport::asio::basic_socket::connection::socket_ptr
lib::shared_ptr< socket_type > socket_ptr
Type of a shared pointer to the socket being used.
Definition: none.hpp:72
websocketpp::transport::asio::basic_socket::connection::is_secure
bool is_secure() const
Check whether or not this connection is secure.
Definition: none.hpp:88
websocketpp::transport::asio::basic_socket::connection::type
connection type
Type of this connection socket component.
Definition: none.hpp:61
websocketpp::transport::asio::basic_socket::connection::get_remote_endpoint
std::string get_remote_endpoint(lib::error_code &ec) const
Get the remote endpoint address.
Definition: none.hpp:138
websocketpp::transport::asio::basic_socket::connection::strand_ptr
lib::shared_ptr< lib::asio::io_service::strand > strand_ptr
Type of a pointer to the Asio io_service strand being used.
Definition: none.hpp:68
websocketpp::transport::error::pass_through
@ pass_through
underlying transport pass through
Definition: connection.hpp:153
websocketpp::transport::asio::basic_socket::endpoint
Basic ASIO endpoint socket component.
Definition: none.hpp:317
websocketpp::transport::asio::basic_socket::connection::get_raw_socket
lib::asio::ip::tcp::socket & get_raw_socket()
Retrieve a pointer to the underlying socket.
Definition: none.hpp:124
websocketpp::transport::asio::basic_socket::connection::set_handle
void set_handle(connection_hdl hdl)
Sets the connection handle.
Definition: none.hpp:234
websocketpp
Namespace for the WebSocket++ project.
Definition: base64.hpp:41
websocketpp::transport::asio::basic_socket::connection::translate_ec
static lib::error_code translate_ec(lib::error_code ec)
Definition: none.hpp:292
websocketpp::connection_hdl
lib::weak_ptr< void > connection_hdl
A handle to uniquely identify a connection.
Definition: connection_hdl.hpp:48
websocketpp::transport::asio::basic_socket::connection::get_socket
lib::asio::ip::tcp::socket & get_socket()
Retrieve a pointer to the underlying socket.
Definition: none.hpp:108
websocketpp::transport::asio::basic_socket::connection::ptr
lib::shared_ptr< type > ptr
Type of a shared pointer to this connection socket component.
Definition: none.hpp:63
websocketpp::transport::asio::basic_socket::connection::post_init
void post_init(init_handler callback)
Post-initialize security policy.
Definition: none.hpp:223
websocketpp::transport::asio::basic_socket::endpoint::set_socket_init_handler
void set_socket_init_handler(socket_init_handler h)
Set socket init handler.
Definition: none.hpp:346
websocketpp::transport::asio::basic_socket::connection::init_asio
lib::error_code init_asio(io_service_ptr service, strand_ptr, bool)
Perform one time initializations.
Definition: none.hpp:165
websocketpp::transport::init_handler
lib::function< void(lib::error_code const &)> init_handler
The type and signature of the callback passed to the init hook.
Definition: connection.hpp:117
websocketpp::transport::asio::basic_socket::connection::io_service_ptr
lib::asio::io_service * io_service_ptr
Type of a pointer to the Asio io_service being used.
Definition: none.hpp:66
websocketpp::transport::asio::basic_socket::socket_init_handler
lib::function< void(connection_hdl, lib::asio::ip::tcp::socket &)> socket_init_handler
The signature of the socket init handler for this socket policy.
Definition: none.hpp:51
websocketpp::transport::asio::basic_socket::connection::set_uri
void set_uri(uri_ptr)
Set uri hook.
Definition: none.hpp:193
websocketpp::transport::asio::basic_socket::connection::cancel_socket
lib::asio::error_code cancel_socket()
Cancel all async operations on this socket.
Definition: none.hpp:247
websocketpp::transport::asio::basic_socket::connection::socket_type
lib::asio::ip::tcp::socket socket_type
Type of the ASIO socket being used.
Definition: none.hpp:70
websocketpp::transport::asio::basic_socket::connection::set_socket_init_handler
void set_socket_init_handler(socket_init_handler h)
Set the socket initialization handler.
Definition: none.hpp:100
websocketpp::transport::asio::basic_socket::endpoint::is_secure
bool is_secure() const
Checks whether the endpoint creates secure connections.
Definition: none.hpp:334
websocketpp::transport::asio::basic_socket::connection::get_shared
ptr get_shared()
Get a shared pointer to this component.
Definition: none.hpp:80
websocketpp::transport::asio::basic_socket::connection
Basic Asio connection socket component.
Definition: none.hpp:58
websocketpp::transport::asio::basic_socket::endpoint::socket_con_type
connection socket_con_type
The type of the corresponding connection socket component.
Definition: none.hpp:323
websocketpp::transport::asio::socket::error::invalid_state
@ invalid_state
A function was called in a state that it was illegal to do so.
Definition: base.hpp:86