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_IOSTREAM_BASE_HPP
29 #define WEBSOCKETPP_TRANSPORT_IOSTREAM_BASE_HPP
30 
31 #include <websocketpp/common/system_error.hpp>
32 #include <websocketpp/common/cpp11.hpp>
33 #include <websocketpp/common/functional.hpp>
34 #include <websocketpp/common/connection_hdl.hpp>
35 
36 #include <string>
37 
38 namespace websocketpp {
39 namespace transport {
41 namespace iostream {
42 
44 typedef lib::function<lib::error_code(connection_hdl, char const *, size_t)>
46 
49 typedef lib::function<lib::error_code(connection_hdl)> shutdown_handler;
50 
52 namespace error {
53 enum value {
56  general = 1,
57 
60 
63 
67 
70 };
71 
73 class category : public lib::error_category {
74  public:
75  category() {}
76 
77  char const * name() const _WEBSOCKETPP_NOEXCEPT_TOKEN_ {
78  return "websocketpp.transport.iostream";
79  }
80 
81  std::string message(int value) const {
82  switch(value) {
83  case general:
84  return "Generic iostream transport policy error";
85  case invalid_num_bytes:
86  return "async_read_at_least call requested more bytes than buffer can store";
87  case double_read:
88  return "Async read already in progress";
90  return "An output stream to be set before async_write can be used";
91  case bad_stream:
92  return "A stream operation returned ios::bad";
93  default:
94  return "Unknown";
95  }
96  }
97 };
98 
100 inline lib::error_category const & get_category() {
101  static category instance;
102  return instance;
103 }
104 
106 inline lib::error_code make_error_code(error::value e) {
107  return lib::error_code(static_cast<int>(e), get_category());
108 }
109 
110 } // namespace error
111 } // namespace iostream
112 } // namespace transport
113 } // namespace websocketpp
114 _WEBSOCKETPP_ERROR_CODE_ENUM_NS_START_
115 template<> struct is_error_code_enum<websocketpp::transport::iostream::error::value>
116 {
117  static bool const value = true;
118 };
119 _WEBSOCKETPP_ERROR_CODE_ENUM_NS_END_
120 
121 #endif // WEBSOCKETPP_TRANSPORT_IOSTREAM_BASE_HPP
uint16_t value
The type of a close code value.
Definition: close.hpp:49
lib::error_code make_error_code(error::value e)
Get an error code with the given value and the iostream transport category.
Definition: base.hpp:106
async_read called while another async_read was in progress
Definition: base.hpp:62
lib::error_category const & get_category()
Get a reference to a static copy of the iostream transport error category.
Definition: base.hpp:100
lib::function< lib::error_code(connection_hdl)> shutdown_handler
Definition: base.hpp:49
async_read_at_least call requested more bytes than buffer can store
Definition: base.hpp:59
Namespace for the WebSocket++ project.
Definition: base64.hpp:41
iostream transport error category
Definition: base.hpp:73
lib::function< lib::error_code(connection_hdl, char const *, size_t)> write_handler
The type and signature of the callback used by iostream transport to write.
Definition: base.hpp:45