websocketpp  0.3.0
C++/Boost Asio based websocket client/server library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
connection.hpp
1 /*
2  * Copyright (c) 2013, 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_BASE_CON_HPP
29 #define WEBSOCKETPP_TRANSPORT_BASE_CON_HPP
30 
31 #include <websocketpp/common/cpp11.hpp>
32 #include <websocketpp/common/connection_hdl.hpp>
33 #include <websocketpp/common/functional.hpp>
34 #include <websocketpp/common/memory.hpp>
35 #include <websocketpp/common/system_error.hpp>
36 
37 namespace websocketpp {
39 
113 namespace transport {
114 
116 typedef lib::function<void(lib::error_code const &)> init_handler;
117 
119 typedef lib::function<void(lib::error_code const &,size_t)> read_handler;
120 
122 typedef lib::function<void(lib::error_code const &)> write_handler;
123 
125 typedef lib::function<void(lib::error_code const &)> timer_handler;
126 
128 typedef lib::function<void(lib::error_code const &)> shutdown_handler;
129 
131 typedef lib::function<void()> interrupt_handler;
132 
134 typedef lib::function<void()> dispatch_handler;
135 
137 struct buffer {
138  buffer(char const * b, size_t l) : buf(b),len(l) {}
139 
140  char const * buf;
141  size_t len;
142 };
143 
145 namespace error {
146 enum value {
149  general = 1,
150 
153 
156 
159 
162 
165 
168 
171 
174 
177 
180 };
181 
182 class category : public lib::error_category {
183  public:
184  category() {}
185 
186  char const * name() const _WEBSOCKETPP_NOEXCEPT_TOKEN_ {
187  return "websocketpp.transport";
188  }
189 
190  std::string message(int value) const {
191  switch(value) {
192  case general:
193  return "Generic transport policy error";
194  case pass_through:
195  return "Underlying Transport Error";
196  case invalid_num_bytes:
197  return "async_read_at_least call requested more bytes than buffer can store";
198  case operation_aborted:
199  return "The operation was aborted";
201  return "The operation is not supported by this transport";
202  case eof:
203  return "End of File";
204  case tls_short_read:
205  return "TLS Short Read";
206  case timeout:
207  return "Timer Expired";
209  return "A transport action was requested after shutdown";
210  case tls_error:
211  return "Generic TLS related error";
212  default:
213  return "Unknown";
214  }
215  }
216 };
217 
218 inline lib::error_category const & get_category() {
219  static category instance;
220  return instance;
221 }
222 
223 inline lib::error_code make_error_code(error::value e) {
224  return lib::error_code(static_cast<int>(e), get_category());
225 }
226 
227 } // namespace error
228 } // namespace transport
229 } // namespace websocketpp
230 _WEBSOCKETPP_ERROR_CODE_ENUM_NS_START_
231 template<> struct is_error_code_enum<websocketpp::transport::error::value>
232 {
233  static bool const value = true;
234 };
235 _WEBSOCKETPP_ERROR_CODE_ENUM_NS_END_
236 
237 #endif // WEBSOCKETPP_TRANSPORT_BASE_CON_HPP
uint16_t value
The type of a close code value.
Definition: close.hpp:49
async_read_at_least call requested more bytes than buffer can store
Definition: connection.hpp:155
lib::function< void(lib::error_code const &)> write_handler
The type and signature of the callback passed to the write method.
Definition: connection.hpp:122
lib::function< void()> interrupt_handler
The type and signature of the callback passed to the interrupt method.
Definition: connection.hpp:131
lib::function< void(lib::error_code const &, size_t)> read_handler
The type and signature of the callback passed to the read method.
Definition: connection.hpp:119
underlying transport pass through
Definition: connection.hpp:152
lib::function< void()> dispatch_handler
The type and signature of the callback passed to the dispatch method.
Definition: connection.hpp:134
async_read called while another async_read was in progress
Definition: connection.hpp:158
lib::function< void(lib::error_code const &)> timer_handler
The type and signature of the callback passed to the read method.
Definition: connection.hpp:125
lib::function< void(lib::error_code const &)> shutdown_handler
The type and signature of the callback passed to the shutdown method.
Definition: connection.hpp:128
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:116
A simple utility buffer class.
Definition: connection.hpp:137