Merge branch 'ws-fc-updates' into 'latest-fc'

ws-updates

See merge request PBSA/PeerplaysIO/tools-libs/peerplays-fc!18
This commit is contained in:
Bobinson K B 2020-08-12 13:00:39 +00:00
commit fb27454cdf
14 changed files with 217 additions and 147 deletions

View file

@ -2,7 +2,7 @@
#include <functional> #include <functional>
#include <memory> #include <memory>
#include <string> #include <string>
#include <fc/any.hpp> #include <boost/any.hpp>
#include <fc/network/ip.hpp> #include <fc/network/ip.hpp>
#include <fc/signals.hpp> #include <fc/signals.hpp>
@ -26,14 +26,14 @@ namespace fc { namespace http {
void on_message_handler( const std::function<void(const std::string&)>& h ) { _on_message = h; } void on_message_handler( const std::function<void(const std::string&)>& h ) { _on_message = h; }
void on_http_handler( const std::function<std::string(const std::string&)>& h ) { _on_http = h; } void on_http_handler( const std::function<std::string(const std::string&)>& h ) { _on_http = h; }
void set_session_data( fc::any d ){ _session_data = std::move(d); } void set_session_data( boost::any d ){ _session_data = std::move(d); }
fc::any& get_session_data() { return _session_data; } boost::any& get_session_data() { return _session_data; }
virtual std::string get_request_header(const std::string& key) = 0; virtual std::string get_request_header(const std::string& key) = 0;
fc::signal<void()> closed; fc::signal<void()> closed;
private: private:
fc::any _session_data; boost::any _session_data;
std::function<void(const std::string&)> _on_message; std::function<void(const std::string&)> _on_message;
std::function<string(const std::string&)> _on_http; std::function<string(const std::string&)> _on_http;
}; };
@ -53,6 +53,8 @@ namespace fc { namespace http {
uint16_t get_listening_port(); uint16_t get_listening_port();
void start_accept(); void start_accept();
void stop_listening();
void close();
private: private:
friend class detail::websocket_server_impl; friend class detail::websocket_server_impl;
std::unique_ptr<detail::websocket_server_impl> my; std::unique_ptr<detail::websocket_server_impl> my;
@ -70,9 +72,6 @@ namespace fc { namespace http {
void listen( uint16_t port ); void listen( uint16_t port );
void listen( const fc::ip::endpoint& ep ); void listen( const fc::ip::endpoint& ep );
void start_accept(); void start_accept();
uint16_t get_listening_port();
void stop_listening();
void close();
private: private:
friend class detail::websocket_tls_server_impl; friend class detail::websocket_tls_server_impl;
@ -87,6 +86,10 @@ namespace fc { namespace http {
websocket_connection_ptr connect( const std::string& uri ); websocket_connection_ptr connect( const std::string& uri );
websocket_connection_ptr secure_connect( const std::string& uri ); websocket_connection_ptr secure_connect( const std::string& uri );
void close();
void synchronous_close();
private: private:
std::unique_ptr<detail::websocket_client_impl> my; std::unique_ptr<detail::websocket_client_impl> my;
std::unique_ptr<detail::websocket_tls_client_impl> smy; std::unique_ptr<detail::websocket_tls_client_impl> smy;

View file

@ -10,7 +10,7 @@ namespace fc { namespace rpc {
class websocket_api_connection : public api_connection class websocket_api_connection : public api_connection
{ {
public: public:
websocket_api_connection( fc::http::websocket_connection& c, uint32_t max_conversion_depth ); websocket_api_connection(const std::shared_ptr<fc::http::websocket_connection> &c, uint32_t max_conversion_depth );
~websocket_api_connection(); ~websocket_api_connection();
virtual variant send_call( virtual variant send_call(
@ -29,7 +29,7 @@ namespace fc { namespace rpc {
const std::string& message, const std::string& message,
bool send_message = true ); bool send_message = true );
fc::http::websocket_connection& _connection; std::shared_ptr<fc::http::websocket_connection> _connection;
fc::rpc::state _rpc_state; fc::rpc::state _rpc_state;
}; };

View file

@ -148,7 +148,7 @@ namespace fc { namespace http {
:_ws_connection(con){ :_ws_connection(con){
} }
~websocket_connection_impl() virtual ~websocket_connection_impl()
{ {
} }
@ -401,18 +401,20 @@ namespace fc { namespace http {
typedef websocket_client_type::connection_ptr websocket_client_connection_type; typedef websocket_client_type::connection_ptr websocket_client_connection_type;
typedef websocket_tls_client_type::connection_ptr websocket_tls_client_connection_type; typedef websocket_tls_client_type::connection_ptr websocket_tls_client_connection_type;
class websocket_client_impl using websocketpp::connection_hdl;
template<typename T>
class generic_websocket_client_impl
{ {
public: public:
typedef websocket_client_type::message_ptr message_ptr; generic_websocket_client_impl()
websocket_client_impl()
:_client_thread( fc::thread::current() ) :_client_thread( fc::thread::current() )
{ {
_client.clear_access_channels( websocketpp::log::alevel::all ); _client.clear_access_channels( websocketpp::log::alevel::all );
_client.set_message_handler( [&]( connection_hdl hdl, message_ptr msg ){ _client.set_message_handler( [&]( connection_hdl hdl,
typename websocketpp::client<T>::message_ptr msg ){
_client_thread.async( [&](){ _client_thread.async( [&](){
idump((msg->get_payload())); wdump((msg->get_payload()));
//std::cerr<<"recv: "<<msg->get_payload()<<"\n"; //std::cerr<<"recv: "<<msg->get_payload()<<"\n";
auto received = msg->get_payload(); auto received = msg->get_payload();
fc::async( [=](){ fc::async( [=](){
@ -438,74 +440,40 @@ namespace fc { namespace http {
_client.init_asio( &fc::asio::default_io_service() ); _client.init_asio( &fc::asio::default_io_service() );
} }
~websocket_client_impl() virtual ~generic_websocket_client_impl()
{ {
if(_connection ) if( _connection )
{ {
_connection->close(0, "client closed"); _connection->close(0, "client closed");
_connection.reset(); _connection.reset();
_closed->wait();
} }
if( _closed )
_closed->wait();
} }
fc::promise<void>::ptr _connected; fc::promise<void>::ptr _connected;
fc::promise<void>::ptr _closed; fc::promise<void>::ptr _closed;
fc::thread& _client_thread; fc::thread& _client_thread;
websocket_client_type _client; websocketpp::client<T> _client;
websocket_connection_ptr _connection; websocket_connection_ptr _connection;
std::string _uri; std::string _uri;
fc::optional<connection_hdl> _hdl;
}; };
class websocket_client_impl : public generic_websocket_client_impl<asio_with_stub_log>
{};
class websocket_tls_client_impl class websocket_tls_client_impl : public generic_websocket_client_impl<asio_tls_stub_log>
{ {
public: public:
typedef websocket_tls_client_type::message_ptr message_ptr;
websocket_tls_client_impl( const std::string& ca_filename ) websocket_tls_client_impl( const std::string& ca_filename )
:_client_thread( fc::thread::current() ) : generic_websocket_client_impl()
{ {
// ca_filename has special values: // ca_filename has special values:
// "_none" disables cert checking (potentially insecure!) // "_none" disables cert checking (potentially insecure!)
// "_default" uses default CA's provided by OS // "_default" uses default CA's provided by OS
_client.clear_access_channels( websocketpp::log::alevel::all );
_client.set_message_handler( [&]( connection_hdl hdl, message_ptr msg ){
_client_thread.async( [&](){
idump((msg->get_payload()));
_connection->on_message( msg->get_payload() );
}).wait();
});
_client.set_close_handler( [=]( connection_hdl hdl ){
if( _connection )
{
try {
_client_thread.async( [&](){
ilog(". ${p}", ("p",uint64_t(_connection.get())));
if( !_shutting_down && !_closed && _connection )
_connection->closed();
_connection.reset();
} ).wait();
} catch ( const fc::exception& e )
{
if( _closed ) _closed->set_exception( e.dynamic_copy_exception() );
}
if( _closed ) _closed->set_value();
}
});
_client.set_fail_handler( [=]( connection_hdl hdl ){
elog( "." );
auto con = _client.get_con_from_hdl(hdl);
auto message = con->get_ec().message();
if( _connection )
_client_thread.async( [&](){ if( _connection ) _connection->closed(); _connection.reset(); } ).wait();
if( _connected && !_connected->ready() )
_connected->set_exception( exception_ptr( new FC_EXCEPTION( exception, "${message}", ("message",message)) ) );
if( _closed )
_closed->set_value();
});
// //
// We need ca_filename to be copied into the closure, as the referenced object might be destroyed by the caller by the time // We need ca_filename to be copied into the closure, as the referenced object might be destroyed by the caller by the time
// tls_init_handler() is called. According to [1], capture-by-value results in the desired behavior (i.e. creation of // tls_init_handler() is called. According to [1], capture-by-value results in the desired behavior (i.e. creation of
@ -538,18 +506,8 @@ namespace fc { namespace http {
return ctx; return ctx;
}); });
_client.init_asio( &fc::asio::default_io_service() );
}
~websocket_tls_client_impl()
{
if(_connection )
{
ilog(".");
_shutting_down = true;
_connection->close(0, "client closed");
_closed->wait();
}
} }
virtual ~websocket_tls_client_impl() {}
std::string get_host()const std::string get_host()const
{ {
@ -562,20 +520,19 @@ namespace fc { namespace http {
return; return;
ctx->set_verify_mode( boost::asio::ssl::verify_peer ); ctx->set_verify_mode( boost::asio::ssl::verify_peer );
if( ca_filename == "_default" ) if( ca_filename == "_default" )
{
#if WIN32
add_windows_root_certs( *ctx );
#else
ctx->set_default_verify_paths(); ctx->set_default_verify_paths();
#endif
}
else else
ctx->load_verify_file( ca_filename ); ctx->load_verify_file( ca_filename );
ctx->set_verify_depth(10); ctx->set_verify_depth(10);
ctx->set_verify_callback( boost::asio::ssl::rfc2818_verification( get_host() ) ); ctx->set_verify_callback( boost::asio::ssl::rfc2818_verification( get_host() ) );
} }
bool _shutting_down = false;
fc::promise<void>::ptr _connected;
fc::promise<void>::ptr _closed;
fc::thread& _client_thread;
websocket_tls_client_type _client;
websocket_connection_ptr _connection;
std::string _uri;
}; };
@ -608,8 +565,16 @@ namespace fc { namespace http {
my->_server.start_accept(); my->_server.start_accept();
} }
void websocket_server::stop_listening()
{
my->_server.stop_listening();
}
void websocket_server::close()
{
for (auto& connection : my->_connections)
my->_server.close(connection.first, websocketpp::close::status::normal, "Goodbye");
}
websocket_tls_server::websocket_tls_server( const string& server_pem, const string& ssl_password ):my( new detail::websocket_tls_server_impl(server_pem, ssl_password) ) {} websocket_tls_server::websocket_tls_server( const string& server_pem, const string& ssl_password ):my( new detail::websocket_tls_server_impl(server_pem, ssl_password) ) {}
websocket_tls_server::~websocket_tls_server(){} websocket_tls_server::~websocket_tls_server(){}
@ -632,25 +597,6 @@ namespace fc { namespace http {
my->_server.start_accept(); my->_server.start_accept();
} }
uint16_t websocket_tls_server::get_listening_port()
{
websocketpp::lib::asio::error_code ec;
return my->_server.get_local_endpoint(ec).port();
}
void websocket_tls_server::stop_listening()
{
my->_server.stop_listening();
}
void websocket_tls_server::close()
{
websocketpp::lib::error_code ec;
for( auto& connection : my->_connections )
my->_server.close( connection.first, websocketpp::close::status::normal, "Goodbye", ec );
}
websocket_tls_client::websocket_tls_client( const std::string& ca_filename ):my( new detail::websocket_tls_client_impl( ca_filename ) ) {} websocket_tls_client::websocket_tls_client( const std::string& ca_filename ):my( new detail::websocket_tls_client_impl( ca_filename ) ) {}
websocket_tls_client::~websocket_tls_client(){ } websocket_tls_client::~websocket_tls_client(){ }
@ -714,6 +660,19 @@ namespace fc { namespace http {
return smy->_connection; return smy->_connection;
} FC_CAPTURE_AND_RETHROW( (uri) ) } } FC_CAPTURE_AND_RETHROW( (uri) ) }
void websocket_client::close()
{
if (my->_hdl)
my->_client.close(*my->_hdl, websocketpp::close::status::normal, "Goodbye");
}
void websocket_client::synchronous_close()
{
close();
if (my->_closed)
my->_closed->wait();
}
websocket_connection_ptr websocket_tls_client::connect( const std::string& uri ) websocket_connection_ptr websocket_tls_client::connect( const std::string& uri )
{ try { { try {
// wlog( "connecting to ${uri}", ("uri",uri)); // wlog( "connecting to ${uri}", ("uri",uri));

View file

@ -7,7 +7,7 @@ websocket_api_connection::~websocket_api_connection()
{ {
} }
websocket_api_connection::websocket_api_connection( fc::http::websocket_connection& c, uint32_t max_depth ) websocket_api_connection::websocket_api_connection(const std::shared_ptr<fc::http::websocket_connection>& c, uint32_t max_depth )
: api_connection(max_depth),_connection(c) : api_connection(max_depth),_connection(c)
{ {
_rpc_state.add_method( "call", [this]( const variants& args ) -> variant _rpc_state.add_method( "call", [this]( const variants& args ) -> variant
@ -47,9 +47,12 @@ websocket_api_connection::websocket_api_connection( fc::http::websocket_connecti
return this->receive_call( 0, method_name, args ); return this->receive_call( 0, method_name, args );
} ); } );
_connection.on_message_handler( [&]( const std::string& msg ){ on_message(msg,true); } ); _connection->on_message_handler( [&]( const std::string& msg ){ on_message(msg,true); } );
_connection.on_http_handler( [&]( const std::string& msg ){ return on_message(msg,false); } ); _connection->on_http_handler( [&]( const std::string& msg ){ return on_message(msg,false); } );
_connection.closed.connect( [this](){ closed(); } ); _connection->closed.connect( [this](){
closed();
_connection = nullptr;
} );
} }
variant websocket_api_connection::send_call( variant websocket_api_connection::send_call(
@ -58,7 +61,7 @@ variant websocket_api_connection::send_call(
variants args /* = variants() */ ) variants args /* = variants() */ )
{ {
auto request = _rpc_state.start_remote_call( "call", {api_id, std::move(method_name), std::move(args) } ); auto request = _rpc_state.start_remote_call( "call", {api_id, std::move(method_name), std::move(args) } );
_connection.send_message( fc::json::to_string(fc::variant(request, _max_conversion_depth), _connection->send_message( fc::json::to_string(fc::variant(request, _max_conversion_depth),
fc::json::stringify_large_ints_and_doubles, _max_conversion_depth ) ); fc::json::stringify_large_ints_and_doubles, _max_conversion_depth ) );
return _rpc_state.wait_for_response( *request.id ); return _rpc_state.wait_for_response( *request.id );
} }
@ -68,7 +71,7 @@ variant websocket_api_connection::send_callback(
variants args /* = variants() */ ) variants args /* = variants() */ )
{ {
auto request = _rpc_state.start_remote_call( "callback", {callback_id, std::move(args) } ); auto request = _rpc_state.start_remote_call( "callback", {callback_id, std::move(args) } );
_connection.send_message( fc::json::to_string(fc::variant(request, _max_conversion_depth), _connection->send_message( fc::json::to_string(fc::variant(request, _max_conversion_depth),
fc::json::stringify_large_ints_and_doubles, _max_conversion_depth ) ); fc::json::stringify_large_ints_and_doubles, _max_conversion_depth ) );
return _rpc_state.wait_for_response( *request.id ); return _rpc_state.wait_for_response( *request.id );
} }
@ -78,7 +81,7 @@ void websocket_api_connection::send_notice(
variants args /* = variants() */ ) variants args /* = variants() */ )
{ {
fc::rpc::request req{ optional<uint64_t>(), "notice", {callback_id, std::move(args)}}; fc::rpc::request req{ optional<uint64_t>(), "notice", {callback_id, std::move(args)}};
_connection.send_message( fc::json::to_string(fc::variant(req, _max_conversion_depth), _connection->send_message( fc::json::to_string(fc::variant(req, _max_conversion_depth),
fc::json::stringify_large_ints_and_doubles, _max_conversion_depth ) ); fc::json::stringify_large_ints_and_doubles, _max_conversion_depth ) );
} }
@ -118,7 +121,7 @@ std::string websocket_api_connection::on_message(
{ {
auto reply = fc::json::to_string( response( *call.id, result, "2.0" ), fc::json::stringify_large_ints_and_doubles, _max_conversion_depth ); auto reply = fc::json::to_string( response( *call.id, result, "2.0" ), fc::json::stringify_large_ints_and_doubles, _max_conversion_depth );
if( send_message ) if( send_message )
_connection.send_message( reply ); _connection->send_message( reply );
return reply; return reply;
} }
} }
@ -136,7 +139,7 @@ std::string websocket_api_connection::on_message(
auto reply = fc::json::to_string( variant(response( *call.id, error_object{ 1, optexcept->to_string(), fc::variant(*optexcept, _max_conversion_depth)}, "2.0" ), _max_conversion_depth ), auto reply = fc::json::to_string( variant(response( *call.id, error_object{ 1, optexcept->to_string(), fc::variant(*optexcept, _max_conversion_depth)}, "2.0" ), _max_conversion_depth ),
fc::json::stringify_large_ints_and_doubles, _max_conversion_depth ); fc::json::stringify_large_ints_and_doubles, _max_conversion_depth );
if( send_message ) if( send_message )
_connection.send_message( reply ); _connection->send_message( reply );
return reply; return reply;
} }

View file

@ -61,7 +61,7 @@ int main( int argc, char** argv )
fc::http::websocket_server server; fc::http::websocket_server server;
server.on_connection([&]( const websocket_connection_ptr& c ){ server.on_connection([&]( const websocket_connection_ptr& c ){
auto wsc = std::make_shared<websocket_api_connection>(*c, MAX_DEPTH); auto wsc = std::make_shared<websocket_api_connection>(c, MAX_DEPTH);
auto login = std::make_shared<login_api>(); auto login = std::make_shared<login_api>();
login->calc = calc_api; login->calc = calc_api;
wsc->register_api(fc::api<login_api>(login)); wsc->register_api(fc::api<login_api>(login));
@ -76,7 +76,7 @@ int main( int argc, char** argv )
try { try {
fc::http::websocket_client client; fc::http::websocket_client client;
auto con = client.connect( "ws://localhost:8090" ); auto con = client.connect( "ws://localhost:8090" );
auto apic = std::make_shared<websocket_api_connection>(*con, MAX_DEPTH); auto apic = std::make_shared<websocket_api_connection>(con, MAX_DEPTH);
auto remote_login_api = apic->get_remote_api<login_api>(); auto remote_login_api = apic->get_remote_api<login_api>();
auto remote_calc = remote_login_api->get_calc(); auto remote_calc = remote_login_api->get_calc();
remote_calc->on_result( []( uint32_t r ) { elog( "callback result ${r}", ("r",r) ); } ); remote_calc->on_result( []( uint32_t r ) { elog( "callback result ${r}", ("r",r) ); } );

View file

@ -1,4 +1,7 @@
HEAD HEAD
- Bug: Change default listen backlog from 0 to socket_base::max_connections.
#549. Thank you derwassi and zwelab for reporting and na1pir for providing
access to hardware to debug the issue.
0.7.0 - 2016-02-22 0.7.0 - 2016-02-22
- MINOR BREAKING SOCKET POLICY CHANGE: Asio transport socket policy method - MINOR BREAKING SOCKET POLICY CHANGE: Asio transport socket policy method

View file

@ -30,6 +30,8 @@
#include "connection_tu2.hpp" #include "connection_tu2.hpp"
#include <algorithm>
// Include special debugging transport // Include special debugging transport
//#include <websocketpp/config/minimal_client.hpp> //#include <websocketpp/config/minimal_client.hpp>
#include <websocketpp/transport/debug/endpoint.hpp> #include <websocketpp/transport/debug/endpoint.hpp>
@ -172,6 +174,20 @@ void http_func(server* s, websocketpp::connection_hdl hdl) {
BOOST_CHECK_EQUAL(con->get_response_msg(), status_code::get_string(status_code::ok)); BOOST_CHECK_EQUAL(con->get_response_msg(), status_code::get_string(status_code::ok));
} }
void http_func_with_move(server* s, websocketpp::connection_hdl hdl) {
using namespace websocketpp::http;
server::connection_ptr con = s->get_con_from_hdl(hdl);
std::string res = con->get_resource();
con->set_body( std::move(res) );
con->set_status(status_code::ok);
BOOST_CHECK_EQUAL(con->get_response_code(), status_code::ok);
BOOST_CHECK_EQUAL(con->get_response_msg(), status_code::get_string(status_code::ok));
}
void defer_http_func(server* s, bool * deferred, websocketpp::connection_hdl hdl) { void defer_http_func(server* s, bool * deferred, websocketpp::connection_hdl hdl) {
*deferred = true; *deferred = true;
@ -237,6 +253,18 @@ BOOST_AUTO_TEST_CASE( http_request ) {
BOOST_CHECK_EQUAL(run_server_test(s,input), output); BOOST_CHECK_EQUAL(run_server_test(s,input), output);
} }
BOOST_AUTO_TEST_CASE( http_request_with_move ) {
std::string input = "GET /foo/bar HTTP/1.1\r\nHost: www.example.com\r\nOrigin: http://www.example.com\r\n\r\n";
std::string output = "HTTP/1.1 200 OK\r\nContent-Length: 8\r\nServer: ";
output+=websocketpp::user_agent;
output+="\r\n\r\n/foo/bar";
server s;
s.set_http_handler(bind(&http_func_with_move,&s,::_1));
BOOST_CHECK_EQUAL(run_server_test(s,input), output);
}
BOOST_AUTO_TEST_CASE( deferred_http_request ) { BOOST_AUTO_TEST_CASE( deferred_http_request ) {
std::string input = "GET /foo/bar HTTP/1.1\r\nHost: www.example.com\r\nOrigin: http://www.example.com\r\n\r\n"; std::string input = "GET /foo/bar HTTP/1.1\r\nHost: www.example.com\r\nOrigin: http://www.example.com\r\n\r\n";
std::string output = "HTTP/1.1 200 OK\r\nContent-Length: 8\r\nServer: "; std::string output = "HTTP/1.1 200 OK\r\nContent-Length: 8\r\nServer: ";

View file

@ -1041,6 +1041,7 @@ public:
* @see websocketpp::http::response::set_body * @see websocketpp::http::response::set_body
*/ */
void set_body(std::string const & value); void set_body(std::string const & value);
void set_body( std::string&& value );
/// Append a header /// Append a header
/** /**

View file

@ -32,6 +32,7 @@
#include <websocketpp/common/cpp11.hpp> #include <websocketpp/common/cpp11.hpp>
#include <websocketpp/common/memory.hpp> #include <websocketpp/common/memory.hpp>
#include <websocketpp/common/platforms.hpp> #include <websocketpp/common/platforms.hpp>
#include <websocketpp/common/stdint.hpp>
#include <websocketpp/common/system_error.hpp> #include <websocketpp/common/system_error.hpp>
#include <websocketpp/error.hpp> #include <websocketpp/error.hpp>
@ -46,7 +47,7 @@
namespace websocketpp { namespace websocketpp {
namespace extensions { namespace extensions {
/// Implementation of the draft permessage-deflate WebSocket extension /// Implementation of RFC 7692, the permessage-deflate WebSocket extension
/** /**
* ### permessage-deflate interface * ### permessage-deflate interface
* *
@ -174,18 +175,30 @@ namespace websocketpp {
namespace extensions { namespace extensions {
namespace permessage_deflate { namespace permessage_deflate {
/// Default value for server_max_window_bits as defined by draft 17 /// Default value for server_max_window_bits as defined by RFC 7692
static uint8_t const default_server_max_window_bits = 15; static uint8_t const default_server_max_window_bits = 15;
/// Minimum value for server_max_window_bits as defined by draft 17 /// Minimum value for server_max_window_bits as defined by RFC 7692
/**
* NOTE: A value of 8 is not actually supported by zlib, the deflate
* library that WebSocket++ uses. To preserve backwards compatibility
* with RFC 7692 and previous versions of the library a value of 8
* is accepted by the library but will always be negotiated as 9.
*/
static uint8_t const min_server_max_window_bits = 8; static uint8_t const min_server_max_window_bits = 8;
/// Maximum value for server_max_window_bits as defined by draft 17 /// Maximum value for server_max_window_bits as defined by RFC 7692
static uint8_t const max_server_max_window_bits = 15; static uint8_t const max_server_max_window_bits = 15;
/// Default value for client_max_window_bits as defined by draft 17 /// Default value for client_max_window_bits as defined by RFC 7692
static uint8_t const default_client_max_window_bits = 15; static uint8_t const default_client_max_window_bits = 15;
/// Minimum value for client_max_window_bits as defined by draft 17 /// Minimum value for client_max_window_bits as defined by RFC 7692
/**
* NOTE: A value of 8 is not actually supported by zlib, the deflate
* library that WebSocket++ uses. To preserve backwards compatibility
* with RFC 7692 and previous versions of the library a value of 8
* is accepted by the library but will always be negotiated as 9.
*/
static uint8_t const min_client_max_window_bits = 8; static uint8_t const min_client_max_window_bits = 8;
/// Maximum value for client_max_window_bits as defined by draft 17 /// Maximum value for client_max_window_bits as defined by RFC 7692
static uint8_t const max_client_max_window_bits = 15; static uint8_t const max_client_max_window_bits = 15;
namespace mode { namespace mode {
@ -213,7 +226,7 @@ public:
, m_server_max_window_bits_mode(mode::accept) , m_server_max_window_bits_mode(mode::accept)
, m_client_max_window_bits_mode(mode::accept) , m_client_max_window_bits_mode(mode::accept)
, m_initialized(false) , m_initialized(false)
, m_compress_buffer_size(16384) , m_compress_buffer_size(8192)
{ {
m_dstate.zalloc = Z_NULL; m_dstate.zalloc = Z_NULL;
m_dstate.zfree = Z_NULL; m_dstate.zfree = Z_NULL;
@ -292,6 +305,7 @@ public:
} }
m_compress_buffer.reset(new unsigned char[m_compress_buffer_size]); m_compress_buffer.reset(new unsigned char[m_compress_buffer_size]);
m_decompress_buffer.reset(new unsigned char[m_compress_buffer_size]);
if ((m_server_no_context_takeover && is_server) || if ((m_server_no_context_takeover && is_server) ||
(m_client_no_context_takeover && !is_server)) (m_client_no_context_takeover && !is_server))
{ {
@ -372,7 +386,7 @@ public:
/** /**
* The bits setting is the base 2 logarithm of the maximum window size that * The bits setting is the base 2 logarithm of the maximum window size that
* the server must use to compress outgoing messages. The permitted range * the server must use to compress outgoing messages. The permitted range
* is 8 to 15 inclusive. 8 represents a 256 byte window and 15 a 32KiB * is 9 to 15 inclusive. 9 represents a 512 byte window and 15 a 32KiB
* window. The default setting is 15. * window. The default setting is 15.
* *
* Mode Options: * Mode Options:
@ -386,6 +400,14 @@ public:
* adjusted by the server. A server may unilaterally set this value without * adjusted by the server. A server may unilaterally set this value without
* client support. * client support.
* *
* NOTE: The permessage-deflate spec specifies that a value of 8 is allowed.
* Prior to version 0.8.0 a value of 8 was also allowed by this library.
* zlib, the deflate compression library that WebSocket++ uses has always
* silently adjusted a value of 8 to 9. In recent versions of zlib (1.2.9
* and greater) a value of 8 is now explicitly rejected. WebSocket++ 0.8.0
* continues to perform the 8->9 conversion for backwards compatibility
* purposes but this should be considered deprecated functionality.
*
* @param bits The size to request for the outgoing window size * @param bits The size to request for the outgoing window size
* @param mode The mode to use for negotiating this parameter * @param mode The mode to use for negotiating this parameter
* @return A status code * @return A status code
@ -394,6 +416,12 @@ public:
if (bits < min_server_max_window_bits || bits > max_server_max_window_bits) { if (bits < min_server_max_window_bits || bits > max_server_max_window_bits) {
return error::make_error_code(error::invalid_max_window_bits); return error::make_error_code(error::invalid_max_window_bits);
} }
// See note in doc comment above about what is happening here
if (bits == 8) {
bits = 9;
}
m_server_max_window_bits = bits; m_server_max_window_bits = bits;
m_server_max_window_bits_mode = mode; m_server_max_window_bits_mode = mode;
@ -403,8 +431,8 @@ public:
/// Limit client LZ77 sliding window size /// Limit client LZ77 sliding window size
/** /**
* The bits setting is the base 2 logarithm of the window size that the * The bits setting is the base 2 logarithm of the window size that the
* client must use to compress outgoing messages. The permitted range is 8 * client must use to compress outgoing messages. The permitted range is 9
* to 15 inclusive. 8 represents a 256 byte window and 15 a 32KiB window. * to 15 inclusive. 9 represents a 512 byte window and 15 a 32KiB window.
* The default setting is 15. * The default setting is 15.
* *
* Mode Options: * Mode Options:
@ -417,6 +445,14 @@ public:
* outgoing window size unilaterally. A server may only limit the client's * outgoing window size unilaterally. A server may only limit the client's
* window size if the remote client supports that feature. * window size if the remote client supports that feature.
* *
* NOTE: The permessage-deflate spec specifies that a value of 8 is allowed.
* Prior to version 0.8.0 a value of 8 was also allowed by this library.
* zlib, the deflate compression library that WebSocket++ uses has always
* silently adjusted a value of 8 to 9. In recent versions of zlib (1.2.9
* and greater) a value of 8 is now explicitly rejected. WebSocket++ 0.8.0
* continues to perform the 8->9 conversion for backwards compatibility
* purposes but this should be considered deprecated functionality.
*
* @param bits The size to request for the outgoing window size * @param bits The size to request for the outgoing window size
* @param mode The mode to use for negotiating this parameter * @param mode The mode to use for negotiating this parameter
* @return A status code * @return A status code
@ -425,6 +461,12 @@ public:
if (bits < min_client_max_window_bits || bits > max_client_max_window_bits) { if (bits < min_client_max_window_bits || bits > max_client_max_window_bits) {
return error::make_error_code(error::invalid_max_window_bits); return error::make_error_code(error::invalid_max_window_bits);
} }
// See note in doc comment above about what is happening here
if (bits == 8) {
bits = 9;
}
m_client_max_window_bits = bits; m_client_max_window_bits = bits;
m_client_max_window_bits_mode = mode; m_client_max_window_bits_mode = mode;
@ -555,7 +597,7 @@ public:
do { do {
m_istate.avail_out = m_compress_buffer_size; m_istate.avail_out = m_compress_buffer_size;
m_istate.next_out = m_compress_buffer.get(); m_istate.next_out = m_decompress_buffer.get();
ret = inflate(&m_istate, Z_SYNC_FLUSH); ret = inflate(&m_istate, Z_SYNC_FLUSH);
@ -564,7 +606,7 @@ public:
} }
out.append( out.append(
reinterpret_cast<char *>(m_compress_buffer.get()), reinterpret_cast<char *>(m_decompress_buffer.get()),
m_compress_buffer_size - m_istate.avail_out m_compress_buffer_size - m_istate.avail_out
); );
} while (m_istate.avail_out == 0); } while (m_istate.avail_out == 0);
@ -642,11 +684,17 @@ private:
* client requested that we use. * client requested that we use.
* *
* options: * options:
* - decline (refuse to use the attribute) * - decline (ignore value, offer our default instead)
* - accept (use whatever the client says) * - accept (use the value requested by the client)
* - largest (use largest possible value) * - largest (use largest value acceptable to both)
* - smallest (use smallest possible value) * - smallest (use smallest possible value)
* *
* NOTE: As a value of 8 is no longer explicitly supported by zlib but might
* be requested for negotiation by an older client/server, if the result of
* the negotiation would be to send a value of 8, a value of 9 is offered
* instead. This ensures that WebSocket++ will only ever negotiate connections
* with compression settings explicitly supported by zlib.
*
* @param [in] value The value of the attribute from the offer * @param [in] value The value of the attribute from the offer
* @param [out] ec A reference to the error code to return errors via * @param [out] ec A reference to the error code to return errors via
*/ */
@ -678,6 +726,11 @@ private:
ec = make_error_code(error::invalid_mode); ec = make_error_code(error::invalid_mode);
m_server_max_window_bits = default_server_max_window_bits; m_server_max_window_bits = default_server_max_window_bits;
} }
// See note in doc comment
if (m_server_max_window_bits == 8) {
m_server_max_window_bits = 9;
}
} }
/// Negotiate client_max_window_bits attribute /// Negotiate client_max_window_bits attribute
@ -687,11 +740,17 @@ private:
* negotiation mode. * negotiation mode.
* *
* options: * options:
* - decline (refuse to use the attribute) * - decline (ignore value, offer our default instead)
* - accept (use whatever the client says) * - accept (use the value requested by the client)
* - largest (use largest possible value) * - largest (use largest value acceptable to both)
* - smallest (use smallest possible value) * - smallest (use smallest possible value)
* *
* NOTE: As a value of 8 is no longer explicitly supported by zlib but might
* be requested for negotiation by an older client/server, if the result of
* the negotiation would be to send a value of 8, a value of 9 is offered
* instead. This ensures that WebSocket++ will only ever negotiate connections
* with compression settings explicitly supported by zlib.
*
* @param [in] value The value of the attribute from the offer * @param [in] value The value of the attribute from the offer
* @param [out] ec A reference to the error code to return errors via * @param [out] ec A reference to the error code to return errors via
*/ */
@ -727,6 +786,11 @@ private:
ec = make_error_code(error::invalid_mode); ec = make_error_code(error::invalid_mode);
m_client_max_window_bits = default_client_max_window_bits; m_client_max_window_bits = default_client_max_window_bits;
} }
// See note in doc comment
if (m_client_max_window_bits == 8) {
m_client_max_window_bits = 9;
}
} }
bool m_enabled; bool m_enabled;
@ -741,6 +805,7 @@ private:
int m_flush; int m_flush;
size_t m_compress_buffer_size; size_t m_compress_buffer_size;
lib::unique_ptr_uchar_array m_compress_buffer; lib::unique_ptr_uchar_array m_compress_buffer;
lib::unique_ptr_uchar_array m_decompress_buffer;
z_stream m_dstate; z_stream m_dstate;
z_stream m_istate; z_stream m_istate;
}; };
@ -750,3 +815,4 @@ private:
} // namespace websocketpp } // namespace websocketpp
#endif // WEBSOCKETPP_PROCESSOR_EXTENSION_PERMESSAGEDEFLATE_HPP #endif // WEBSOCKETPP_PROCESSOR_EXTENSION_PERMESSAGEDEFLATE_HPP

View file

@ -575,6 +575,17 @@ void connection<config>::set_body(std::string const & value) {
m_response.set_body(value); m_response.set_body(value);
} }
template <typename config>
void connection<config>::set_body( std::string&& value )
{
if (m_internal_state != istate::PROCESS_HTTP_REQUEST) {
throw exception("Call to set_status from invalid state",
error::make_error_code(error::invalid_state));
}
m_response.set_body(std::move(value));
}
// TODO: EXCEPTION_FREE // TODO: EXCEPTION_FREE
template <typename config> template <typename config>
void connection<config>::append_header(std::string const & key, void connection<config>::append_header(std::string const & key,

View file

@ -311,10 +311,10 @@ public:
* needed. * needed.
*/ */
timer_ptr set_timer(long duration, timer_handler callback) { timer_ptr set_timer(long duration, timer_handler callback) {
timer_ptr new_timer = lib::make_shared<lib::asio::steady_timer>( timer_ptr new_timer(
lib::ref(*m_io_service), new lib::asio::steady_timer(
lib::asio::milliseconds(duration) *m_io_service,
); lib::asio::milliseconds(duration)));
if (config::enable_multithreading) { if (config::enable_multithreading) {
new_timer->async_wait(m_strand->wrap(lib::bind( new_timer->async_wait(m_strand->wrap(lib::bind(
@ -461,8 +461,7 @@ protected:
m_io_service = io_service; m_io_service = io_service;
if (config::enable_multithreading) { if (config::enable_multithreading) {
m_strand = lib::make_shared<lib::asio::io_service::strand>( m_strand.reset(new lib::asio::io_service::strand(*io_service));
lib::ref(*io_service));
} }
lib::error_code ec = socket_con_type::init_asio(io_service, m_strand, lib::error_code ec = socket_con_type::init_asio(io_service, m_strand,

View file

@ -35,6 +35,7 @@
#include <websocketpp/uri.hpp> #include <websocketpp/uri.hpp>
#include <websocketpp/logger/levels.hpp> #include <websocketpp/logger/levels.hpp>
#include <websocketpp/common/asio.hpp>
#include <websocketpp/common/functional.hpp> #include <websocketpp/common/functional.hpp>
#include <sstream> #include <sstream>
@ -191,8 +192,7 @@ public:
m_io_service = ptr; m_io_service = ptr;
m_external_io_service = true; m_external_io_service = true;
m_acceptor = lib::make_shared<lib::asio::ip::tcp::acceptor>( m_acceptor.reset(new lib::asio::ip::tcp::acceptor(*m_io_service));
lib::ref(*m_io_service));
m_state = READY; m_state = READY;
ec = lib::error_code(); ec = lib::error_code();
@ -314,8 +314,10 @@ public:
* *
* New values affect future calls to listen only. * New values affect future calls to listen only.
* *
* A value of zero will use the operating system default. This is the * The default value is specified as *::asio::socket_base::max_connections
* default value. * which uses the operating system defined maximum queue length. Your OS
* may restrict or silently lower this value. A value of zero may cause
* all connections to be rejected.
* *
* @since 0.3.0 * @since 0.3.0
* *
@ -660,9 +662,7 @@ public:
* @since 0.3.0 * @since 0.3.0
*/ */
void start_perpetual() { void start_perpetual() {
m_work = lib::make_shared<lib::asio::io_service::work>( m_work.reset(new lib::asio::io_service::work(*m_io_service));
lib::ref(*m_io_service)
);
} }
/// Clears the endpoint's perpetual flag, allowing it to exit when empty /// Clears the endpoint's perpetual flag, allowing it to exit when empty
@ -826,8 +826,7 @@ protected:
// Create a resolver // Create a resolver
if (!m_resolver) { if (!m_resolver) {
m_resolver = lib::make_shared<lib::asio::ip::tcp::resolver>( m_resolver.reset(new lib::asio::ip::tcp::resolver(*m_io_service));
lib::ref(*m_io_service));
} }
tcon->set_uri(u); tcon->set_uri(u);

View file

@ -168,8 +168,7 @@ protected:
return socket::make_error_code(socket::error::invalid_state); return socket::make_error_code(socket::error::invalid_state);
} }
m_socket = lib::make_shared<lib::asio::ip::tcp::socket>( m_socket.reset(new lib::asio::ip::tcp::socket(*service));
lib::ref(*service));
m_state = READY; m_state = READY;

View file

@ -193,8 +193,7 @@ protected:
if (!m_context) { if (!m_context) {
return socket::make_error_code(socket::error::invalid_tls_context); return socket::make_error_code(socket::error::invalid_tls_context);
} }
m_socket = lib::make_shared<socket_type>( m_socket.reset(new socket_type(*service, *m_context));
_WEBSOCKETPP_REF(*service),lib::ref(*m_context));
m_io_service = service; m_io_service = service;
m_strand = strand; m_strand = strand;