mirror of
https://github.com/Xahau/xahaud.git
synced 2025-12-06 17:27:52 +00:00
1ab7a2f Set version to 1.0.0-b22 2eb4b0c Fix code sample in websocket.qbk 58802f4 Fix typos in design.qbk 19dc4bb Update documentation examples 10dbc5b Disable Boost.Coroutine deprecation warning 01c76c7 Fix websocket stream read documentation d152c96 Update README.md example programs 995d86f Avoid copies in handler_alloc 851cb62 Add handler helpers 114175c Implement asio dealloc-before-invoke guarantee: 681db2e Add missing include 7db3c6e Fix broken Intellisense (MSVC) 09c183d Set version to 1.0.0-b21 1cb01fe Remove extraneous includes 62e65ed Set version to 1.0.0-b20 45eaa8c Increase utf8 checker code coverage 9ff1a27 Add zlib module: a0a3359 Refactor HTTP identifier names (API Change): 79be7f8 Set version to 1.0.0-b19 eda1120 Tidy up internal name 4130ad4 Better buffer_cat: f94f21d Fix consuming_buffers value_type (API Change): 2c524b4 prepared_buffers is private (API Change) df2a108 Fix prepare_buffers value_type: a4af9d6 Use boost::lexical_cast instead of std::to_string 62d670b Fix with_body example: a63bd84 Increase code coverage 84a6775 Boost library min/max guidance: 02feea5 Add read, async_read for message_headers: f224585 Add write, async_write, operator<< for message_headers: ea48bcf Make chunk_encode public: f6dd744 Refactor message and message_headers declarations: 9fd8aed Move sync_ostream to core/detail c98b2d3 Optimize mask operations d4dfc1a Optimize utf8 validation 7b4de4b Set version to 1.0.0-b18 feb5204 Add websocket::stream pong and async_pong d4ffde5 Close connection during async_read on close frame: 644d518 Move clamp to core 427ba38 Fix write_frame masking and auto-fragment handling 54a51b1 Write buffer option does not change capacity 591dbc0 Meet DynamicBuffer requirements for static_streambuf 46d5e72 Reorganize source files and definitions efa4b8f Override incremental link flags: eef6e86 Higher optimization settings for MSVC builds b6f3a36 Check invariants in parse_op: 47b0fa6 Remove unused field in test 8b8e57e unit_test improvements: e907252 Clean up message docs 1e3543f Set version to 1.0.0-b17 de97a69 Trim unused code 796b484 Doc fixes 95c37e2 Fix unused parameter warnings and missing includes: 8b0d285 Refactor read_size_helper 97a9dcb Improve websocket example in README.md 236caef Engaged invokable is destructible: d107ba1 Add headers_parser: 2f90627 Fix handling of body_what::pause in basic_parser_v1 9353d04 Add basic_parser_v1::reset 658e03c Add on_body_what parser callback (API Change): 50bd446 Fix parser traits detection (API Change): df8d306 Tidy up documentation: 47105f8 Tidy up basic_headers for documentation ada1f60 Refine message class hierarchy: cf43f51 Rework HTTP concepts (API Change): 8a261ca HTTP Reader (API Change): 183055a Parser callbacks may not throw (API Change) ebebe52 Add basic_streambuf::alloc_size c9cd171 Fix basic_streambuf::capacity 0eb0e48 Tidying: c5c436d Change implicit_value to default_value 01f939d Set version to 1.0.0-b16 206d0a9 Fix websocket failure tests 6b4fb28 Fix Writer exemplar in docs 4224a3a Relax ForwardIterator requirements in FieldSequence 14d7f8d Refactor base_parser_v1 callback traits: d812344 Add pause option to on_headers interface: c59bd53 Improve first line serialization 78ff20b Constrain parser_v1 constructor 2765a67 Refine Parser concept: c329d33 Fix on_headers called twice from basic_parser_v1 55c4c93 Put back missing Design section in docs 90cec54 Make auto_fragment a boolean option 03642fb Rename to write_buffer_size 0ca8964 Frame processing routines are member functions d99dfb3 Make value optional in param-list 325f579 Set version to 1.0.0-b15 c54762a Fix handling empty HTTP headers in parser_v1.hpp c39cc06 Regression test for empty headers 60e637b Tidy up error types: d54d597 Tidy up DynamicBuffer requirements 707fb5e Fix doc reference section 38af0f7 Fix message_v1 constructor 027c4e8 Add Secure WebSocket example 5baaa49 Add HTTPS example 076456b rfc7230 section 3.3.2 compliance a09a044 Use bin/sh 1ff192d Update README.md for CppCon 2016 presentation 70b8555 Set version to 1.0.0-b14 b4a8342 Update and tidy documentation 8607af5 Update README.md 4abb43e Use BOOST_ASSERT b5bffee Don't rely on undefined behavior 8ee7a21 Better WebSocket decorator: 38f0d95 Update build scripts for MSVC, MinGW 2a5b116 Fix error handling in server examples 4c7065a Add missing rebind to handler_alloc git-subtree-dir: src/beast git-subtree-split: 1ab7a2f04ca9a0b35f2032877cab78d94e96ebad
1656 lines
61 KiB
C++
1656 lines
61 KiB
C++
//
|
|
// Copyright (c) 2013-2016 Vinnie Falco (vinnie dot falco at gmail dot com)
|
|
//
|
|
// Distributed under the Boost Software License, Version 1.0. (See accompanying
|
|
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
|
//
|
|
|
|
#ifndef BEAST_WEBSOCKET_STREAM_HPP
|
|
#define BEAST_WEBSOCKET_STREAM_HPP
|
|
|
|
#include <beast/websocket/option.hpp>
|
|
#include <beast/websocket/detail/stream_base.hpp>
|
|
#include <beast/http/message.hpp>
|
|
#include <beast/http/string_body.hpp>
|
|
#include <beast/core/dynabuf_readstream.hpp>
|
|
#include <beast/core/async_completion.hpp>
|
|
#include <beast/core/detail/get_lowest_layer.hpp>
|
|
#include <boost/asio.hpp>
|
|
#include <boost/utility/string_ref.hpp>
|
|
#include <algorithm>
|
|
#include <cstdint>
|
|
#include <limits>
|
|
|
|
namespace beast {
|
|
namespace websocket {
|
|
|
|
/** Information about a WebSocket frame.
|
|
|
|
This information is provided to callers during frame
|
|
read operations.
|
|
*/
|
|
struct frame_info
|
|
{
|
|
/// Indicates the type of message (binary or text).
|
|
opcode op;
|
|
|
|
/// `true` if this is the last frame in the current message.
|
|
bool fin;
|
|
};
|
|
|
|
//--------------------------------------------------------------------
|
|
|
|
/** Provides message-oriented functionality using WebSocket.
|
|
|
|
The @ref stream class template provides asynchronous and blocking
|
|
message-oriented functionality necessary for clients and servers
|
|
to utilize the WebSocket protocol.
|
|
|
|
@par Thread Safety
|
|
@e Distinct @e objects: Safe.@n
|
|
@e Shared @e objects: Unsafe. The application must ensure that
|
|
all asynchronous operations are performed within the same
|
|
implicit or explicit strand.
|
|
|
|
@par Example
|
|
|
|
To use the @ref stream template with an `ip::tcp::socket`,
|
|
you would write:
|
|
|
|
@code
|
|
websocket::stream<ip::tcp::socket> ws(io_service);
|
|
@endcode
|
|
Alternatively, you can write:
|
|
@code
|
|
ip::tcp::socket sock(io_service);
|
|
websocket::stream<ip::tcp::socket&> ws(sock);
|
|
@endcode
|
|
|
|
@tparam NextLayer The type representing the next layer, to which
|
|
data will be read and written during operations. For synchronous
|
|
operations, the type must support the @b `SyncStream` concept.
|
|
For asynchronous operations, the type must support the
|
|
@b `AsyncStream` concept.
|
|
|
|
@note A stream object must not be moved or destroyed while there
|
|
are pending asynchronous operations associated with it.
|
|
|
|
@par Concepts
|
|
@b `AsyncStream`,
|
|
@b `Decorator`,
|
|
@b `DynamicBuffer`,
|
|
@b `SyncStream`
|
|
*/
|
|
template<class NextLayer>
|
|
class stream : public detail::stream_base
|
|
{
|
|
friend class stream_test;
|
|
|
|
dynabuf_readstream<NextLayer, streambuf> stream_;
|
|
|
|
public:
|
|
/// The type of the next layer.
|
|
using next_layer_type =
|
|
typename std::remove_reference<NextLayer>::type;
|
|
|
|
/// The type of the lowest layer.
|
|
using lowest_layer_type =
|
|
#if GENERATING_DOCS
|
|
implementation_defined;
|
|
#else
|
|
typename beast::detail::get_lowest_layer<
|
|
next_layer_type>::type;
|
|
#endif
|
|
|
|
/** Move-construct a stream.
|
|
|
|
If @c NextLayer is move constructible, this function
|
|
will move-construct a new stream from the existing stream.
|
|
|
|
@note The behavior of move assignment on or from streams
|
|
with active or pending operations is undefined.
|
|
*/
|
|
stream(stream&&) = default;
|
|
|
|
/** Move assignment.
|
|
|
|
If `NextLayer` is move constructible, this function
|
|
will move-construct a new stream from the existing stream.
|
|
|
|
@note The behavior of move assignment on or from streams
|
|
with active or pending operations is undefined.
|
|
*/
|
|
stream& operator=(stream&&) = default;
|
|
|
|
/** Construct a WebSocket stream.
|
|
|
|
This constructor creates a websocket stream and initializes
|
|
the next layer object.
|
|
|
|
@throws Any exceptions thrown by the NextLayer constructor.
|
|
|
|
@param args The arguments to be passed to initialize the
|
|
next layer object. The arguments are forwarded to the next
|
|
layer's constructor.
|
|
*/
|
|
template<class... Args>
|
|
explicit
|
|
stream(Args&&... args);
|
|
|
|
/** Destructor.
|
|
|
|
@note A stream object must not be destroyed while there
|
|
are pending asynchronous operations associated with it.
|
|
*/
|
|
~stream() = default;
|
|
|
|
/** Set options on the stream.
|
|
|
|
The application must ensure that calls to set options
|
|
are performed within the same implicit or explicit strand.
|
|
|
|
@param args One or more stream options to set.
|
|
*/
|
|
#if GENERATING_DOCS
|
|
template<class... Args>
|
|
void
|
|
set_option(Args&&... args)
|
|
#else
|
|
template<class A1, class A2, class... An>
|
|
void
|
|
set_option(A1&& a1, A2&& a2, An&&... an)
|
|
#endif
|
|
{
|
|
set_option(std::forward<A1>(a1));
|
|
set_option(std::forward<A2>(a2),
|
|
std::forward<An>(an)...);
|
|
}
|
|
|
|
/// Set the automatic fragment size option
|
|
void
|
|
set_option(auto_fragment const& o)
|
|
{
|
|
wr_autofrag_ = o.value;
|
|
}
|
|
|
|
/** Set the decorator used for HTTP messages.
|
|
|
|
The value for this option is a callable type with two
|
|
optional signatures:
|
|
|
|
@code
|
|
void(request_type&);
|
|
|
|
void(response_type&);
|
|
@endcode
|
|
|
|
If a matching signature is provided, the callable type
|
|
will be invoked with the HTTP request or HTTP response
|
|
object as appropriate. When a signature is omitted,
|
|
a default consisting of the string Beast followed by
|
|
the version number is used.
|
|
*/
|
|
void
|
|
#if GENERATING_DOCS
|
|
set_option(implementation_defined o)
|
|
#else
|
|
set_option(detail::decorator_type o)
|
|
#endif
|
|
{
|
|
d_ = std::move(o);
|
|
}
|
|
|
|
/// Set the keep-alive option
|
|
void
|
|
set_option(keep_alive const& o)
|
|
{
|
|
keep_alive_ = o.value;
|
|
}
|
|
|
|
/// Set the outgoing message type
|
|
void
|
|
set_option(message_type const& o)
|
|
{
|
|
wr_opcode_ = o.value;
|
|
}
|
|
|
|
/// Set the pong callback
|
|
void
|
|
set_option(pong_callback o)
|
|
{
|
|
pong_cb_ = std::move(o.value);
|
|
}
|
|
|
|
/// Set the read buffer size
|
|
void
|
|
set_option(read_buffer_size const& o)
|
|
{
|
|
stream_.capacity(o.value);
|
|
}
|
|
|
|
/// Set the maximum incoming message size allowed
|
|
void
|
|
set_option(read_message_max const& o)
|
|
{
|
|
rd_msg_max_ = o.value;
|
|
}
|
|
|
|
/// Set the size of the write buffer
|
|
void
|
|
set_option(write_buffer_size const& o)
|
|
{
|
|
wr_buf_size_ = o.value;
|
|
}
|
|
|
|
/** Get the io_service associated with the stream.
|
|
|
|
This function may be used to obtain the io_service object
|
|
that the stream uses to dispatch handlers for asynchronous
|
|
operations.
|
|
|
|
@return A reference to the io_service object that the stream
|
|
will use to dispatch handlers. Ownership is not transferred
|
|
to the caller.
|
|
*/
|
|
boost::asio::io_service&
|
|
get_io_service()
|
|
{
|
|
return stream_.get_io_service();
|
|
}
|
|
|
|
/** Get a reference to the next layer.
|
|
|
|
This function returns a reference to the next layer
|
|
in a stack of stream layers.
|
|
|
|
@return A reference to the next layer in the stack of
|
|
stream layers. Ownership is not transferred to the caller.
|
|
*/
|
|
next_layer_type&
|
|
next_layer()
|
|
{
|
|
return stream_.next_layer();
|
|
}
|
|
|
|
/** Get a reference to the next layer.
|
|
|
|
This function returns a reference to the next layer in a
|
|
stack of stream layers.
|
|
|
|
@return A reference to the next layer in the stack of
|
|
stream layers. Ownership is not transferred to the caller.
|
|
*/
|
|
next_layer_type const&
|
|
next_layer() const
|
|
{
|
|
return stream_.next_layer();
|
|
}
|
|
|
|
/** Get a reference to the lowest layer.
|
|
|
|
This function returns a reference to the lowest layer
|
|
in a stack of stream layers.
|
|
|
|
@return A reference to the lowest layer in the stack of
|
|
stream layers. Ownership is not transferred to the caller.
|
|
*/
|
|
lowest_layer_type&
|
|
lowest_layer()
|
|
{
|
|
return stream_.lowest_layer();
|
|
}
|
|
|
|
/** Get a reference to the lowest layer.
|
|
|
|
This function returns a reference to the lowest layer
|
|
in a stack of stream layers.
|
|
|
|
@return A reference to the lowest layer in the stack of
|
|
stream layers. Ownership is not transferred to the caller.
|
|
*/
|
|
lowest_layer_type const&
|
|
lowest_layer() const
|
|
{
|
|
return stream_.lowest_layer();
|
|
}
|
|
|
|
/** Returns the close reason received from the peer.
|
|
|
|
This is only valid after a read completes with error::closed.
|
|
*/
|
|
close_reason const&
|
|
reason() const
|
|
{
|
|
return cr_;
|
|
}
|
|
|
|
/** Read and respond to a WebSocket HTTP Upgrade request.
|
|
|
|
This function is used to synchronously read a HTTP WebSocket
|
|
Upgrade request and send the HTTP response. The call blocks until
|
|
one of the following conditions is true:
|
|
|
|
@li A HTTP request finishes receiving, and a HTTP response finishes
|
|
sending.
|
|
|
|
@li An error occurs on the stream.
|
|
|
|
This function is implemented in terms of one or more calls to the
|
|
next layer's `read_some` and `write_some` functions.
|
|
|
|
If the stream receives a valid HTTP WebSocket Upgrade request, a
|
|
HTTP response is sent back indicating a successful upgrade. When this
|
|
call returns, the stream is then ready to send and receive WebSocket
|
|
protocol frames and messages.
|
|
|
|
If the HTTP Upgrade request is invalid or cannot be satisfied, a
|
|
HTTP response is sent indicating the reason and status code
|
|
(typically 400, "Bad Request"). This counts as a failure.
|
|
|
|
@throws system_error Thrown on failure.
|
|
*/
|
|
void
|
|
accept();
|
|
|
|
/** Read and respond to a WebSocket HTTP Upgrade request.
|
|
|
|
This function is used to synchronously read a HTTP WebSocket
|
|
Upgrade request and send the HTTP response. The call blocks until
|
|
one of the following conditions is true:
|
|
|
|
@li A HTTP request finishes receiving, and a HTTP response finishes
|
|
sending.
|
|
|
|
@li An error occurs on the stream.
|
|
|
|
This function is implemented in terms of one or more calls to the
|
|
next layer's `read_some` and `write_some` functions.
|
|
|
|
If the stream receives a valid HTTP WebSocket Upgrade request, a
|
|
HTTP response is sent back indicating a successful upgrade. When this
|
|
call returns, the stream is then ready to send and receive WebSocket
|
|
protocol frames and messages.
|
|
|
|
If the HTTP Upgrade request is invalid or cannot be satisfied, a
|
|
HTTP response is sent indicating the reason and status code
|
|
(typically 400, "Bad Request"). This counts as a failure.
|
|
|
|
@param ec Set to indicate what error occurred, if any.
|
|
*/
|
|
void
|
|
accept(error_code& ec);
|
|
|
|
/** Start reading and responding to a WebSocket HTTP Upgrade request.
|
|
|
|
This function is used to asynchronously read a HTTP WebSocket
|
|
Upgrade request and send the HTTP response. The function call
|
|
always returns immediately. The asynchronous operation will
|
|
continue until one of the following conditions is true:
|
|
|
|
@li A HTTP request finishes receiving, and a HTTP response finishes
|
|
sending.
|
|
|
|
@li An error occurs on the stream.
|
|
|
|
This operation is implemented in terms of one or more calls to the
|
|
next layer's `async_read_some` and `async_write_some` functions, and
|
|
is known as a <em>composed operation</em>. The program must ensure
|
|
that the stream performs no other operations until this operation
|
|
completes.
|
|
|
|
If the stream receives a valid HTTP WebSocket Upgrade request, a
|
|
HTTP response is sent back indicating a successful upgrade. When
|
|
this call returns, the stream is then ready to send and receive
|
|
WebSocket protocol frames and messages.
|
|
|
|
If the HTTP Upgrade request is invalid or cannot be satisfied, a
|
|
HTTP response is sent indicating the reason and status code
|
|
(typically 400, "Bad Request"). This counts as a failure.
|
|
|
|
@param handler The handler to be called when the request completes.
|
|
Copies will be made of the handler as required. The equivalent
|
|
function signature of the handler must be:
|
|
@code void handler(
|
|
error_code const& error // result of operation
|
|
); @endcode
|
|
Regardless of whether the asynchronous operation completes
|
|
immediately or not, the handler will not be invoked from within
|
|
this function. Invocation of the handler will be performed in a
|
|
manner equivalent to using `boost::asio::io_service::post`.
|
|
*/
|
|
template<class AcceptHandler>
|
|
#if GENERATING_DOCS
|
|
void_or_deduced
|
|
#else
|
|
typename async_completion<
|
|
AcceptHandler, void(error_code)>::result_type
|
|
#endif
|
|
async_accept(AcceptHandler&& handler);
|
|
|
|
/** Read and respond to a WebSocket HTTP Upgrade request.
|
|
|
|
This function is used to synchronously read a HTTP WebSocket
|
|
Upgrade request and send the HTTP response. The call blocks until
|
|
one of the following conditions is true:
|
|
|
|
@li A HTTP request finishes receiving, and a HTTP response finishes
|
|
sending.
|
|
|
|
@li An error occurs on the stream.
|
|
|
|
This function is implemented in terms of one or more calls to the
|
|
next layer's `read_some` and `write_some` functions.
|
|
|
|
If the stream receives a valid HTTP WebSocket Upgrade request, a
|
|
HTTP response is sent back indicating a successful upgrade. When
|
|
this call returns, the stream is then ready to send and receive
|
|
WebSocket protocol frames and messages.
|
|
|
|
If the HTTP Upgrade request is invalid or cannot be satisfied, a
|
|
HTTP response is sent indicating the reason and status code
|
|
(typically 400, "Bad Request"). This counts as a failure.
|
|
|
|
@param buffers Caller provided data that has already been
|
|
received on the stream. This may be used for implementations
|
|
allowing multiple protocols on the same stream. The
|
|
buffered data will first be applied to the handshake, and
|
|
then to received WebSocket frames. The implementation will
|
|
copy the caller provided data before the function returns.
|
|
|
|
@throws system_error Thrown on failure.
|
|
*/
|
|
template<class ConstBufferSequence>
|
|
void
|
|
accept(ConstBufferSequence const& buffers);
|
|
|
|
/** Read and respond to a WebSocket HTTP Upgrade request.
|
|
|
|
This function is used to synchronously read a HTTP WebSocket
|
|
Upgrade request and send the HTTP response. The call blocks until
|
|
one of the following conditions is true:
|
|
|
|
@li A HTTP request finishes receiving, and a HTTP response finishes
|
|
sending.
|
|
|
|
@li An error occurs on the stream.
|
|
|
|
This function is implemented in terms of one or more calls to the
|
|
next layer's `read_some` and `write_some` functions.
|
|
|
|
If the stream receives a valid HTTP WebSocket Upgrade request, a
|
|
HTTP response is sent back indicating a successful upgrade. When
|
|
this call returns, the stream is then ready to send and receive
|
|
WebSocket protocol frames and messages.
|
|
|
|
If the HTTP Upgrade request is invalid or cannot be satisfied, a
|
|
HTTP response is sent indicating the reason and status code
|
|
(typically 400, "Bad Request"). This counts as a failure.
|
|
|
|
@param buffers Caller provided data that has already been
|
|
received on the stream. This may be used for implementations
|
|
allowing multiple protocols on the same stream. The
|
|
buffered data will first be applied to the handshake, and
|
|
then to received WebSocket frames. The implementation will
|
|
copy the caller provided data before the function returns.
|
|
|
|
@param ec Set to indicate what error occurred, if any.
|
|
*/
|
|
template<class ConstBufferSequence>
|
|
void
|
|
accept(ConstBufferSequence const& buffers, error_code& ec);
|
|
|
|
/** Start reading and responding to a WebSocket HTTP Upgrade request.
|
|
|
|
This function is used to asynchronously read a HTTP WebSocket
|
|
Upgrade request and send the HTTP response. The function call
|
|
always returns immediately. The asynchronous operation will
|
|
continue until one of the following conditions is true:
|
|
|
|
@li A HTTP request finishes receiving, and a HTTP response finishes
|
|
sending.
|
|
|
|
@li An error occurs on the stream.
|
|
|
|
This operation is implemented in terms of one or more calls to the
|
|
next layer's `async_read_some` and `async_write_some` functions, and
|
|
is known as a <em>composed operation</em>. The program must ensure
|
|
that the stream performs no other operations until this operation
|
|
completes.
|
|
|
|
If the stream receives a valid HTTP WebSocket Upgrade request, a
|
|
HTTP response is sent back indicating a successful upgrade. When
|
|
this call returns, the stream is then ready to send and receive
|
|
WebSocket protocol frames and messages.
|
|
|
|
If the HTTP Upgrade request is invalid or cannot be satisfied, a
|
|
HTTP response is sent indicating the reason and status code
|
|
(typically 400, "Bad Request"). This counts as a failure.
|
|
|
|
@param buffers Caller provided data that has already been
|
|
received on the stream. This may be used for implementations
|
|
allowing multiple protocols on the same stream. The
|
|
buffered data will first be applied to the handshake, and
|
|
then to received WebSocket frames. The implementation will
|
|
copy the caller provided data before the function returns.
|
|
|
|
@param handler The handler to be called when the request completes.
|
|
Copies will be made of the handler as required. The equivalent
|
|
function signature of the handler must be:
|
|
@code void handler(
|
|
error_code const& error // result of operation
|
|
); @endcode
|
|
Regardless of whether the asynchronous operation completes
|
|
immediately or not, the handler will not be invoked from within
|
|
this function. Invocation of the handler will be performed in a
|
|
manner equivalent to using `boost::asio::io_service::post`.
|
|
*/
|
|
template<class ConstBufferSequence, class AcceptHandler>
|
|
#if GENERATING_DOCS
|
|
void_or_deduced
|
|
#else
|
|
typename async_completion<
|
|
AcceptHandler, void(error_code)>::result_type
|
|
#endif
|
|
async_accept(ConstBufferSequence const& buffers,
|
|
AcceptHandler&& handler);
|
|
|
|
/** Respond to a WebSocket HTTP Upgrade request
|
|
|
|
This function is used to synchronously send the HTTP response to
|
|
a HTTP request possibly containing a WebSocket Upgrade request.
|
|
The call blocks until one of the following conditions is true:
|
|
|
|
@li A HTTP response finishes sending.
|
|
|
|
@li An error occurs on the stream.
|
|
|
|
This function is implemented in terms of one or more calls to the
|
|
next layer's `write_some` functions.
|
|
|
|
If the passed HTTP request is a valid HTTP WebSocket Upgrade
|
|
request, a HTTP response is sent back indicating a successful
|
|
upgrade. When this call returns, the stream is then ready to send
|
|
and receive WebSocket protocol frames and messages.
|
|
|
|
If the HTTP request is invalid or cannot be satisfied, a HTTP
|
|
response is sent indicating the reason and status code (typically
|
|
400, "Bad Request"). This counts as a failure.
|
|
|
|
@param request An object containing the HTTP Upgrade request.
|
|
Ownership is not transferred, the implementation will not access
|
|
this object from other threads.
|
|
|
|
@throws system_error Thrown on failure.
|
|
*/
|
|
// VFALCO TODO This should also take a DynamicBuffer with any leftover bytes.
|
|
template<class Body, class Fields>
|
|
void
|
|
accept(http::request<Body, Fields> const& request);
|
|
|
|
/** Respond to a WebSocket HTTP Upgrade request
|
|
|
|
This function is used to synchronously send the HTTP response to
|
|
a HTTP request possibly containing a WebSocket Upgrade request.
|
|
The call blocks until one of the following conditions is true:
|
|
|
|
@li A HTTP response finishes sending.
|
|
|
|
@li An error occurs on the stream.
|
|
|
|
This function is implemented in terms of one or more calls to the
|
|
next layer's `write_some` functions.
|
|
|
|
If the passed HTTP request is a valid HTTP WebSocket Upgrade
|
|
request, a HTTP response is sent back indicating a successful
|
|
upgrade. When this call returns, the stream is then ready to send
|
|
and receive WebSocket protocol frames and messages.
|
|
|
|
If the HTTP request is invalid or cannot be satisfied, a HTTP
|
|
response is sent indicating the reason and status code (typically
|
|
400, "Bad Request"). This counts as a failure.
|
|
|
|
@param request An object containing the HTTP Upgrade request.
|
|
Ownership is not transferred, the implementation will not access
|
|
this object from other threads.
|
|
|
|
@param ec Set to indicate what error occurred, if any.
|
|
*/
|
|
template<class Body, class Fields>
|
|
void
|
|
accept(http::request<Body, Fields> const& request,
|
|
error_code& ec);
|
|
|
|
/** Start responding to a WebSocket HTTP Upgrade request.
|
|
|
|
This function is used to asynchronously send the HTTP response
|
|
to a HTTP request possibly containing a WebSocket Upgrade request.
|
|
The function call always returns immediately. The asynchronous
|
|
operation will continue until one of the following conditions is
|
|
true:
|
|
|
|
@li A HTTP response finishes sending.
|
|
|
|
@li An error occurs on the stream.
|
|
|
|
This operation is implemented in terms of one or more calls to the
|
|
next layer's `async_write_some` functions, and is known as a
|
|
<em>composed operation</em>. The program must ensure that the
|
|
stream performs no other operations until this operation completes.
|
|
|
|
If the passed HTTP request is a valid HTTP WebSocket Upgrade
|
|
request, a HTTP response is sent back indicating a successful
|
|
upgrade. When this asynchronous operation completes, the stream is
|
|
then ready to send and receive WebSocket protocol frames and messages.
|
|
|
|
If the HTTP request is invalid or cannot be satisfied, a HTTP
|
|
response is sent indicating the reason and status code (typically
|
|
400, "Bad Request"). This counts as a failure.
|
|
|
|
@param request An object containing the HTTP Upgrade request.
|
|
Ownership is not transferred, the implementation will not access
|
|
this object from other threads.
|
|
|
|
@param handler The handler to be called when the request completes.
|
|
Copies will be made of the handler as required. The equivalent
|
|
function signature of the handler must be:
|
|
@code void handler(
|
|
error_code const& error // result of operation
|
|
); @endcode
|
|
Regardless of whether the asynchronous operation completes
|
|
immediately or not, the handler will not be invoked from within
|
|
this function. Invocation of the handler will be performed in a
|
|
manner equivalent to using `boost::asio::io_service::post`.
|
|
*/
|
|
template<class Body, class Fields, class AcceptHandler>
|
|
#if GENERATING_DOCS
|
|
void_or_deduced
|
|
#else
|
|
typename async_completion<
|
|
AcceptHandler, void(error_code)>::result_type
|
|
#endif
|
|
async_accept(http::request<Body, Fields> const& request,
|
|
AcceptHandler&& handler);
|
|
|
|
/** Send a HTTP WebSocket Upgrade request and receive the response.
|
|
|
|
This function is used to synchronously send the WebSocket
|
|
upgrade HTTP request. The call blocks until one of the
|
|
following conditions is true:
|
|
|
|
@li A HTTP request finishes sending and a HTTP response finishes
|
|
receiving.
|
|
|
|
@li An error occurs on the stream
|
|
|
|
This function is implemented in terms of one or more calls to the
|
|
next layer's `read_some` and `write_some` functions.
|
|
|
|
The operation is successful if the received HTTP response indicates
|
|
a successful HTTP Upgrade (represented by a Status-Code of 101,
|
|
"switching protocols").
|
|
|
|
@param host The name of the remote host,
|
|
required by the HTTP protocol.
|
|
|
|
@param resource The requesting URI, which may not be empty,
|
|
required by the HTTP protocol.
|
|
|
|
@throws system_error Thrown on failure.
|
|
|
|
@par Example
|
|
@code
|
|
websocket::stream<ip::tcp::socket> ws(io_service);
|
|
...
|
|
try
|
|
{
|
|
ws.upgrade("localhost", "/");
|
|
}
|
|
catch(...)
|
|
{
|
|
// An error occurred.
|
|
}
|
|
@endcode
|
|
*/
|
|
void
|
|
handshake(boost::string_ref const& host,
|
|
boost::string_ref const& resource);
|
|
|
|
/** Send a HTTP WebSocket Upgrade request and receive the response.
|
|
|
|
This function is used to synchronously send the WebSocket
|
|
upgrade HTTP request. The call blocks until one of the
|
|
following conditions is true:
|
|
|
|
@li A HTTP request finishes sending and a HTTP response finishes
|
|
receiving.
|
|
|
|
@li An error occurs on the stream
|
|
|
|
This function is implemented in terms of one or more calls to the
|
|
next layer's `read_some` and `write_some` functions.
|
|
|
|
The operation is successful if the received HTTP response indicates
|
|
a successful HTTP Upgrade (represented by a Status-Code of 101,
|
|
"switching protocols").
|
|
|
|
@param host The name of the remote host,
|
|
required by the HTTP protocol.
|
|
|
|
@param resource The requesting URI, which may not be empty,
|
|
required by the HTTP protocol.
|
|
|
|
@param ec Set to indicate what error occurred, if any.
|
|
|
|
@par Example
|
|
@code
|
|
websocket::stream<ip::tcp::socket> ws(io_service);
|
|
...
|
|
error_code ec;
|
|
ws.upgrade(host, resource, ec);
|
|
if(ec)
|
|
{
|
|
// An error occurred.
|
|
}
|
|
@endcode
|
|
*/
|
|
void
|
|
handshake(boost::string_ref const& host,
|
|
boost::string_ref const& resource, error_code& ec);
|
|
|
|
/** Start an asynchronous operation to send an upgrade request and receive the response.
|
|
|
|
This function is used to asynchronously send the HTTP WebSocket
|
|
upgrade request and receive the HTTP WebSocket Upgrade response.
|
|
This function call always returns immediately. The asynchronous
|
|
operation will continue until one of the following conditions is
|
|
true:
|
|
|
|
@li A HTTP request finishes sending and a HTTP response finishes
|
|
receiving.
|
|
|
|
@li An error occurs on the stream.
|
|
|
|
This operation is implemented in terms of one or more calls to the
|
|
next layer's `async_read_some` and `async_write_some` functions, and
|
|
is known as a <em>composed operation</em>. The program must ensure
|
|
that the stream performs no other operations until this operation
|
|
completes.
|
|
|
|
The operation is successful if the received HTTP response indicates
|
|
a successful HTTP Upgrade (represented by a Status-Code of 101,
|
|
"switching protocols").
|
|
|
|
@param host The name of the remote host, required by
|
|
the HTTP protocol. Copies may be made as needed.
|
|
|
|
@param resource The requesting URI, which may not be empty,
|
|
required by the HTTP protocol. Copies may be made as
|
|
needed.
|
|
|
|
@param h The handler to be called when the request completes.
|
|
Copies will be made of the handler as required. The equivalent
|
|
function signature of the handler must be:
|
|
@code void handler(
|
|
error_code const& error // result of operation
|
|
); @endcode
|
|
Regardless of whether the asynchronous operation completes
|
|
immediately or not, the handler will not be invoked from within
|
|
this function. Invocation of the handler will be performed in a
|
|
manner equivalent to using `boost::asio::io_service::post`.
|
|
*/
|
|
template<class HandshakeHandler>
|
|
#if GENERATING_DOCS
|
|
void_or_deduced
|
|
#else
|
|
typename async_completion<
|
|
HandshakeHandler, void(error_code)>::result_type
|
|
#endif
|
|
async_handshake(boost::string_ref const& host,
|
|
boost::string_ref const& resource, HandshakeHandler&& h);
|
|
|
|
/** Send a WebSocket close frame.
|
|
|
|
This function is used to synchronously send a close frame on
|
|
the stream. The call blocks until one of the following is true:
|
|
|
|
@li The close frame finishes sending.
|
|
|
|
@li An error occurs on the stream.
|
|
|
|
This function is implemented in terms of one or more calls
|
|
to the next layer's `write_some` functions.
|
|
|
|
If the close reason specifies a close code other than
|
|
@ref beast::websocket::close_code::none, the close frame is
|
|
sent with the close code and optional reason string. Otherwise,
|
|
the close frame is sent with no payload.
|
|
|
|
Callers should not attempt to write WebSocket data after
|
|
initiating the close. Instead, callers should continue
|
|
reading until an error occurs. A read returning @ref error::closed
|
|
indicates a successful connection closure.
|
|
|
|
@param cr The reason for the close.
|
|
|
|
@throws system_error Thrown on failure.
|
|
*/
|
|
void
|
|
close(close_reason const& cr);
|
|
|
|
/** Send a WebSocket close frame.
|
|
|
|
This function is used to synchronously send a close frame on
|
|
the stream. The call blocks until one of the following is true:
|
|
|
|
@li The close frame finishes sending.
|
|
|
|
@li An error occurs on the stream.
|
|
|
|
This function is implemented in terms of one or more calls
|
|
to the next layer's `write_some` functions.
|
|
|
|
If the close reason specifies a close code other than
|
|
@ref beast::websocket::close_code::none, the close frame is
|
|
sent with the close code and optional reason string. Otherwise,
|
|
the close frame is sent with no payload.
|
|
|
|
Callers should not attempt to write WebSocket data after
|
|
initiating the close. Instead, callers should continue
|
|
reading until an error occurs. A read returning @ref error::closed
|
|
indicates a successful connection closure.
|
|
|
|
@param cr The reason for the close.
|
|
|
|
@param ec Set to indicate what error occurred, if any.
|
|
*/
|
|
void
|
|
close(close_reason const& cr, error_code& ec);
|
|
|
|
/** Start an asynchronous operation to send a WebSocket close frame.
|
|
|
|
This function is used to asynchronously send a close frame on
|
|
the stream. This function call always returns immediately. The
|
|
asynchronous operation will continue until one of the following
|
|
conditions is true:
|
|
|
|
@li The close frame finishes sending.
|
|
|
|
@li An error occurs on the stream.
|
|
|
|
This operation is implemented in terms of one or more calls to the
|
|
next layer's `async_write_some` functions, and is known as a
|
|
<em>composed operation</em>. The program must ensure that the
|
|
stream performs no other write operations (such as @ref async_ping,
|
|
@ref stream::async_write, @ref stream::async_write_frame, or
|
|
@ref stream::async_close) until this operation completes.
|
|
|
|
If the close reason specifies a close code other than
|
|
@ref beast::websocket::close_code::none, the close frame is
|
|
sent with the close code and optional reason string. Otherwise,
|
|
the close frame is sent with no payload.
|
|
|
|
Callers should not attempt to write WebSocket data after
|
|
initiating the close. Instead, callers should continue
|
|
reading until an error occurs. A read returning @ref error::closed
|
|
indicates a successful connection closure.
|
|
|
|
@param cr The reason for the close.
|
|
|
|
@param handler The handler to be called when the close operation
|
|
completes. Copies will be made of the handler as required. The
|
|
function signature of the handler must be:
|
|
@code
|
|
void handler(
|
|
error_code const& error // Result of operation
|
|
);
|
|
@endcode
|
|
Regardless of whether the asynchronous operation completes
|
|
immediately or not, the handler will not be invoked from within
|
|
this function. Invocation of the handler will be performed in a
|
|
manner equivalent to using `boost::asio::io_service::post`.
|
|
*/
|
|
template<class CloseHandler>
|
|
#if GENERATING_DOCS
|
|
void_or_deduced
|
|
#else
|
|
typename async_completion<
|
|
CloseHandler, void(error_code)>::result_type
|
|
#endif
|
|
async_close(close_reason const& cr, CloseHandler&& handler);
|
|
|
|
/** Send a WebSocket ping frame.
|
|
|
|
This function is used to synchronously send a ping frame on
|
|
the stream. The call blocks until one of the following is true:
|
|
|
|
@li The ping frame finishes sending.
|
|
|
|
@li An error occurs on the stream.
|
|
|
|
This function is implemented in terms of one or more calls to the
|
|
next layer's `write_some` functions.
|
|
|
|
@param payload The payload of the ping message, which may be empty.
|
|
|
|
@throws system_error Thrown on failure.
|
|
*/
|
|
void
|
|
ping(ping_data const& payload);
|
|
|
|
/** Send a WebSocket ping frame.
|
|
|
|
This function is used to synchronously send a ping frame on
|
|
the stream. The call blocks until one of the following is true:
|
|
|
|
@li The ping frame finishes sending.
|
|
|
|
@li An error occurs on the stream.
|
|
|
|
This function is implemented in terms of one or more calls to the
|
|
next layer's `write_some` functions.
|
|
|
|
@param payload The payload of the ping message, which may be empty.
|
|
|
|
@param ec Set to indicate what error occurred, if any.
|
|
*/
|
|
void
|
|
ping(ping_data const& payload, error_code& ec);
|
|
|
|
/** Start an asynchronous operation to send a WebSocket ping frame.
|
|
|
|
This function is used to asynchronously send a ping frame to
|
|
the stream. The function call always returns immediately. The
|
|
asynchronous operation will continue until one of the following
|
|
is true:
|
|
|
|
@li The entire ping frame is sent.
|
|
|
|
@li An error occurs on the stream.
|
|
|
|
This operation is implemented in terms of one or more calls to the
|
|
next layer's `async_write_some` functions, and is known as a
|
|
<em>composed operation</em>. The program must ensure that the
|
|
stream performs no other writes until this operation completes.
|
|
|
|
@param payload The payload of the ping message, which may be empty.
|
|
|
|
@param handler The handler to be called when the read operation
|
|
completes. Copies will be made of the handler as required. The
|
|
function signature of the handler must be:
|
|
@code
|
|
void handler(
|
|
error_code const& error // Result of operation
|
|
);
|
|
@endcode
|
|
Regardless of whether the asynchronous operation completes
|
|
immediately or not, the handler will not be invoked from within
|
|
this function. Invocation of the handler will be performed in a
|
|
manner equivalent to using `boost::asio::io_service::post`.
|
|
*/
|
|
template<class WriteHandler>
|
|
#if GENERATING_DOCS
|
|
void_or_deduced
|
|
#else
|
|
typename async_completion<
|
|
WriteHandler, void(error_code)>::result_type
|
|
#endif
|
|
async_ping(ping_data const& payload, WriteHandler&& handler);
|
|
|
|
/** Send a WebSocket pong frame.
|
|
|
|
This function is used to synchronously send a pong frame on
|
|
the stream. The call blocks until one of the following is true:
|
|
|
|
@li The pong frame finishes sending.
|
|
|
|
@li An error occurs on the stream.
|
|
|
|
This function is implemented in terms of one or more calls to the
|
|
next layer's `write_some` functions.
|
|
|
|
The WebSocket protocol allows pong frames to be sent from either
|
|
end at any time. It is not necessary to first receive a ping in
|
|
order to send a pong. The remote peer may use the receipt of a
|
|
pong frame as an indication that the connection is not dead.
|
|
|
|
@param payload The payload of the pong message, which may be empty.
|
|
|
|
@throws system_error Thrown on failure.
|
|
*/
|
|
void
|
|
pong(ping_data const& payload);
|
|
|
|
/** Send a WebSocket pong frame.
|
|
|
|
This function is used to synchronously send a pong frame on
|
|
the stream. The call blocks until one of the following is true:
|
|
|
|
@li The pong frame finishes sending.
|
|
|
|
@li An error occurs on the stream.
|
|
|
|
This function is implemented in terms of one or more calls to the
|
|
next layer's `write_some` functions.
|
|
|
|
The WebSocket protocol allows pong frames to be sent from either
|
|
end at any time. It is not necessary to first receive a ping in
|
|
order to send a pong. The remote peer may use the receipt of a
|
|
pong frame as an indication that the connection is not dead.
|
|
|
|
@param payload The payload of the pong message, which may be empty.
|
|
|
|
@param ec Set to indicate what error occurred, if any.
|
|
*/
|
|
void
|
|
pong(ping_data const& payload, error_code& ec);
|
|
|
|
/** Start an asynchronous operation to send a WebSocket pong frame.
|
|
|
|
This function is used to asynchronously send a pong frame to
|
|
the stream. The function call always returns immediately. The
|
|
asynchronous operation will continue until one of the following
|
|
is true:
|
|
|
|
@li The entire pong frame is sent.
|
|
|
|
@li An error occurs on the stream.
|
|
|
|
This operation is implemented in terms of one or more calls to the
|
|
next layer's `async_write_some` functions, and is known as a
|
|
<em>composed operation</em>. The program must ensure that the
|
|
stream performs no other writes until this operation completes.
|
|
|
|
The WebSocket protocol allows pong frames to be sent from either
|
|
end at any time. It is not necessary to first receive a ping in
|
|
order to send a pong. The remote peer may use the receipt of a
|
|
pong frame as an indication that the connection is not dead.
|
|
|
|
@param payload The payload of the pong message, which may be empty.
|
|
|
|
@param handler The handler to be called when the read operation
|
|
completes. Copies will be made of the handler as required. The
|
|
function signature of the handler must be:
|
|
@code
|
|
void handler(
|
|
error_code const& error // Result of operation
|
|
);
|
|
@endcode
|
|
Regardless of whether the asynchronous operation completes
|
|
immediately or not, the handler will not be invoked from within
|
|
this function. Invocation of the handler will be performed in a
|
|
manner equivalent to using `boost::asio::io_service::post`.
|
|
*/
|
|
template<class WriteHandler>
|
|
#if GENERATING_DOCS
|
|
void_or_deduced
|
|
#else
|
|
typename async_completion<
|
|
WriteHandler, void(error_code)>::result_type
|
|
#endif
|
|
async_pong(ping_data const& payload, WriteHandler&& handler);
|
|
|
|
/** Read a message from the stream.
|
|
|
|
This function is used to synchronously read a message from
|
|
the stream. The call blocks until one of the following is true:
|
|
|
|
@li A complete message is received.
|
|
|
|
@li An error occurs on the stream.
|
|
|
|
This call is implemented in terms of one or more calls to the
|
|
stream's `read_some` and `write_some` operations.
|
|
|
|
Upon a success, op is set to either binary or text depending on
|
|
the message type, and the input area of the stream buffer will
|
|
hold all the message payload bytes (which may be zero in length).
|
|
|
|
Control frames encountered while reading frame or message data
|
|
are handled automatically. Pings are replied to automatically,
|
|
pongs are routed to the pong callback if the option is set,
|
|
and close frames initiate the WebSocket close procedure. When a
|
|
close frame is received, this call will eventually return
|
|
@ref error::closed. Because of the need to handle control frames,
|
|
read operations can cause writes to take place.
|
|
|
|
@param op A value to receive the message type.
|
|
This object must remain valid until the handler is called.
|
|
|
|
@param dynabuf A dynamic buffer to hold the message data after
|
|
any masking or decompression has been applied.
|
|
|
|
@throws system_error Thrown on failure.
|
|
*/
|
|
template<class DynamicBuffer>
|
|
void
|
|
read(opcode& op, DynamicBuffer& dynabuf);
|
|
|
|
/** Read a message from the stream.
|
|
|
|
This function is used to synchronously read a message from
|
|
the stream. The call blocks until one of the following is true:
|
|
|
|
@li A complete message is received.
|
|
|
|
@li An error occurs on the stream.
|
|
|
|
This call is implemented in terms of one or more calls to the
|
|
stream's `read_some` and `write_some` operations.
|
|
|
|
Upon a success, op is set to either binary or text depending on
|
|
the message type, and the input area of the stream buffer will
|
|
hold all the message payload bytes (which may be zero in length).
|
|
|
|
Control frames encountered while reading frame or message data
|
|
are handled automatically. Pings are replied to automatically,
|
|
pongs are routed to the pong callback if the option is set,
|
|
and close frames initiate the WebSocket close procedure. When a
|
|
close frame is received, this call will eventually return
|
|
@ref error::closed. Because of the need to handle control frames,
|
|
read operations can cause writes to take place.
|
|
|
|
@param op A value to receive the message type.
|
|
This object must remain valid until the handler is called.
|
|
|
|
@param dynabuf A dynamic buffer to hold the message data after
|
|
any masking or decompression has been applied.
|
|
|
|
@param ec Set to indicate what error occurred, if any.
|
|
*/
|
|
template<class DynamicBuffer>
|
|
void
|
|
read(opcode& op, DynamicBuffer& dynabuf, error_code& ec);
|
|
|
|
/** Start an asynchronous operation to read a message from the stream.
|
|
|
|
This function is used to asynchronously read a message from
|
|
the stream. The function call always returns immediately. The
|
|
asynchronous operation will continue until one of the following
|
|
is true:
|
|
|
|
@li A complete message is received.
|
|
|
|
@li An error occurs on the stream.
|
|
|
|
This operation is implemented in terms of one or more calls to the
|
|
next layer's `async_read_some` and `async_write_some` functions,
|
|
and is known as a <em>composed operation</em>. The program must
|
|
ensure that the stream performs no other reads until this operation
|
|
completes.
|
|
|
|
Upon a success, op is set to either binary or text depending on
|
|
the message type, and the input area of the stream buffer will
|
|
hold all the message payload bytes (which may be zero in length).
|
|
|
|
Control frames encountered while reading frame or message data
|
|
are handled automatically. Pings are replied to automatically,
|
|
pongs are routed to the pong callback if the option is set,
|
|
and close frames initiate the WebSocket close procedure. When a
|
|
close frame is received, this call will eventually return
|
|
@ref error::closed. Because of the need to handle control
|
|
frames, these read operations can cause writes to take place.
|
|
Despite this, calls to `async_read` and `async_read_frame`
|
|
only count as read operations.
|
|
|
|
@param op A value to receive the message type.
|
|
This object must remain valid until the handler is called.
|
|
|
|
@param dynabuf A dynamic buffer to hold the message data after
|
|
any masking or decompression has been applied. This object must
|
|
remain valid until the handler is called.
|
|
|
|
@param handler The handler to be called when the read operation
|
|
completes. Copies will be made of the handler as required. The
|
|
function signature of the handler must be:
|
|
@code
|
|
void handler(
|
|
error_code const& error // Result of operation
|
|
);
|
|
@endcode
|
|
Regardless of whether the asynchronous operation completes
|
|
immediately or not, the handler will not be invoked from within
|
|
this function. Invocation of the handler will be performed in a
|
|
manner equivalent to using `boost::asio::io_service::post`.
|
|
*/
|
|
template<class DynamicBuffer, class ReadHandler>
|
|
#if GENERATING_DOCS
|
|
void_or_deduced
|
|
#else
|
|
typename async_completion<
|
|
ReadHandler, void(error_code)>::result_type
|
|
#endif
|
|
async_read(opcode& op, DynamicBuffer& dynabuf, ReadHandler&& handler);
|
|
|
|
/** Read a message frame from the stream.
|
|
|
|
This function is used to synchronously read a single message
|
|
frame from the stream. The call blocks until one of the following
|
|
is true:
|
|
|
|
@li A complete frame is received.
|
|
|
|
@li An error occurs on the stream.
|
|
|
|
This call is implemented in terms of one or more calls to the
|
|
stream's `read_some` and `write_some` operations.
|
|
|
|
Upon success, fi is filled out to reflect the message payload
|
|
contents. op is set to binary or text, and the fin flag
|
|
indicates if all the message data has been read in. To read the
|
|
entire message, callers should repeat the read_frame operation
|
|
until fi.fin is true. A message with no payload will have
|
|
fi.fin == true, and zero bytes placed into the stream buffer.
|
|
|
|
Control frames encountered while reading frame or message data
|
|
are handled automatically. Pings are replied to automatically,
|
|
pongs are routed to the pong callback if the option is set,
|
|
and close frames initiate the WebSocket close procedure. When a
|
|
close frame is received, this call will eventually return
|
|
@ref error::closed. Because of the need to handle control frames,
|
|
read operations can cause writes to take place.
|
|
|
|
@param fi An object to store metadata about the message.
|
|
|
|
@param dynabuf A dynamic buffer to hold the message data after
|
|
any masking or decompression has been applied.
|
|
|
|
@throws system_error Thrown on failure.
|
|
*/
|
|
template<class DynamicBuffer>
|
|
void
|
|
read_frame(frame_info& fi, DynamicBuffer& dynabuf);
|
|
|
|
/** Read a message frame from the stream.
|
|
|
|
This function is used to synchronously read a single message
|
|
frame from the stream. The call blocks until one of the following
|
|
is true:
|
|
|
|
@li A complete frame is received.
|
|
|
|
@li An error occurs on the stream.
|
|
|
|
This call is implemented in terms of one or more calls to the
|
|
stream's `read_some` and `write_some` operations.
|
|
|
|
Upon success, fi is filled out to reflect the message payload
|
|
contents. op is set to binary or text, and the fin flag
|
|
indicates if all the message data has been read in. To read the
|
|
entire message, callers should repeat the read_frame operation
|
|
until fi.fin is true. A message with no payload will have
|
|
fi.fin == true, and zero bytes placed into the stream buffer.
|
|
|
|
Control frames encountered while reading frame or message data
|
|
are handled automatically. Pings are replied to automatically,
|
|
pongs are routed to the pong callback if the option is set,
|
|
and close frames initiate the WebSocket close procedure. When a
|
|
close frame is received, this call will eventually return
|
|
@ref error::closed. Because of the need to handle control frames,
|
|
read operations can cause writes to take place.
|
|
|
|
@param fi An object to store metadata about the message.
|
|
|
|
@param dynabuf A dynamic buffer to hold the message data after
|
|
any masking or decompression has been applied.
|
|
|
|
@param ec Set to indicate what error occurred, if any.
|
|
*/
|
|
template<class DynamicBuffer>
|
|
void
|
|
read_frame(frame_info& fi, DynamicBuffer& dynabuf, error_code& ec);
|
|
|
|
/** Start an asynchronous operation to read a message frame from the stream.
|
|
|
|
This function is used to asynchronously read a single message
|
|
frame from the websocket. The function call always returns
|
|
immediately. The asynchronous operation will continue until
|
|
one of the following conditions is true:
|
|
|
|
@li A complete frame is received.
|
|
|
|
@li An error occurs on the stream.
|
|
|
|
This operation is implemented in terms of one or more calls to the
|
|
next layer's `async_read_some` and `async_write_some` functions,
|
|
and is known as a <em>composed operation</em>. The program must
|
|
ensure that the stream performs no other reads until this operation
|
|
completes.
|
|
|
|
Upon a successful completion, fi is filled out to reflect the
|
|
message payload contents. op is set to binary or text, and the
|
|
fin flag indicates if all the message data has been read in.
|
|
To read the entire message, callers should repeat the
|
|
read_frame operation until fi.fin is true. A message with no
|
|
payload will have fi.fin == true, and zero bytes placed into
|
|
the stream buffer.
|
|
|
|
Control frames encountered while reading frame or message data
|
|
are handled automatically. Pings are replied to automatically,
|
|
pongs are routed to the pong callback if the option is set,
|
|
and close frames initiate the WebSocket close procedure. When a
|
|
close frame is received, this call will eventually return
|
|
@ref error::closed. Because of the need to handle control frames,
|
|
read operations can cause writes to take place. These writes are
|
|
managed transparently; callers can still have one active
|
|
asynchronous read and asynchronous write operation pending
|
|
simultaneously (a user initiated call to @ref async_close
|
|
counts as a write).
|
|
|
|
@param fi An object to store metadata about the message.
|
|
This object must remain valid until the handler is called.
|
|
|
|
@param dynabuf A dynamic buffer to hold the message data after
|
|
any masking or decompression has been applied. This object must
|
|
remain valid until the handler is called.
|
|
|
|
@param handler The handler to be called when the read operation
|
|
completes. Copies will be made of the handler as required. The
|
|
function signature of the handler must be:
|
|
@code
|
|
void handler(
|
|
error_code const& error // Result of operation
|
|
);
|
|
@endcode
|
|
Regardless of whether the asynchronous operation completes
|
|
immediately or not, the handler will not be invoked from within
|
|
this function. Invocation of the handler will be performed in a
|
|
manner equivalent to using boost::asio::io_service::post().
|
|
*/
|
|
template<class DynamicBuffer, class ReadHandler>
|
|
#if GENERATING_DOCS
|
|
void_or_deduced
|
|
#else
|
|
typename async_completion<
|
|
ReadHandler, void(error_code)>::result_type
|
|
#endif
|
|
async_read_frame(frame_info& fi,
|
|
DynamicBuffer& dynabuf, ReadHandler&& handler);
|
|
|
|
/** Write a message to the stream.
|
|
|
|
This function is used to synchronously write a message to
|
|
the stream. The call blocks until one of the following conditions
|
|
is met:
|
|
|
|
@li The entire message is sent.
|
|
|
|
@li An error occurs.
|
|
|
|
This operation is implemented in terms of one or more calls to the
|
|
next layer's `write_some` function.
|
|
|
|
The current setting of the @ref message_type option controls
|
|
whether the message opcode is set to text or binary. If the
|
|
@ref auto_fragment option is set, the message will be split
|
|
into one or more frames as necessary. The actual payload contents
|
|
sent may be transformed as per the WebSocket protocol settings.
|
|
|
|
@param buffers The buffers containing the entire message
|
|
payload. The implementation will make copies of this object
|
|
as needed, but ownership of the underlying memory is not
|
|
transferred. The caller is responsible for ensuring that
|
|
the memory locations pointed to by buffers remains valid
|
|
until the completion handler is called.
|
|
|
|
@throws system_error Thrown on failure.
|
|
|
|
@note This function always sends an entire message. To
|
|
send a message in fragments, use @ref write_frame.
|
|
*/
|
|
template<class ConstBufferSequence>
|
|
void
|
|
write(ConstBufferSequence const& buffers);
|
|
|
|
/** Write a message to the stream.
|
|
|
|
This function is used to synchronously write a message to
|
|
the stream. The call blocks until one of the following conditions
|
|
is met:
|
|
|
|
@li The entire message is sent.
|
|
|
|
@li An error occurs.
|
|
|
|
This operation is implemented in terms of one or more calls to the
|
|
next layer's `write_some` function.
|
|
|
|
The current setting of the @ref message_type option controls
|
|
whether the message opcode is set to text or binary. If the
|
|
@ref auto_fragment option is set, the message will be split
|
|
into one or more frames as necessary. The actual payload contents
|
|
sent may be transformed as per the WebSocket protocol settings.
|
|
|
|
@param buffers The buffers containing the entire message
|
|
payload. The implementation will make copies of this object
|
|
as needed, but ownership of the underlying memory is not
|
|
transferred. The caller is responsible for ensuring that
|
|
the memory locations pointed to by buffers remains valid
|
|
until the completion handler is called.
|
|
|
|
@param ec Set to indicate what error occurred, if any.
|
|
|
|
@throws system_error Thrown on failure.
|
|
|
|
@note This function always sends an entire message. To
|
|
send a message in fragments, use @ref write_frame.
|
|
*/
|
|
template<class ConstBufferSequence>
|
|
void
|
|
write(ConstBufferSequence const& buffers, error_code& ec);
|
|
|
|
/** Start an asynchronous operation to write a message to the stream.
|
|
|
|
This function is used to asynchronously write a message to
|
|
the stream. The function call always returns immediately.
|
|
The asynchronous operation will continue until one of the
|
|
following conditions is true:
|
|
|
|
@li The entire message is sent.
|
|
|
|
@li An error occurs.
|
|
|
|
This operation is implemented in terms of one or more calls
|
|
to the next layer's `async_write_some` functions, and is known
|
|
as a <em>composed operation</em>. The program must ensure that
|
|
the stream performs no other write operations (such as
|
|
stream::async_write, stream::async_write_frame, or
|
|
stream::async_close).
|
|
|
|
The current setting of the @ref message_type option controls
|
|
whether the message opcode is set to text or binary. If the
|
|
@ref auto_fragment option is set, the message will be split
|
|
into one or more frames as necessary. The actual payload contents
|
|
sent may be transformed as per the WebSocket protocol settings.
|
|
|
|
@param buffers The buffers containing the entire message
|
|
payload. The implementation will make copies of this object
|
|
as needed, but ownership of the underlying memory is not
|
|
transferred. The caller is responsible for ensuring that
|
|
the memory locations pointed to by buffers remains valid
|
|
until the completion handler is called.
|
|
|
|
@param handler The handler to be called when the write operation
|
|
completes. Copies will be made of the handler as required. The
|
|
function signature of the handler must be:
|
|
@code
|
|
void handler(
|
|
error_code const& error // Result of operation
|
|
);
|
|
@endcode
|
|
Regardless of whether the asynchronous operation completes
|
|
immediately or not, the handler will not be invoked from within
|
|
this function. Invocation of the handler will be performed in a
|
|
manner equivalent to using `boost::asio::io_service::post`.
|
|
*/
|
|
template<class ConstBufferSequence, class WriteHandler>
|
|
#if GENERATING_DOCS
|
|
void_or_deduced
|
|
#else
|
|
typename async_completion<
|
|
WriteHandler, void(error_code)>::result_type
|
|
#endif
|
|
async_write(ConstBufferSequence const& buffers,
|
|
WriteHandler&& handler);
|
|
|
|
/** Write partial message data on the stream.
|
|
|
|
This function is used to write some or all of a message's
|
|
payload to the stream. The call will block until one of the
|
|
following conditions is true:
|
|
|
|
@li A frame is sent.
|
|
|
|
@li Message data is transferred to the write buffer.
|
|
|
|
@li An error occurs.
|
|
|
|
This operation is implemented in terms of one or more calls
|
|
to the stream's `write_some` function.
|
|
|
|
If this is the beginning of a new message, the message opcode
|
|
will be set to text or binary as per the current setting of
|
|
the @ref message_type option. The actual payload sent
|
|
may be transformed as per the WebSocket protocol settings.
|
|
|
|
@param fin `true` if this is the last frame in the message.
|
|
|
|
@param buffers The input buffer sequence holding the data to write.
|
|
|
|
@return The number of bytes consumed in the input buffers.
|
|
|
|
@throws system_error Thrown on failure.
|
|
*/
|
|
template<class ConstBufferSequence>
|
|
void
|
|
write_frame(bool fin, ConstBufferSequence const& buffers);
|
|
|
|
/** Write partial message data on the stream.
|
|
|
|
This function is used to write some or all of a message's
|
|
payload to the stream. The call will block until one of the
|
|
following conditions is true:
|
|
|
|
@li A frame is sent.
|
|
|
|
@li Message data is transferred to the write buffer.
|
|
|
|
@li An error occurs.
|
|
|
|
This operation is implemented in terms of one or more calls
|
|
to the stream's `write_some` function.
|
|
|
|
If this is the beginning of a new message, the message opcode
|
|
will be set to text or binary as per the current setting of
|
|
the @ref message_type option. The actual payload sent
|
|
may be transformed as per the WebSocket protocol settings.
|
|
|
|
@param fin `true` if this is the last frame in the message.
|
|
|
|
@param buffers The input buffer sequence holding the data to write.
|
|
|
|
@param ec Set to indicate what error occurred, if any.
|
|
|
|
@return The number of bytes consumed in the input buffers.
|
|
*/
|
|
template<class ConstBufferSequence>
|
|
void
|
|
write_frame(bool fin,
|
|
ConstBufferSequence const& buffers, error_code& ec);
|
|
|
|
/** Start an asynchronous operation to send a message frame on the stream.
|
|
|
|
This function is used to asynchronously write a message frame
|
|
on the stream. This function call always returns immediately.
|
|
The asynchronous operation will continue until one of the following
|
|
conditions is true:
|
|
|
|
@li The entire frame is sent.
|
|
|
|
@li An error occurs.
|
|
|
|
This operation is implemented in terms of one or more calls
|
|
to the next layer's `async_write_some` functions, and is known
|
|
as a <em>composed operation</em>. The actual payload sent
|
|
may be transformed as per the WebSocket protocol settings. The
|
|
program must ensure that the stream performs no other write
|
|
operations (such as stream::async_write, stream::async_write_frame,
|
|
or stream::async_close).
|
|
|
|
If this is the beginning of a new message, the message opcode
|
|
will be set to text or binary as per the current setting of
|
|
the @ref message_type option. The actual payload sent
|
|
may be transformed as per the WebSocket protocol settings.
|
|
|
|
@param fin A bool indicating whether or not the frame is the
|
|
last frame in the corresponding WebSockets message.
|
|
|
|
@param buffers A object meeting the requirements of
|
|
ConstBufferSequence which holds the payload data before any
|
|
masking or compression. Although the buffers object may be copied
|
|
as necessary, ownership of the underlying buffers is retained by
|
|
the caller, which must guarantee that they remain valid until
|
|
the handler is called.
|
|
|
|
@param handler The handler to be called when the write completes.
|
|
Copies will be made of the handler as required. The equivalent
|
|
function signature of the handler must be:
|
|
@code void handler(
|
|
error_code const& error // result of operation
|
|
); @endcode
|
|
*/
|
|
template<class ConstBufferSequence, class WriteHandler>
|
|
#if GENERATING_DOCS
|
|
void_or_deduced
|
|
#else
|
|
typename async_completion<
|
|
WriteHandler, void(error_code)>::result_type
|
|
#endif
|
|
async_write_frame(bool fin,
|
|
ConstBufferSequence const& buffers, WriteHandler&& handler);
|
|
|
|
private:
|
|
template<class Handler> class accept_op;
|
|
template<class Handler> class close_op;
|
|
template<class Handler> class handshake_op;
|
|
template<class Handler> class ping_op;
|
|
template<class Handler> class response_op;
|
|
template<class Buffers, class Handler> class write_op;
|
|
template<class Buffers, class Handler> class write_frame_op;
|
|
template<class DynamicBuffer, class Handler> class read_op;
|
|
template<class DynamicBuffer, class Handler> class read_frame_op;
|
|
|
|
void
|
|
reset();
|
|
|
|
http::request<http::empty_body>
|
|
build_request(boost::string_ref const& host,
|
|
boost::string_ref const& resource,
|
|
std::string& key);
|
|
|
|
template<class Body, class Fields>
|
|
http::response<http::string_body>
|
|
build_response(http::request<Body, Fields> const& req);
|
|
|
|
template<class Body, class Fields>
|
|
void
|
|
do_response(http::response<Body, Fields> const& resp,
|
|
boost::string_ref const& key, error_code& ec);
|
|
|
|
void
|
|
do_read_fh(detail::frame_streambuf& fb,
|
|
close_code::value& code, error_code& ec);
|
|
};
|
|
|
|
} // websocket
|
|
} // beast
|
|
|
|
#include <beast/websocket/impl/accept.ipp>
|
|
#include <beast/websocket/impl/close.ipp>
|
|
#include <beast/websocket/impl/handshake.ipp>
|
|
#include <beast/websocket/impl/ping.ipp>
|
|
#include <beast/websocket/impl/read.ipp>
|
|
#include <beast/websocket/impl/stream.ipp>
|
|
#include <beast/websocket/impl/write.ipp>
|
|
|
|
#endif
|