Loading...
Searching...
No Matches
base.hpp
/*
* Copyright (c) 2014, Peter Thorson. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the WebSocket++ Project nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL PETER THORSON BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
#ifndef WEBSOCKETPP_TRANSPORT_IOSTREAM_BASE_HPP
#define WEBSOCKETPP_TRANSPORT_IOSTREAM_BASE_HPP
#include <websocketpp/common/system_error.hpp>
#include <websocketpp/common/cpp11.hpp>
#include <websocketpp/common/functional.hpp>
#include <websocketpp/common/connection_hdl.hpp>
#include <websocketpp/transport/base/connection.hpp>
#include <string>
#include <vector>
namespace websocketpp {
namespace transport {
/// Transport policy that uses STL iostream for I/O and does not support timers
namespace iostream {
/// The type and signature of the callback used by iostream transport to write
typedef 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 perform
/// vectored writes.
/**
* If a vectored write handler is not set the standard write handler will be
* called multiple times.
*/
typedef lib::function<lib::error_code(connection_hdl, std::vector<transport::buffer> const
& bufs)> vector_write_handler;
/// The type and signature of the callback used by iostream transport to signal
/// a transport shutdown.
typedef lib::function<lib::error_code(connection_hdl)> shutdown_handler;
/// iostream transport errors
namespace error {
enum value {
/// Catch-all error for transport policy errors that don't fit in other
/// categories
general = 1,
/// async_read_at_least call requested more bytes than buffer can store
invalid_num_bytes,
/// async_read called while another async_read was in progress
double_read,
/// An operation that requires an output stream was attempted before
/// setting one.
output_stream_required,
/// stream error
bad_stream
};
/// iostream transport error category
class category : public lib::error_category {
public:
category() {}
char const * name() const _WEBSOCKETPP_NOEXCEPT_TOKEN_ {
return "websocketpp.transport.iostream";
}
std::string message(int value) const {
switch(value) {
case general:
return "Generic iostream transport policy error";
case invalid_num_bytes:
return "async_read_at_least call requested more bytes than buffer can store";
case double_read:
return "Async read already in progress";
case output_stream_required:
return "An output stream to be set before async_write can be used";
case bad_stream:
return "A stream operation returned ios::bad";
default:
return "Unknown";
}
}
};
/// Get a reference to a static copy of the iostream transport error category
inline lib::error_category const & get_category() {
static category instance;
return instance;
}
/// Get an error code with the given value and the iostream transport category
inline lib::error_code make_error_code(error::value e) {
return lib::error_code(static_cast<int>(e), get_category());
}
} // namespace error
} // namespace iostream
} // namespace transport
} // namespace websocketpp
_WEBSOCKETPP_ERROR_CODE_ENUM_NS_START_
template<> struct is_error_code_enum<websocketpp::transport::iostream::error::value>
{
static bool const value = true;
};
_WEBSOCKETPP_ERROR_CODE_ENUM_NS_END_
#endif // WEBSOCKETPP_TRANSPORT_IOSTREAM_BASE_HPP
_WEBSOCKETPP_CPP11_FUNCTIONAL_
#define _WEBSOCKETPP_CPP11_FUNCTIONAL_
Definition boost_config.hpp:41
_WEBSOCKETPP_CPP11_THREAD_
#define _WEBSOCKETPP_CPP11_THREAD_
Definition boost_config.hpp:61
_WEBSOCKETPP_CPP11_SYSTEM_ERROR_
#define _WEBSOCKETPP_CPP11_SYSTEM_ERROR_
Definition boost_config.hpp:57
broadcast_server
Definition simple_broadcast_server.cpp:13
websocketpp::concurrency::basic
Concurrency policy that uses std::mutex / boost::mutex.
Definition basic.hpp:37
websocketpp::connection_base
Stub for user supplied base class.
Definition connection_base.hpp:34
websocketpp::endpoint_base
Stub for user supplied base class.
Definition endpoint_base.hpp:34
websocketpp::extensions::permessage_deflate::disabled
Stub class for use when disabling permessage_deflate extension.
Definition disabled.hpp:53
websocketpp::http::parser::request
Stores, parses, and manipulates HTTP requests.
Definition request.hpp:50
websocketpp::http::parser::response
Stores, parses, and manipulates HTTP responses.
Definition response.hpp:57
websocketpp::log::basic
Basic logger that outputs to an ostream.
Definition basic.hpp:59
websocketpp::message_buffer::alloc::con_msg_manager
Definition alloc.hpp:43
websocketpp::message_buffer::alloc::endpoint_msg_manager
Definition alloc.hpp:88
websocketpp::random::none::int_generator
Thread safe stub "random" integer generator.
Definition none.hpp:46
websocketpp::server
Server endpoint role based on the given config.
Definition server_endpoint.hpp:44
websocketpp::transport::asio::basic_socket::endpoint
Basic ASIO endpoint socket component.
Definition none.hpp:318
websocketpp::transport::asio::endpoint
Asio based endpoint transport component.
Definition endpoint.hpp:54
websocketpp::transport::iostream::connection
Definition connection.hpp:60
websocketpp::transport::iostream::connection::ptr
lib::shared_ptr< type > ptr
Type of a shared pointer to this connection transport component.
Definition connection.hpp:65
websocketpp::transport::iostream::connection::get_handle
connection_hdl get_handle() const
Get the connection handle.
Definition connection.hpp:313
websocketpp::transport::iostream::connection::alog_type
config::alog_type alog_type
Type of this transport's access logging policy.
Definition connection.hpp:70
websocketpp::transport::iostream::connection::dispatch
lib::error_code dispatch(dispatch_handler handler)
Call given handler back within the transport's event system (if present).
Definition connection.hpp:580
websocketpp::transport::iostream::connection::set_uri
void set_uri(uri_ptr)
Set uri hook.
Definition connection.hpp:121
websocketpp::transport::iostream::connection::async_shutdown
void async_shutdown(transport::shutdown_handler handler)
Perform cleanup on socket shutdown_handler.
Definition connection.hpp:593
websocketpp::transport::iostream::connection::set_write_handler
void set_write_handler(write_handler h)
Sets the write handler.
Definition connection.hpp:350
websocketpp::transport::iostream::connection::set_secure
void set_secure(bool value)
Set whether or not this connection is secure.
Definition connection.hpp:257
websocketpp::transport::iostream::connection::set_shutdown_handler
void set_shutdown_handler(shutdown_handler h)
Sets the shutdown handler.
Definition connection.hpp:400
websocketpp::transport::iostream::connection::type
connection< config > type
Type of this connection transport component.
Definition connection.hpp:63
websocketpp::transport::iostream::connection::elog_type
config::elog_type elog_type
Type of this transport's error logging policy.
Definition connection.hpp:72
websocketpp::transport::iostream::connection::fatal_error
void fatal_error()
Signal transport error.
Definition connection.hpp:235
websocketpp::transport::iostream::connection::read_some
size_t read_some(char const *buf, size_t len)
Manual input supply (read some).
Definition connection.hpp:165
websocketpp::transport::iostream::connection::read_all
size_t read_all(char const *buf, size_t len)
Manual input supply (read all).
Definition connection.hpp:188
websocketpp::transport::iostream::connection::async_write
void async_write(char const *buf, size_t len, transport::write_handler handler)
Asyncronous Transport Write.
Definition connection.hpp:487
websocketpp::transport::iostream::connection::readsome
size_t readsome(char const *buf, size_t len)
Manual input supply (DEPRECATED).
Definition connection.hpp:208
websocketpp::transport::iostream::connection::concurrency_type
config::concurrency_type concurrency_type
transport concurrency policy
Definition connection.hpp:68
websocketpp::transport::iostream::connection::init
void init(init_handler handler)
Initialize the connection transport.
Definition connection.hpp:410
websocketpp::transport::iostream::connection::set_timer
timer_ptr set_timer(long, timer_handler)
Call back a function after a period of time.
Definition connection.hpp:327
websocketpp::transport::iostream::connection::eof
void eof()
Signal EOF.
Definition connection.hpp:219
websocketpp::transport::iostream::connection::operator>>
friend std::istream & operator>>(std::istream &in, type &t)
Overloaded stream input operator.
Definition connection.hpp:142
websocketpp::transport::iostream::connection::set_vector_write_handler
void set_vector_write_handler(vector_write_handler h)
Sets the vectored write handler.
Definition connection.hpp:380
websocketpp::transport::iostream::connection::is_secure
bool is_secure() const
Tests whether or not the underlying transport is secure.
Definition connection.hpp:271
websocketpp::transport::iostream::connection::get_remote_endpoint
std::string get_remote_endpoint() const
Get human readable remote endpoint address.
Definition connection.hpp:305
websocketpp::transport::iostream::connection::set_handle
void set_handle(connection_hdl hdl)
Set Connection Handle.
Definition connection.hpp:565
websocketpp::transport::iostream::connection::register_ostream
void register_ostream(std::ostream *o)
Register a std::ostream with the transport for writing output.
Definition connection.hpp:104
websocketpp::transport::iostream::connection::async_read_at_least
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
websocketpp::transport::iostream::connection::async_write
void async_write(std::vector< buffer > const &bufs, transport::write_handler handler)
Asyncronous Transport Write (scatter-gather).
Definition connection.hpp:527
websocketpp::transport::iostream::connection::get_shared
ptr get_shared()
Get a shared pointer to this component.
Definition connection.hpp:93
websocketpp::transport::iostream::endpoint
Definition endpoint.hpp:46
websocketpp::transport::iostream::endpoint::transport_con_type
iostream::connection< config > transport_con_type
Definition endpoint.hpp:62
websocketpp::transport::iostream::endpoint::elog_type
config::elog_type elog_type
Type of this endpoint's error logging policy.
Definition endpoint.hpp:56
websocketpp::transport::iostream::endpoint::set_write_handler
void set_write_handler(write_handler h)
Sets the write handler.
Definition endpoint.hpp:134
websocketpp::transport::iostream::endpoint::set_shutdown_handler
void set_shutdown_handler(shutdown_handler h)
Sets the shutdown handler.
Definition endpoint.hpp:154
websocketpp::transport::iostream::endpoint::is_secure
bool is_secure() const
Tests whether or not the underlying transport is secure.
Definition endpoint.hpp:116
websocketpp::transport::iostream::endpoint::ptr
lib::shared_ptr< type > ptr
Type of a pointer to this endpoint transport component.
Definition endpoint.hpp:51
websocketpp::transport::iostream::endpoint::transport_con_ptr
transport_con_type::ptr transport_con_ptr
Definition endpoint.hpp:65
websocketpp::transport::iostream::endpoint::async_connect
void async_connect(transport_con_ptr, uri_ptr, connect_handler cb)
Initiate a new connection.
Definition endpoint.hpp:183
websocketpp::transport::iostream::endpoint::init
lib::error_code init(transport_con_ptr tcon)
Initialize a connection.
Definition endpoint.hpp:197
websocketpp::transport::iostream::endpoint::init_logging
void init_logging(lib::shared_ptr< alog_type > a, lib::shared_ptr< elog_type > e)
Initialize logging.
Definition endpoint.hpp:171
websocketpp::transport::iostream::endpoint::type
endpoint type
Type of this endpoint transport component.
Definition endpoint.hpp:49
websocketpp::transport::iostream::endpoint::register_ostream
void register_ostream(std::ostream *o)
Register a default output stream.
Definition endpoint.hpp:80
websocketpp::transport::iostream::endpoint::concurrency_type
config::concurrency_type concurrency_type
Type of this endpoint's concurrency policy.
Definition endpoint.hpp:54
websocketpp::transport::iostream::endpoint::set_secure
void set_secure(bool value)
Set whether or not endpoint can create secure connections.
Definition endpoint.hpp:102
websocketpp::transport::iostream::endpoint::alog_type
config::alog_type alog_type
Type of this endpoint's access logging policy.
Definition endpoint.hpp:58
websocketpp::transport::iostream::error::category
iostream transport error category
Definition base.hpp:85
_WEBSOCKETPP_NOEXCEPT_TOKEN_
#define _WEBSOCKETPP_NOEXCEPT_TOKEN_
Definition cpp11.hpp:115
__has_extension
#define __has_extension
Definition cpp11.hpp:40
__has_feature
#define __has_feature(x)
Definition cpp11.hpp:37
websocketpp::concurrency
Concurrency handling support.
Definition basic.hpp:34
websocketpp::extensions::permessage_deflate
Implementation of RFC 7692, the permessage-deflate WebSocket extension.
Definition disabled.hpp:44
websocketpp::extensions
Definition disabled.hpp:43
websocketpp::http
HTTP handling support.
Definition request.hpp:37
websocketpp::random::none
Stub RNG policy that always returns 0.
Definition none.hpp:35
websocketpp::random
Random number generation policies.
Definition random_device.hpp:34
websocketpp::transport::asio::basic_socket
Definition none.hpp:47
websocketpp::transport::asio
Transport policy that uses asio.
Definition endpoint.hpp:46
websocketpp::transport::error
Generic transport related errors.
Definition connection.hpp:146
websocketpp::transport::error::pass_through
@ pass_through
underlying transport pass through
Definition connection.hpp:153
websocketpp::transport::error::eof
@ eof
End of file.
Definition connection.hpp:168
websocketpp::transport::iostream::error
iostream transport errors
Definition base.hpp:64
websocketpp::transport::iostream::error::value
value
Definition base.hpp:65
websocketpp::transport::iostream::error::general
@ general
Definition base.hpp:68
websocketpp::transport::iostream::error::output_stream_required
@ output_stream_required
Definition base.hpp:78
websocketpp::transport::iostream::error::invalid_num_bytes
@ invalid_num_bytes
async_read_at_least call requested more bytes than buffer can store
Definition base.hpp:71
websocketpp::transport::iostream::error::double_read
@ double_read
async_read called while another async_read was in progress
Definition base.hpp:74
websocketpp::transport::iostream::error::bad_stream
@ bad_stream
stream error
Definition base.hpp:81
websocketpp::transport::iostream::error::make_error_code
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
websocketpp::transport::iostream::error::get_category
lib::error_category const & get_category()
Get a reference to a static copy of the iostream transport error category.
Definition base.hpp:112
websocketpp::transport::iostream
Transport policy that uses STL iostream for I/O and does not support timers.
Definition endpoint.hpp:43
websocketpp::transport::iostream::vector_write_handler
lib::function< lib::error_code(connection_hdl, std::vector< transport::buffer > const &bufs)> vector_write_handler
Definition base.hpp:57
websocketpp::transport::iostream::shutdown_handler
lib::function< lib::error_code(connection_hdl)> shutdown_handler
Definition base.hpp:61
websocketpp::transport::iostream::write_handler
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
websocketpp::transport
Transport policies provide network connectivity and timers.
Definition endpoint.hpp:45
websocketpp::transport::read_handler
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
websocketpp::transport::dispatch_handler
lib::function< void()> dispatch_handler
The type and signature of the callback passed to the dispatch method.
Definition connection.hpp:135
websocketpp::transport::accept_handler
lib::function< void(lib::error_code const &)> accept_handler
The type and signature of the callback passed to the accept method.
Definition endpoint.hpp:80
websocketpp::transport::timer_handler
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
websocketpp::transport::connect_handler
lib::function< void(lib::error_code const &)> connect_handler
The type and signature of the callback passed to the connect method.
Definition endpoint.hpp:83
websocketpp::transport::write_handler
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
websocketpp::transport::init_handler
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
websocketpp::transport::shutdown_handler
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
websocketpp
Namespace for the WebSocket++ project.
Definition asio_no_tls_client.hpp:34
websocketpp::connection_hdl
lib::weak_ptr< void > connection_hdl
A handle to uniquely identify a connection.
Definition connection_hdl.hpp:48
websocketpp::uri_ptr
lib::shared_ptr< uri > uri_ptr
Pointer to a URI.
Definition uri.hpp:791
is_error_code_enum< websocketpp::transport::iostream::error::value >
Definition base.hpp:128
websocketpp::config::asio::transport_config
Definition asio_no_tls.hpp:56
websocketpp::config::asio
Server config with asio transport and TLS disabled.
Definition asio_no_tls.hpp:38
websocketpp::config::core::permessage_deflate_config
Extension specific settings:
Definition core.hpp:260
websocketpp::config::core::permessage_deflate_config::minimum_outgoing_window_bits
static const uint8_t minimum_outgoing_window_bits
Definition core.hpp:272
websocketpp::config::core::permessage_deflate_config::allow_disabling_context_takeover
static const bool allow_disabling_context_takeover
Definition core.hpp:265
websocketpp::config::core::transport_config
Definition core.hpp:100
websocketpp::config::core::transport_config::timeout_socket_shutdown
static const long timeout_socket_shutdown
Length of time to wait for socket shutdown.
Definition core.hpp:137
websocketpp::config::core::transport_config::timeout_connect
static const long timeout_connect
Length of time to wait for TCP connect.
Definition core.hpp:134
websocketpp::config::core::transport_config::timeout_dns_resolve
static const long timeout_dns_resolve
Length of time to wait for dns resolution.
Definition core.hpp:131
websocketpp::config::core::transport_config::timeout_proxy
static const long timeout_proxy
Length of time to wait before a proxy handshake is aborted.
Definition core.hpp:121
websocketpp::config::core::transport_config::timeout_socket_pre_init
static const long timeout_socket_pre_init
Default timer values (in ms).
Definition core.hpp:118
websocketpp::config::core::transport_config::enable_multithreading
static bool const enable_multithreading
Definition core.hpp:110
websocketpp::config::core::transport_config::timeout_socket_post_init
static const long timeout_socket_post_init
Length of time to wait for socket post-initialization.
Definition core.hpp:128
websocketpp::config::core
Server config with iostream transport.
Definition core.hpp:68
websocketpp::config::core::rng_type
websocketpp::random::none::int_generator< uint32_t > rng_type
RNG policies.
Definition core.hpp:93
websocketpp::config::core::elog_level
static const websocketpp::log::level elog_level
Default static error logging channels.
Definition core.hpp:176
websocketpp::config::core::transport_type
websocketpp::transport::iostream::endpoint< transport_config > transport_type
Transport Endpoint Component.
Definition core.hpp:142
websocketpp::config::core::max_http_body_size
static const size_t max_http_body_size
Default maximum http body size.
Definition core.hpp:252
websocketpp::config::core::timeout_open_handshake
static const long timeout_open_handshake
Default timer values (in ms).
Definition core.hpp:152
websocketpp::config::core::max_message_size
static const size_t max_message_size
Default maximum message size.
Definition core.hpp:240
websocketpp::config::core::drop_on_protocol_error
static const bool drop_on_protocol_error
Drop connections immediately on protocol error.
Definition core.hpp:213
websocketpp::config::core::timeout_close_handshake
static const long timeout_close_handshake
Length of time before a closing handshake is aborted.
Definition core.hpp:154
websocketpp::config::core::alog_level
static const websocketpp::log::level alog_level
Default static access logging channels.
Definition core.hpp:189
websocketpp::config::core::elog_type
websocketpp::log::basic< concurrency_type, websocketpp::log::elevel > elog_type
Logging policies.
Definition core.hpp:88
websocketpp::config::core::timeout_pong
static const long timeout_pong
Length of time to wait for a pong after a ping.
Definition core.hpp:156
websocketpp::config::core::silent_close
static const bool silent_close
Suppresses the return of detailed connection close information.
Definition core.hpp:228
websocketpp::config::core::enable_multithreading
static bool const enable_multithreading
Definition core.hpp:98
websocketpp::config::core::connection_read_buffer_size
static const size_t connection_read_buffer_size
Size of the per-connection read buffer.
Definition core.hpp:204
websocketpp::config::core::enable_extensions
static const bool enable_extensions
Global flag for enabling/disabling extensions.
Definition core.hpp:255
websocketpp::config::core::client_version
static const int client_version
WebSocket Protocol version to use as a client.
Definition core.hpp:164
websocketpp::log::alevel
Package of log levels for logging access events.
Definition levels.hpp:112
websocketpp::log::alevel::devel
static level const devel
Development messages (warning: very chatty).
Definition levels.hpp:141
websocketpp::log::alevel::all
static level const all
Special aggregate value representing "all levels".
Definition levels.hpp:152
websocketpp::log::elevel
Package of log levels for logging errors.
Definition levels.hpp:59
websocketpp::log::elevel::devel
static level const devel
Low level debugging information (warning: very chatty).
Definition levels.hpp:63
websocketpp::log::elevel::all
static level const all
Special aggregate value representing "all levels".
Definition levels.hpp:80
websocketpp::transport::iostream::timer
Definition connection.hpp:55
_WEBSOCKETPP_ERROR_CODE_ENUM_NS_END_
#define _WEBSOCKETPP_ERROR_CODE_ENUM_NS_END_
Definition system_error.hpp:78
_WEBSOCKETPP_ERROR_CODE_ENUM_NS_START_
#define _WEBSOCKETPP_ERROR_CODE_ENUM_NS_START_
Definition system_error.hpp:77