websocketpp  0.5.1
C++/Boost Asio based websocket client/server library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
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 <boost/asio.hpp>
38 
39 #include <string>
40 
41 // Interface that sockets/security policies must implement
42 
43 /*
44  * Endpoint Interface
45  *
46  * bool is_secure() const;
47  * @return Whether or not the endpoint creates secure connections
48  *
49  * lib::error_code init(socket_con_ptr scon);
50  * Called by the transport after a new connection is created to initialize
51  * the socket component of the connection.
52  * @param scon Pointer to the socket component of the connection
53  * @return Error code (empty on success)
54  */
55 
56 
57 // Connection
58 // TODO
59 // pre_init(init_handler);
60 // post_init(init_handler);
61 
62 namespace websocketpp {
63 namespace transport {
64 namespace asio {
65 namespace socket {
66 
72 namespace error {
74  enum value {
77  security = 1,
78 
82 
85 
89 
92 
95 
98 
101  };
102 } // namespace error
103 
105 class socket_category : public lib::error_category {
106 public:
107  char const * name() const _WEBSOCKETPP_NOEXCEPT_TOKEN_ {
108  return "websocketpp.transport.asio.socket";
109  }
110 
111  std::string message(int value) const {
112  switch(value) {
113  case error::security:
114  return "Security policy error";
115  case error::socket:
116  return "Socket component error";
118  return "Invalid state";
120  return "Invalid or empty TLS context supplied";
122  return "TLS handshake timed out";
123  case error::pass_through:
124  return "Pass through from socket policy";
126  return "Required tls_init handler not present.";
128  return "TLS handshake failed";
129  default:
130  return "Unknown";
131  }
132  }
133 };
134 
135 inline lib::error_category const & get_socket_category() {
136  static socket_category instance;
137  return instance;
138 }
139 
140 inline lib::error_code make_error_code(error::value e) {
141  return lib::error_code(static_cast<int>(e), get_socket_category());
142 }
143 
145 typedef lib::function<void(const lib::error_code&)> init_handler;
146 
147 } // namespace socket
148 } // namespace asio
149 } // namespace transport
150 } // namespace websocketpp
151 
152 #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:105
pass_through from underlying library
Definition: base.hpp:94
A function was called in a state that it was illegal to do so.
Definition: base.hpp:84
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