forked from boostorg/beast
New buffer sequence classes are provided to allow full
control over the serialization of chunk-encoded message
payloads:
* chunk_header
A ConstBufferSequence representing the chunk header.
It includes a hexadecimal-encoded size, an optional
set of chunk extensions, and the trailing CRLF
required to denote the end of the chunk header.
This allows the caller to manually serialize the chunk
body in one or more calls to a stream output function.
The caller must also output an object of type `chunk_crlf`
to the stream to indicate the end of the chunk body.
* chunk_crlf
A small ConstBufferSequence that simply represents
the two character sequence "\r\n" (CRLF). This is needed
for the case where the caller wants to output a chunk
body as a series of buffers (i.e. "chunking a chunk").
* chunk_body
A ConstBufferSequence representing a complete chunk.
This includes the size, an optional set of chunk extensions,
a caller provided buffer containing the body, and the
required CRLF that follows.
* chunk_final
A ConstBufferSequence representing a final chunk. It
includes an optional set of caller-provided field trailers
* chunk_extensions
A container for building a set of chunk extensions to use
during serialization. The use of the container is optional,
callers may provide their own buffer containing a correctly
formatted set of chunk extensions, or they may use their
own convenience container which meets the requirements.
The basic_fields container is modified to allow construction
outside the context of a message. The container can be used
to provide trailers to `chunk_final`.
Actions Required:
* Remove references to ChunkDecorators. Use the new chunk-encoding
buffer sequences to manually produce a chunked payload body in
the case where control over the chunk-extensions and/or trailers
is required.
259 lines
5.1 KiB
C++
259 lines
5.1 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_DETAIL_CHUNK_ENCODE_HPP
|
|
#define BEAST_HTTP_DETAIL_CHUNK_ENCODE_HPP
|
|
|
|
#include <beast/core/type_traits.hpp>
|
|
#include <beast/http/type_traits.hpp>
|
|
#include <boost/asio/buffer.hpp>
|
|
#include <algorithm>
|
|
#include <array>
|
|
#include <cstddef>
|
|
|
|
namespace beast {
|
|
namespace http {
|
|
namespace detail {
|
|
|
|
struct chunk_extensions
|
|
{
|
|
virtual ~chunk_extensions() = default;
|
|
virtual boost::asio::const_buffers_1 str() = 0;
|
|
};
|
|
|
|
template<class ChunkExtensions>
|
|
struct chunk_extensions_impl : chunk_extensions
|
|
{
|
|
ChunkExtensions ext_;
|
|
|
|
chunk_extensions_impl(ChunkExtensions&& ext)
|
|
: ext_(std::move(ext))
|
|
{
|
|
}
|
|
|
|
chunk_extensions_impl(ChunkExtensions const& ext)
|
|
: ext_(ext)
|
|
{
|
|
}
|
|
|
|
boost::asio::const_buffers_1
|
|
str() override
|
|
{
|
|
auto const s = ext_.str();
|
|
return {s.data(), s.size()};
|
|
}
|
|
};
|
|
|
|
template<class T, class = void>
|
|
struct is_chunk_extensions : std::false_type {};
|
|
|
|
template<class T>
|
|
struct is_chunk_extensions<T, beast::detail::void_t<decltype(
|
|
std::declval<string_view&>() = std::declval<T&>().str(),
|
|
(void)0)>> : std::true_type
|
|
{
|
|
};
|
|
|
|
//------------------------------------------------------------------------------
|
|
|
|
/** A buffer sequence containing a chunk-encoding header
|
|
*/
|
|
class chunk_size
|
|
{
|
|
public:
|
|
// Storage for the longest hex string we might need
|
|
class value_type
|
|
{
|
|
friend class chunk_size;
|
|
|
|
// First byte holds the length
|
|
char buf_[1 + 2 * sizeof(std::size_t)];
|
|
|
|
template<class = void>
|
|
void
|
|
prepare(std::size_t n);
|
|
|
|
template<class OutIter>
|
|
static
|
|
OutIter
|
|
to_hex(OutIter last, std::size_t n)
|
|
{
|
|
if(n == 0)
|
|
{
|
|
*--last = '0';
|
|
return last;
|
|
}
|
|
while(n)
|
|
{
|
|
*--last = "0123456789abcdef"[n&0xf];
|
|
n>>=4;
|
|
}
|
|
return last;
|
|
}
|
|
public:
|
|
operator
|
|
boost::asio::const_buffer() const
|
|
{
|
|
return {
|
|
buf_ + sizeof(buf_) - buf_[0],
|
|
static_cast<unsigned>(buf_[0])};
|
|
}
|
|
};
|
|
|
|
using const_iterator = value_type const*;
|
|
|
|
chunk_size(chunk_size const& other) = default;
|
|
|
|
/** Construct a chunk header
|
|
|
|
@param n The number of octets in this chunk.
|
|
*/
|
|
chunk_size(std::size_t n)
|
|
{
|
|
value_.prepare(n);
|
|
}
|
|
|
|
const_iterator
|
|
begin() const
|
|
{
|
|
return &value_;
|
|
}
|
|
|
|
const_iterator
|
|
end() const
|
|
{
|
|
return begin() + 1;
|
|
}
|
|
|
|
private:
|
|
value_type value_;
|
|
};
|
|
|
|
template<class>
|
|
void
|
|
chunk_size::
|
|
value_type::
|
|
prepare(std::size_t n)
|
|
{
|
|
auto const last = &buf_[sizeof(buf_)];
|
|
auto it = to_hex(last, n);
|
|
buf_[0] = static_cast<char>(last - it);
|
|
}
|
|
|
|
//------------------------------------------------------------------------------
|
|
|
|
/// Returns a buffer sequence holding a CRLF for chunk encoding
|
|
inline
|
|
boost::asio::const_buffers_1
|
|
chunk_crlf()
|
|
{
|
|
return {"\r\n", 2};
|
|
}
|
|
|
|
/// Returns a buffer sequence holding a final chunk header
|
|
inline
|
|
boost::asio::const_buffers_1
|
|
chunk_last()
|
|
{
|
|
return {"0\r\n", 3};
|
|
}
|
|
|
|
//------------------------------------------------------------------------------
|
|
|
|
template<class = void>
|
|
struct chunk_crlf_iter_type
|
|
{
|
|
class value_type
|
|
{
|
|
char const s[2] = {'\r', '\n'};
|
|
|
|
public:
|
|
value_type() = default;
|
|
|
|
operator
|
|
boost::asio::const_buffer() const
|
|
{
|
|
return {s, sizeof(s)};
|
|
}
|
|
};
|
|
static value_type value;
|
|
};
|
|
|
|
template<class T>
|
|
typename chunk_crlf_iter_type<T>::value_type
|
|
chunk_crlf_iter_type<T>::value;
|
|
|
|
using chunk_crlf_iter = chunk_crlf_iter_type<void>;
|
|
|
|
//------------------------------------------------------------------------------
|
|
|
|
template<class = void>
|
|
struct chunk_size0_iter_type
|
|
{
|
|
class value_type
|
|
{
|
|
char const s[3] = {'0', '\r', '\n'};
|
|
|
|
public:
|
|
value_type() = default;
|
|
|
|
operator
|
|
boost::asio::const_buffer() const
|
|
{
|
|
return {s, sizeof(s)};
|
|
}
|
|
};
|
|
static value_type value;
|
|
};
|
|
|
|
template<class T>
|
|
typename chunk_size0_iter_type<T>::value_type
|
|
chunk_size0_iter_type<T>::value;
|
|
|
|
using chunk_size0_iter = chunk_size0_iter_type<void>;
|
|
|
|
struct chunk_size0
|
|
{
|
|
using value_type = chunk_size0_iter::value_type;
|
|
|
|
using const_iterator = value_type const*;
|
|
|
|
const_iterator
|
|
begin() const
|
|
{
|
|
return &chunk_size0_iter::value;
|
|
}
|
|
|
|
const_iterator
|
|
end() const
|
|
{
|
|
return begin() + 1;
|
|
}
|
|
};
|
|
|
|
//------------------------------------------------------------------------------
|
|
|
|
template<class T,
|
|
bool = is_fields<T>::value>
|
|
struct buffers_or_fields
|
|
{
|
|
using type = typename
|
|
T::reader::const_buffers_type;
|
|
};
|
|
|
|
template<class T>
|
|
struct buffers_or_fields<T, false>
|
|
{
|
|
using type = T;
|
|
};
|
|
|
|
} // detail
|
|
} // http
|
|
} // beast
|
|
|
|
#endif
|