2 * Copyright (c) 2014, Peter Thorson. All rights reserved.
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.
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.
28 #ifndef WEBSOCKETPP_TRANSPORT_IOSTREAM_BASE_HPP
29 #define WEBSOCKETPP_TRANSPORT_IOSTREAM_BASE_HPP
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>
36 #include <websocketpp/transport/base/connection.hpp>
41 namespace websocketpp {
43 /// Transport policy that uses STL iostream for I/O and does not support timers
46 /// The type and signature of the callback used by iostream transport to write
47 typedef lib::function<lib::error_code(connection_hdl, char const *, size_t)>
50 /// The type and signature of the callback used by iostream transport to perform
53 * If a vectored write handler is not set the standard write handler will be
54 * called multiple times.
56 typedef lib::function<lib::error_code(connection_hdl, std::vector<transport::buffer> const
57 & bufs)> vector_write_handler;
59 /// The type and signature of the callback used by iostream transport to signal
60 /// a transport shutdown.
61 typedef lib::function<lib::error_code(connection_hdl)> shutdown_handler;
63 /// iostream transport errors
66 /// Catch-all error for transport policy errors that don't fit in other
70 /// async_read_at_least call requested more bytes than buffer can store
73 /// async_read called while another async_read was in progress
76 /// An operation that requires an output stream was attempted before
78 output_stream_required,
84 /// iostream transport error category
85 class category : public lib::error_category {
89 char const * name() const _WEBSOCKETPP_NOEXCEPT_TOKEN_ {
90 return "websocketpp.transport.iostream";
93 std::string message(int value) const {
96 return "Generic iostream transport policy error";
97 case invalid_num_bytes:
98 return "async_read_at_least call requested more bytes than buffer can store";
100 return "Async read already in progress";
101 case output_stream_required:
102 return "An output stream to be set before async_write can be used";
104 return "A stream operation returned ios::bad";
111 /// Get a reference to a static copy of the iostream transport error category
112 inline lib::error_category const & get_category() {
113 static category instance;
117 /// Get an error code with the given value and the iostream transport category
118 inline lib::error_code make_error_code(error::value e) {
119 return lib::error_code(static_cast<int>(e), get_category());
123 } // namespace iostream
124 } // namespace transport
125 } // namespace websocketpp
126 _WEBSOCKETPP_ERROR_CODE_ENUM_NS_START_
127 template<> struct is_error_code_enum<websocketpp::transport::iostream::error::value>
129 static bool const value = true;
131 _WEBSOCKETPP_ERROR_CODE_ENUM_NS_END_
133 #endif // WEBSOCKETPP_TRANSPORT_IOSTREAM_BASE_HPP