mirror of
https://github.com/Xahau/xahaud.git
synced 2025-12-06 17:27:52 +00:00
d8dea963fa
6d5547a Set version to 1.0.0-b34 6fab138 Fix and tidy up CMake build scripts: ccefa54 Set version to 1.0.0-b33 32afe41 Set internal state correctly when writing frames: fe3e20b Add write_frames unit test 578dcd0 Add decorator unit test aaa3733 Use fwrite return value in file_body df66165 Require Visual Studio 2015 Update 3 or later b8e5a21 Set version to 1.0.0-b32 ffb1758 Update CMake scripts for finding packages: b893749 Remove http Writer suspend and resume feature (API Change): 27864fb Add io_service completion invariants tests eba05a7 Set version to 1.0.0-b31 484bcef Fix badge markdown in README.md 5663bea Add missing dynabuf_readstream member 0d7a551 Tidy up build settings 0fd4030 Move the handler, don't copy it git-subtree-dir: src/beast git-subtree-split: 6d5547a32c50ec95832c4779311502555ab0ee1f
292 lines
9.6 KiB
C++
292 lines
9.6 KiB
C++
//
|
|
// Copyright (c) 2013-2017 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/config.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
|