websocketpp  0.6.0
C++/Boost Asio based websocket client/server library
base.hpp
1 /*
2  * Copyright (c) 2014, 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_ASIO_SOCKET_BASE_HPP
29 #define WEBSOCKETPP_TRANSPORT_ASIO_SOCKET_BASE_HPP
30 
31 #include <websocketpp/common/memory.hpp>
32 #include <websocketpp/common/functional.hpp>
33 #include <websocketpp/common/system_error.hpp>
34 #include <websocketpp/common/cpp11.hpp>
35 #include <websocketpp/common/connection_hdl.hpp>
36 
37 #include <string>
38 
39 // Interface that sockets/security policies must implement
40 
41 /*
42  * Endpoint Interface
43  *
44  * bool is_secure() const;
45  * @return Whether or not the endpoint creates secure connections
46  *
47  * lib::error_code init(socket_con_ptr scon);
48  * Called by the transport after a new connection is created to initialize
49  * the socket component of the connection.
50  * @param scon Pointer to the socket component of the connection
51  * @return Error code (empty on success)
52  */
53 
54 
55 // Connection
56 // TODO
57 // set_hostname(std::string hostname)
58 // pre_init(init_handler);
59 // post_init(init_handler);
60 
61 namespace websocketpp {
62 namespace transport {
63 namespace asio {
64 namespace socket {
65 
71 namespace error {
73  enum value {
76  security = 1,
77 
81 
84 
88 
91 
94 
97 
100 
103  };
104 } // namespace error
105 
107 class socket_category : public lib::error_category {
108 public:
109  char const * name() const _WEBSOCKETPP_NOEXCEPT_TOKEN_ {
110  return "websocketpp.transport.asio.socket";
111  }
112 
113  std::string message(int value) const {
114  switch(value) {
115  case error::security:
116  return "Security policy error";
117  case error::socket:
118  return "Socket component error";
120  return "Invalid state";
122  return "Invalid or empty TLS context supplied";
124  return "TLS handshake timed out";
125  case error::pass_through:
126  return "Pass through from socket policy";
128  return "Required tls_init handler not present.";
130  return "TLS handshake failed";
132  return "Failed to set TLS SNI hostname";
133  default:
134  return "Unknown";
135  }
136  }
137 };
138 
139 inline lib::error_category const & get_socket_category() {
140  static socket_category instance;
141  return instance;
142 }
143 
144 inline lib::error_code make_error_code(error::value e) {
145  return lib::error_code(static_cast<int>(e), get_socket_category());
146 }
147 
149 typedef lib::function<void(const lib::error_code&)> init_handler;
150 
151 } // namespace socket
152 } // namespace asio
153 } // namespace transport
154 } // namespace websocketpp
155 
156 #endif // WEBSOCKETPP_TRANSPORT_ASIO_SOCKET_BASE_HPP
uint16_t value
The type of a close code value.
Definition: close.hpp:49
Error category related to asio transport socket policies.
Definition: base.hpp:107
pass_through from underlying library
Definition: base.hpp:93
A function was called in a state that it was illegal to do so.
Definition: base.hpp:83
Namespace for the WebSocket++ project.
Definition: base64.hpp:41
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