WebSocket++ 0.8.2
C++ websocket client/server library
Loading...
Searching...
No Matches
connection.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_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/system_error.hpp>
35
36#include <string>
37
38namespace websocketpp {
39/// Transport policies provide network connectivity and timers
40/**
41 * ### Connection Interface
42 *
43 * Transport connection components needs to provide:
44 *
45 * **init**\n
46 * `void init(init_handler handler)`\n
47 * Called once shortly after construction to give the policy the chance to
48 * perform one time initialization. When complete, the policy must call the
49 * supplied `init_handler` to continue setup. The handler takes one argument
50 * with the error code if any. If an error is returned here setup will fail and
51 * the connection will be aborted or terminated.
52 *
53 * WebSocket++ will call init only once. The transport must call `handler`
54 * exactly once.
55 *
56 * **async_read_at_least**\n
57 * `void async_read_at_least(size_t num_bytes, char *buf, size_t len,
58 * read_handler handler)`\n
59 * start an async read for at least num_bytes and at most len
60 * bytes into buf. Call handler when done with number of bytes read.
61 *
62 * WebSocket++ promises to have only one async_read_at_least in flight at a
63 * time. The transport must promise to only call read_handler once per async
64 * read.
65 *
66 * **async_write**\n
67 * `void async_write(const char* buf, size_t len, write_handler handler)`\n
68 * `void async_write(std::vector<buffer> & bufs, write_handler handler)`\n
69 * Start a write of all of the data in buf or bufs. In second case data is
70 * written sequentially and in place without copying anything to a temporary
71 * location.
72 *
73 * Websocket++ promises to have only one async_write in flight at a time.
74 * The transport must promise to only call the write_handler once per async
75 * write
76 *
77 * **set_handle**\n
78 * `void set_handle(connection_hdl hdl)`\n
79 * Called by WebSocket++ to let this policy know the hdl to the connection. It
80 * may be stored for later use or ignored/discarded. This handle should be used
81 * if the policy adds any connection handlers. Connection handlers must be
82 * called with the handle as the first argument so that the handler code knows
83 * which connection generated the callback.
84 *
85 * **set_timer**\n
86 * `timer_ptr set_timer(long duration, timer_handler handler)`\n
87 * WebSocket++ uses the timers provided by the transport policy as the
88 * implementation of timers is often highly coupled with the implementation of
89 * the networking event loops.
90 *
91 * Transport timer support is an optional feature. A transport method may elect
92 * to implement a dummy timer object and have this method return an empty
93 * pointer. If so, all timer related features of WebSocket++ core will be
94 * disabled. This includes many security features designed to prevent denial of
95 * service attacks. Use timer-free transport policies with caution.
96 *
97 * **get_remote_endpoint**\n
98 * `std::string get_remote_endpoint()`\n
99 * retrieve address of remote endpoint
100 *
101 * **is_secure**\n
102 * `void is_secure()`\n
103 * whether or not the connection to the remote endpoint is secure
104 *
105 * **dispatch**\n
106 * `lib::error_code dispatch(dispatch_handler handler)`: invoke handler within
107 * the transport's event system if it uses one. Otherwise, this method should
108 * simply call `handler` immediately.
109 *
110 * **async_shutdown**\n
111 * `void async_shutdown(shutdown_handler handler)`\n
112 * Perform any cleanup necessary (if any). Call `handler` when complete.
113 */
114namespace transport {
115
116/// The type and signature of the callback passed to the init hook
117typedef lib::function<void(lib::error_code const &)> init_handler;
118
119/// The type and signature of the callback passed to the read method
120typedef lib::function<void(lib::error_code const &,size_t)> read_handler;
121
122/// The type and signature of the callback passed to the write method
123typedef lib::function<void(lib::error_code const &)> write_handler;
124
125/// The type and signature of the callback passed to the read method
126typedef lib::function<void(lib::error_code const &)> timer_handler;
127
128/// The type and signature of the callback passed to the shutdown method
129typedef lib::function<void(lib::error_code const &)> shutdown_handler;
130
131/// The type and signature of the callback passed to the interrupt method
132typedef lib::function<void()> interrupt_handler;
133
134/// The type and signature of the callback passed to the dispatch method
135typedef lib::function<void()> dispatch_handler;
136
137/// A simple utility buffer class
138struct buffer {
139 buffer(char const * b, size_t l) : buf(b),len(l) {}
140
141 char const * buf;
142 size_t len;
143};
144
145/// Generic transport related errors
146namespace error {
147enum value {
148 /// Catch-all error for transport policy errors that don't fit in other
149 /// categories
151
152 /// underlying transport pass through
154
155 /// async_read_at_least call requested more bytes than buffer can store
157
158 /// async_read called while another async_read was in progress
160
161 /// Operation aborted
163
164 /// Operation not supported
166
167 /// End of file
169
170 /// TLS short read
172
173 /// Timer expired
175
176 /// read or write after shutdown
178
179 /// Other TLS error
182
183class category : public lib::error_category {
184 public:
185 category() {}
186
187 char const * name() const _WEBSOCKETPP_NOEXCEPT_TOKEN_ {
188 return "websocketpp.transport";
189 }
190
191 std::string message(int value) const {
192 switch(value) {
193 case general:
194 return "Generic transport policy error";
195 case pass_through:
196 return "Underlying Transport Error";
198 return "async_read_at_least call requested more bytes than buffer can store";
200 return "The operation was aborted";
202 return "The operation is not supported by this transport";
203 case eof:
204 return "End of File";
205 case tls_short_read:
206 return "TLS Short Read";
207 case timeout:
208 return "Timer Expired";
210 return "A transport action was requested after shutdown";
211 case tls_error:
212 return "Generic TLS related error";
213 default:
214 return "Unknown";
215 }
216 }
217};
218
219inline lib::error_category const & get_category() {
220 static category instance;
221 return instance;
222}
223
224inline lib::error_code make_error_code(error::value e) {
225 return lib::error_code(static_cast<int>(e), get_category());
226}
227
228} // namespace error
229} // namespace transport
230} // namespace websocketpp
232template<> struct is_error_code_enum<websocketpp::transport::error::value>
233{
234 static bool const value = true;
235};
237
238#endif // WEBSOCKETPP_TRANSPORT_BASE_CON_HPP
#define _WEBSOCKETPP_CPP11_FUNCTIONAL_
#define _WEBSOCKETPP_CPP11_THREAD_
#define _WEBSOCKETPP_CPP11_MEMORY_
#define _WEBSOCKETPP_CPP11_SYSTEM_ERROR_
Concurrency policy that uses std::mutex / boost::mutex.
Definition basic.hpp:37
Stub for user supplied base class.
Stub for user supplied base class.
Stub class for use when disabling permessage_deflate extension.
Definition disabled.hpp:53
Stores, parses, and manipulates HTTP requests.
Definition request.hpp:50
Stores, parses, and manipulates HTTP responses.
Definition response.hpp:57
Basic logger that outputs to an ostream.
Definition basic.hpp:59
Thread safe stub "random" integer generator.
Definition none.hpp:46
Server endpoint role based on the given config.
Basic ASIO endpoint socket component.
Definition none.hpp:317
Asio based endpoint transport component.
Definition base.hpp:143
connection_hdl get_handle() const
Get the connection handle.
lib::error_code dispatch(dispatch_handler handler)
Call given handler back within the transport's event system (if present)
config::concurrency_type concurrency_type
transport concurrency policy
void async_shutdown(transport::shutdown_handler handler)
Perform cleanup on socket shutdown_handler.
void set_write_handler(write_handler h)
Sets the write handler.
void set_secure(bool value)
Set whether or not this connection is secure.
void set_shutdown_handler(shutdown_handler h)
Sets the shutdown handler.
void fatal_error()
Signal transport error.
size_t read_some(char const *buf, size_t len)
Manual input supply (read some)
size_t read_all(char const *buf, size_t len)
Manual input supply (read all)
config::elog_type elog_type
Type of this transport's error logging policy.
lib::shared_ptr< type > ptr
Type of a shared pointer to this connection transport component.
config::alog_type alog_type
Type of this transport's access logging policy.
void async_write(char const *buf, size_t len, transport::write_handler handler)
Asyncronous Transport Write.
size_t readsome(char const *buf, size_t len)
Manual input supply (DEPRECATED)
void init(init_handler handler)
Initialize the connection transport.
timer_ptr set_timer(long, timer_handler)
Call back a function after a period of time.
friend std::istream & operator>>(std::istream &in, type &t)
Overloaded stream input operator.
void set_vector_write_handler(vector_write_handler h)
Sets the vectored write handler.
bool is_secure() const
Tests whether or not the underlying transport is secure.
std::string get_remote_endpoint() const
Get human readable remote endpoint address.
void set_handle(connection_hdl hdl)
Set Connection Handle.
void register_ostream(std::ostream *o)
Register a std::ostream with the transport for writing output.
void async_read_at_least(size_t num_bytes, char *buf, size_t len, read_handler handler)
Initiate an async_read for at least num_bytes bytes into buf.
void async_write(std::vector< buffer > const &bufs, transport::write_handler handler)
Asyncronous Transport Write (scatter-gather)
ptr get_shared()
Get a shared pointer to this component.
connection< config > type
Type of this connection transport component.
transport_con_type::ptr transport_con_ptr
Definition endpoint.hpp:65
void set_write_handler(write_handler h)
Sets the write handler.
Definition endpoint.hpp:134
config::concurrency_type concurrency_type
Type of this endpoint's concurrency policy.
Definition endpoint.hpp:54
void set_shutdown_handler(shutdown_handler h)
Sets the shutdown handler.
Definition endpoint.hpp:154
bool is_secure() const
Tests whether or not the underlying transport is secure.
Definition endpoint.hpp:116
void async_connect(transport_con_ptr, uri_ptr, connect_handler cb)
Initiate a new connection.
Definition endpoint.hpp:183
config::alog_type alog_type
Type of this endpoint's access logging policy.
Definition endpoint.hpp:58
lib::error_code init(transport_con_ptr tcon)
Initialize a connection.
Definition endpoint.hpp:197
void init_logging(lib::shared_ptr< alog_type > a, lib::shared_ptr< elog_type > e)
Initialize logging.
Definition endpoint.hpp:171
endpoint type
Type of this endpoint transport component.
Definition endpoint.hpp:49
iostream::connection< config > transport_con_type
Definition endpoint.hpp:62
void register_ostream(std::ostream *o)
Register a default output stream.
Definition endpoint.hpp:80
void set_secure(bool value)
Set whether or not endpoint can create secure connections.
Definition endpoint.hpp:102
config::elog_type elog_type
Type of this endpoint's error logging policy.
Definition endpoint.hpp:56
lib::shared_ptr< type > ptr
Type of a pointer to this endpoint transport component.
Definition endpoint.hpp:51
iostream transport error category
Definition base.hpp:85
#define _WEBSOCKETPP_NOEXCEPT_TOKEN_
Definition cpp11.hpp:113
#define __has_extension
Definition cpp11.hpp:40
#define __has_feature(x)
Definition cpp11.hpp:37
Concurrency handling support.
Definition basic.hpp:34
Implementation of RFC 7692, the permessage-deflate WebSocket extension.
Definition disabled.hpp:44
HTTP handling support.
Definition request.hpp:37
Stub RNG policy that always returns 0.
Definition none.hpp:35
Random number generation policies.
Transport policy that uses asio.
Definition endpoint.hpp:46
Generic transport related errors.
@ pass_through
underlying transport pass through
@ operation_not_supported
Operation not supported.
@ operation_aborted
Operation aborted.
@ invalid_num_bytes
async_read_at_least call requested more bytes than buffer can store
@ action_after_shutdown
read or write after shutdown
@ tls_short_read
TLS short read.
@ double_read
async_read called while another async_read was in progress
iostream transport errors
Definition base.hpp:64
@ invalid_num_bytes
async_read_at_least call requested more bytes than buffer can store
Definition base.hpp:71
@ double_read
async_read called while another async_read was in progress
Definition base.hpp:74
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:118
lib::error_category const & get_category()
Get a reference to a static copy of the iostream transport error category.
Definition base.hpp:112
Transport policy that uses STL iostream for I/O and does not support timers.
Definition endpoint.hpp:43
lib::function< lib::error_code(connection_hdl, std::vector< transport::buffer > const &bufs)> vector_write_handler
Definition base.hpp:57
lib::function< lib::error_code(connection_hdl)> shutdown_handler
Definition base.hpp:61
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:48
Transport policies provide network connectivity and timers.
Definition endpoint.hpp:45
lib::function< void(lib::error_code const &, size_t)> read_handler
The type and signature of the callback passed to the read method.
lib::function< void()> dispatch_handler
The type and signature of the callback passed to the dispatch method.
lib::function< void()> interrupt_handler
The type and signature of the callback passed to the interrupt method.
lib::function< void(lib::error_code const &)> accept_handler
The type and signature of the callback passed to the accept method.
Definition endpoint.hpp:69
lib::function< void(lib::error_code const &)> timer_handler
The type and signature of the callback passed to the read method.
lib::function< void(lib::error_code const &)> connect_handler
The type and signature of the callback passed to the connect method.
Definition endpoint.hpp:72
lib::function< void(lib::error_code const &)> write_handler
The type and signature of the callback passed to the write method.
lib::function< void(lib::error_code const &)> init_handler
The type and signature of the callback passed to the init hook.
lib::function< void(lib::error_code const &)> shutdown_handler
The type and signature of the callback passed to the shutdown method.
Namespace for the WebSocket++ project.
lib::weak_ptr< void > connection_hdl
A handle to uniquely identify a connection.
lib::shared_ptr< uri > uri_ptr
Pointer to a URI.
Definition uri.hpp:352
Server config with asio transport and TLS disabled.
static const long timeout_socket_shutdown
Length of time to wait for socket shutdown.
Definition core.hpp:137
static const long timeout_connect
Length of time to wait for TCP connect.
Definition core.hpp:134
static const long timeout_dns_resolve
Length of time to wait for dns resolution.
Definition core.hpp:131
static const long timeout_proxy
Length of time to wait before a proxy handshake is aborted.
Definition core.hpp:121
static const long timeout_socket_pre_init
Default timer values (in ms)
Definition core.hpp:118
static const long timeout_socket_post_init
Length of time to wait for socket post-initialization.
Definition core.hpp:128
Server config with iostream transport.
Definition core.hpp:68
websocketpp::random::none::int_generator< uint32_t > rng_type
RNG policies.
Definition core.hpp:93
static const websocketpp::log::level elog_level
Default static error logging channels.
Definition core.hpp:176
websocketpp::transport::iostream::endpoint< transport_config > transport_type
Transport Endpoint Component.
Definition core.hpp:142
static const size_t max_http_body_size
Default maximum http body size.
Definition core.hpp:252
static const long timeout_open_handshake
Default timer values (in ms)
Definition core.hpp:152
static const size_t max_message_size
Default maximum message size.
Definition core.hpp:240
websocketpp::log::basic< concurrency_type, websocketpp::log::elevel > elog_type
Logging policies.
Definition core.hpp:88
static const bool drop_on_protocol_error
Drop connections immediately on protocol error.
Definition core.hpp:213
static const long timeout_close_handshake
Length of time before a closing handshake is aborted.
Definition core.hpp:154
static const websocketpp::log::level alog_level
Default static access logging channels.
Definition core.hpp:189
static const long timeout_pong
Length of time to wait for a pong after a ping.
Definition core.hpp:156
static const bool silent_close
Suppresses the return of detailed connection close information.
Definition core.hpp:228
static bool const enable_multithreading
Definition core.hpp:98
static const size_t connection_read_buffer_size
Size of the per-connection read buffer.
Definition core.hpp:204
static const bool enable_extensions
Global flag for enabling/disabling extensions.
Definition core.hpp:255
static const int client_version
WebSocket Protocol version to use as a client.
Definition core.hpp:164
Package of log levels for logging access events.
Definition levels.hpp:112
static level const devel
Development messages (warning: very chatty)
Definition levels.hpp:141
static level const all
Special aggregate value representing "all levels".
Definition levels.hpp:152
Package of log levels for logging errors.
Definition levels.hpp:59
static level const devel
Low level debugging information (warning: very chatty)
Definition levels.hpp:63
static level const all
Special aggregate value representing "all levels".
Definition levels.hpp:80
A simple utility buffer class.
#define _WEBSOCKETPP_ERROR_CODE_ENUM_NS_END_
#define _WEBSOCKETPP_ERROR_CODE_ENUM_NS_START_