WebSocket++ 0.8.2
C++ websocket client/server library
memory.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_COMMON_MEMORY_HPP
29#define WEBSOCKETPP_COMMON_MEMORY_HPP
30
31#include <websocketpp/common/cpp11.hpp>
32
33// If we've determined that we're in full C++11 mode and the user hasn't
34// explicitly disabled the use of C++11 memory header, then prefer it to
35// boost.
36#if defined _WEBSOCKETPP_CPP11_INTERNAL_ && !defined _WEBSOCKETPP_NO_CPP11_MEMORY_
37 #ifndef _WEBSOCKETPP_CPP11_MEMORY_
38 #define _WEBSOCKETPP_CPP11_MEMORY_
39 #endif
40#endif
41
42// If we're on Visual Studio 2010 or higher and haven't explicitly disabled
43// the use of C++11 functional header then prefer it to boost.
44#if defined(_MSC_VER) && _MSC_VER >= 1600 && !defined _WEBSOCKETPP_NO_CPP11_MEMORY_
45 #ifndef _WEBSOCKETPP_CPP11_MEMORY_
46 #define _WEBSOCKETPP_CPP11_MEMORY_
47 #endif
48#endif
49
50
51
53 #include <memory>
54#else
55 #include <boost/shared_ptr.hpp>
56 #include <boost/make_shared.hpp>
57 #include <boost/scoped_array.hpp>
58 #include <boost/enable_shared_from_this.hpp>
59 #include <boost/pointer_cast.hpp>
60#endif
61
62namespace websocketpp {
63namespace lib {
64
66 using std::shared_ptr;
67 using std::weak_ptr;
68 using std::enable_shared_from_this;
69 using std::static_pointer_cast;
70 using std::make_shared;
71 using std::unique_ptr;
72
73 typedef std::unique_ptr<unsigned char[]> unique_ptr_uchar_array;
74#else
75 using boost::shared_ptr;
76 using boost::weak_ptr;
77 using std::auto_ptr;
78 using boost::enable_shared_from_this;
79 using boost::static_pointer_cast;
80 using boost::make_shared;
81
82 typedef boost::scoped_array<unsigned char> unique_ptr_uchar_array;
83#endif
84
85} // namespace lib
86} // namespace websocketpp
87
88#endif // WEBSOCKETPP_COMMON_MEMORY_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: endpoint.hpp:54
lib::shared_ptr< type > ptr
Type of a shared pointer to this connection transport component.
Definition: connection.hpp:65
connection_hdl get_handle() const
Get the connection handle.
Definition: connection.hpp:313
config::alog_type alog_type
Type of this transport's access logging policy.
Definition: connection.hpp:70
lib::error_code dispatch(dispatch_handler handler)
Call given handler back within the transport's event system (if present)
Definition: connection.hpp:580
void async_shutdown(transport::shutdown_handler handler)
Perform cleanup on socket shutdown_handler.
Definition: connection.hpp:593
void set_write_handler(write_handler h)
Sets the write handler.
Definition: connection.hpp:350
void set_secure(bool value)
Set whether or not this connection is secure.
Definition: connection.hpp:257
void set_shutdown_handler(shutdown_handler h)
Sets the shutdown handler.
Definition: connection.hpp:400
connection< config > type
Type of this connection transport component.
Definition: connection.hpp:63
config::elog_type elog_type
Type of this transport's error logging policy.
Definition: connection.hpp:72
void fatal_error()
Signal transport error.
Definition: connection.hpp:235
size_t read_some(char const *buf, size_t len)
Manual input supply (read some)
Definition: connection.hpp:165
size_t read_all(char const *buf, size_t len)
Manual input supply (read all)
Definition: connection.hpp:188
void async_write(char const *buf, size_t len, transport::write_handler handler)
Asyncronous Transport Write.
Definition: connection.hpp:487
size_t readsome(char const *buf, size_t len)
Manual input supply (DEPRECATED)
Definition: connection.hpp:208
config::concurrency_type concurrency_type
transport concurrency policy
Definition: connection.hpp:68
void init(init_handler handler)
Initialize the connection transport.
Definition: connection.hpp:410
timer_ptr set_timer(long, timer_handler)
Call back a function after a period of time.
Definition: connection.hpp:327
void set_remote_endpoint(std::string value)
Set human readable remote endpoint address.
Definition: connection.hpp:289
friend std::istream & operator>>(std::istream &in, type &t)
Overloaded stream input operator.
Definition: connection.hpp:142
void set_vector_write_handler(vector_write_handler h)
Sets the vectored write handler.
Definition: connection.hpp:380
bool is_secure() const
Tests whether or not the underlying transport is secure.
Definition: connection.hpp:271
std::string get_remote_endpoint() const
Get human readable remote endpoint address.
Definition: connection.hpp:305
void set_handle(connection_hdl hdl)
Set Connection Handle.
Definition: connection.hpp:565
void register_ostream(std::ostream *o)
Register a std::ostream with the transport for writing output.
Definition: connection.hpp:104
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.
Definition: connection.hpp:439
void async_write(std::vector< buffer > const &bufs, transport::write_handler handler)
Asyncronous Transport Write (scatter-gather)
Definition: connection.hpp:527
ptr get_shared()
Get a shared pointer to this component.
Definition: connection.hpp:93
iostream::connection< config > transport_con_type
Definition: endpoint.hpp:62
config::elog_type elog_type
Type of this endpoint's error logging policy.
Definition: endpoint.hpp:56
void set_write_handler(write_handler h)
Sets the write handler.
Definition: endpoint.hpp:134
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
lib::shared_ptr< type > ptr
Type of a pointer to this endpoint transport component.
Definition: endpoint.hpp:51
transport_con_type::ptr transport_con_ptr
Definition: endpoint.hpp:65
void async_connect(transport_con_ptr, uri_ptr, connect_handler cb)
Initiate a new connection.
Definition: endpoint.hpp:183
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
void register_ostream(std::ostream *o)
Register a default output stream.
Definition: endpoint.hpp:80
config::concurrency_type concurrency_type
Type of this endpoint's concurrency policy.
Definition: endpoint.hpp:54
void set_secure(bool value)
Set whether or not endpoint can create secure connections.
Definition: endpoint.hpp:102
config::alog_type alog_type
Type of this endpoint's access logging policy.
Definition: endpoint.hpp:58
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.
Definition: connection.hpp:146
@ pass_through
underlying transport pass through
Definition: connection.hpp:153
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.
Definition: connection.hpp:120
lib::function< void()> dispatch_handler
The type and signature of the callback passed to the dispatch method.
Definition: connection.hpp:135
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.
Definition: connection.hpp:126
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.
Definition: connection.hpp:123
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
lib::function< void(lib::error_code const &)> shutdown_handler
The type and signature of the callback passed to the shutdown method.
Definition: connection.hpp:129
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.
Definition: asio_no_tls.hpp:38
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
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
websocketpp::log::basic< concurrency_type, websocketpp::log::elevel > elog_type
Logging policies.
Definition: core.hpp:88
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
#define _WEBSOCKETPP_ERROR_CODE_ENUM_NS_END_
#define _WEBSOCKETPP_ERROR_CODE_ENUM_NS_START_