mirror of
https://github.com/Xahau/xahaud.git
synced 2025-12-06 17:27:52 +00:00
af4fe24939
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
291 lines
9.5 KiB
C++
291 lines
9.5 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_HTTP_WRITE_HPP
|
|
#define BEAST_HTTP_WRITE_HPP
|
|
|
|
#include <beast/http/message.hpp>
|
|
#include <beast/core/error.hpp>
|
|
#include <beast/core/async_completion.hpp>
|
|
#include <ostream>
|
|
#include <type_traits>
|
|
|
|
namespace beast {
|
|
namespace http {
|
|
|
|
/** Write a HTTP/1 header to a stream.
|
|
|
|
This function is used to synchronously write a header to
|
|
a stream. The call will block until one of the following
|
|
conditions is true:
|
|
|
|
@li The entire header is written.
|
|
|
|
@li An error occurs.
|
|
|
|
This operation is implemented in terms of one or more calls
|
|
to the stream's `write_some` function.
|
|
|
|
Regardless of the semantic meaning of the header (for example,
|
|
specifying "Content-Length: 0" and "Connection: close"),
|
|
this function will not return `boost::asio::error::eof`.
|
|
|
|
@param stream The stream to which the data is to be written.
|
|
The type must support the @b `SyncWriteStream` concept.
|
|
|
|
@param msg The header to write.
|
|
|
|
@throws system_error Thrown on failure.
|
|
*/
|
|
template<class SyncWriteStream,
|
|
bool isRequest, class Fields>
|
|
void
|
|
write(SyncWriteStream& stream,
|
|
header<isRequest, Fields> const& msg);
|
|
|
|
/** Write a HTTP/1 header to a stream.
|
|
|
|
This function is used to synchronously write a header to
|
|
a stream. The call will block until one of the following
|
|
conditions is true:
|
|
|
|
@li The entire header is written.
|
|
|
|
@li An error occurs.
|
|
|
|
This operation is implemented in terms of one or more calls
|
|
to the stream's `write_some` function.
|
|
|
|
Regardless of the semantic meaning of the header (for example,
|
|
specifying "Content-Length: 0" and "Connection: close"),
|
|
this function will not return `boost::asio::error::eof`.
|
|
|
|
@param stream The stream to which the data is to be written.
|
|
The type must support the @b `SyncWriteStream` concept.
|
|
|
|
@param msg The header to write.
|
|
|
|
@param ec Set to the error, if any occurred.
|
|
*/
|
|
template<class SyncWriteStream,
|
|
bool isRequest, class Fields>
|
|
void
|
|
write(SyncWriteStream& stream,
|
|
header<isRequest, Fields> const& msg,
|
|
error_code& ec);
|
|
|
|
/** Write a HTTP/1 header asynchronously to a stream.
|
|
|
|
This function is used to asynchronously write a header to
|
|
a stream. The function call always returns immediately. The
|
|
asynchronous operation will continue until one of the following
|
|
conditions is true:
|
|
|
|
@li The entire header is written.
|
|
|
|
@li An error occurs.
|
|
|
|
This operation is implemented in terms of one or more calls to
|
|
the stream'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 until this operation
|
|
completes.
|
|
|
|
Regardless of the semantic meaning of the header (for example,
|
|
specifying "Content-Length: 0" and "Connection: close"),
|
|
this function will not return `boost::asio::error::eof`.
|
|
|
|
@param stream The stream to which the data is to be written.
|
|
The type must support the @b `AsyncWriteStream` concept.
|
|
|
|
@param msg The header to write. The object must remain valid
|
|
at least until the completion handler is called; ownership is
|
|
not transferred.
|
|
|
|
@param handler The handler to be called when the operation
|
|
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 AsyncWriteStream,
|
|
bool isRequest, class Fields,
|
|
class WriteHandler>
|
|
#if GENERATING_DOCS
|
|
void_or_deduced
|
|
#else
|
|
typename async_completion<
|
|
WriteHandler, void(error_code)>::result_type
|
|
#endif
|
|
async_write(AsyncWriteStream& stream,
|
|
header<isRequest, Fields> const& msg,
|
|
WriteHandler&& handler);
|
|
|
|
//------------------------------------------------------------------------------
|
|
|
|
/** Write a HTTP/1 message to a stream.
|
|
|
|
This function is used to write a message to a stream. The call
|
|
will block until one of the following conditions is true:
|
|
|
|
@li The entire message is written.
|
|
|
|
@li An error occurs.
|
|
|
|
This operation is implemented in terms of one or more calls
|
|
to the stream's `write_some` function.
|
|
|
|
The implementation will automatically perform chunk encoding if
|
|
the contents of the message indicate that chunk encoding is required.
|
|
If the semantics of the message indicate that the connection should
|
|
be closed after the message is sent, the error thrown from this
|
|
function will be `boost::asio::error::eof`.
|
|
|
|
@param stream The stream to which the data is to be written.
|
|
The type must support the @b `SyncWriteStream` concept.
|
|
|
|
@param msg The message to write.
|
|
|
|
@throws system_error Thrown on failure.
|
|
*/
|
|
template<class SyncWriteStream,
|
|
bool isRequest, class Body, class Fields>
|
|
void
|
|
write(SyncWriteStream& stream,
|
|
message<isRequest, Body, Fields> const& msg);
|
|
|
|
/** Write a HTTP/1 message on a stream.
|
|
|
|
This function is used to write a message to a stream. The call
|
|
will block until one of the following conditions is true:
|
|
|
|
@li The entire message is written.
|
|
|
|
@li An error occurs.
|
|
|
|
This operation is implemented in terms of one or more calls
|
|
to the stream's `write_some` function.
|
|
|
|
The implementation will automatically perform chunk encoding if
|
|
the contents of the message indicate that chunk encoding is required.
|
|
If the semantics of the message indicate that the connection should
|
|
be closed after the message is sent, the error returned from this
|
|
function will be `boost::asio::error::eof`.
|
|
|
|
@param stream The stream to which the data is to be written.
|
|
The type must support the @b `SyncWriteStream` concept.
|
|
|
|
@param msg The message to write.
|
|
|
|
@param ec Set to the error, if any occurred.
|
|
*/
|
|
template<class SyncWriteStream,
|
|
bool isRequest, class Body, class Fields>
|
|
void
|
|
write(SyncWriteStream& stream,
|
|
message<isRequest, Body, Fields> const& msg,
|
|
error_code& ec);
|
|
|
|
/** Write a HTTP/1 message asynchronously to a stream.
|
|
|
|
This function is used to asynchronously write a message to
|
|
a 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 written.
|
|
|
|
@li An error occurs.
|
|
|
|
This operation is implemented in terms of one or more calls to
|
|
the stream'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 until this operation
|
|
completes.
|
|
|
|
The implementation will automatically perform chunk encoding if
|
|
the contents of the message indicate that chunk encoding is required.
|
|
If the semantics of the message indicate that the connection should
|
|
be closed after the message is sent, the operation will complete with
|
|
the error set to `boost::asio::error::eof`.
|
|
|
|
@param stream The stream to which the data is to be written.
|
|
The type must support the @b `AsyncWriteStream` concept.
|
|
|
|
@param msg The message to write. The object must remain valid
|
|
at least until the completion handler is called; ownership is
|
|
not transferred.
|
|
|
|
@param handler The handler to be called when the operation
|
|
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 AsyncWriteStream,
|
|
bool isRequest, class Body, class Fields,
|
|
class WriteHandler>
|
|
#if GENERATING_DOCS
|
|
void_or_deduced
|
|
#else
|
|
typename async_completion<
|
|
WriteHandler, void(error_code)>::result_type
|
|
#endif
|
|
async_write(AsyncWriteStream& stream,
|
|
message<isRequest, Body, Fields> const& msg,
|
|
WriteHandler&& handler);
|
|
|
|
//------------------------------------------------------------------------------
|
|
|
|
/** Serialize a HTTP/1 header to a `std::ostream`.
|
|
|
|
The function converts the header to its HTTP/1 serialized
|
|
representation and stores the result in the output stream.
|
|
|
|
@param os The output stream to write to.
|
|
|
|
@param msg The message fields to write.
|
|
*/
|
|
template<bool isRequest, class Fields>
|
|
std::ostream&
|
|
operator<<(std::ostream& os,
|
|
header<isRequest, Fields> const& msg);
|
|
|
|
/** Serialize a HTTP/1 message to a `std::ostream`.
|
|
|
|
The function converts the message to its HTTP/1 serialized
|
|
representation and stores the result in the output stream.
|
|
|
|
The implementation will automatically perform chunk encoding if
|
|
the contents of the message indicate that chunk encoding is required.
|
|
|
|
@param os The output stream to write to.
|
|
|
|
@param msg The message to write.
|
|
*/
|
|
template<bool isRequest, class Body, class Fields>
|
|
std::ostream&
|
|
operator<<(std::ostream& os,
|
|
message<isRequest, Body, Fields> const& msg);
|
|
|
|
} // http
|
|
} // beast
|
|
|
|
#include <beast/http/impl/write.ipp>
|
|
|
|
#endif
|