boost::beast::static_buffer< N > Class Template Reference

#include <static_buffer.hpp>

Inheritance diagram for boost::beast::static_buffer< N >:

Public Member Functions
	static_buffer (static_buffer const &)
	Constructor. More...
	static_buffer ()
	Constructor. More...
static_buffer &	operator= (static_buffer const &)
	Assignment. More...
static_buffer_base &	base ()
	Returns the static_buffer_base portion of this object. More...
static_buffer_base const &	base () const
	Returns the static_buffer_base portion of this object. More...
std::size_t constexpr	max_size () const
	Return the maximum sum of the input and output sequence sizes. More...
std::size_t constexpr	capacity () const
	Return the maximum sum of input and output sizes that can be held without an allocation. More...
Public Member Functions inherited from boost::beast::static_buffer_base
	static_buffer_base (void *p, std::size_t size)
std::size_t	size () const
	Return the size of the input sequence. More...
std::size_t	max_size () const
	Return the maximum sum of the input and output sequence sizes. More...
std::size_t	capacity () const
	Return the maximum sum of input and output sizes that can be held without an allocation. More...
const_buffers_type	data () const
mutable_buffers_type	prepare (std::size_t size)
void	commit (std::size_t size)
void	consume (std::size_t size)

Additional Inherited Members
Public Types inherited from boost::beast::static_buffer_base
using	const_buffers_type = std::array< boost::asio::mutable_buffer, 2 >
	The type used to represent the input sequence as a list of buffers. More...
using	mutable_buffers_type = std::array< boost::asio::mutable_buffer, 2 >
	The type used to represent the output sequence as a list of buffers. More...
Protected Member Functions inherited from boost::beast::static_buffer_base
	static_buffer_base ()
void	reset (void *p, std::size_t size)

Detailed Description

template<std::size_t N>
class boost::beast::static_buffer< N >

A circular DynamicBuffer with a fixed size internal buffer.

This implements a circular dynamic buffer. Calls to prepare never require moving memory. The buffer sequences returned may be up to length two. Ownership of the underlying storage belongs to the derived class.

Template Parameters

N	The number of bytes in the internal buffer.

Note

To reduce the number of template instantiations when passing objects of this type in a deduced context, the signature of the receiving function should use static_buffer_base instead.

See also

static_buffer_base

Constructor & Destructor Documentation

template<std::size_t N>

boost::beast::static_buffer< N >::static_buffer

(

static_buffer< N > const &

other

)

Constructor.

template<std::size_t N>

boost::beast::static_buffer< N >::static_buffer ( )

inline

Constructor.

Member Function Documentation

template<std::size_t N>

static_buffer_base& boost::beast::static_buffer< N >::base ( )

inline

Returns the static_buffer_base portion of this object.

template<std::size_t N>

static_buffer_base const& boost::beast::static_buffer< N >::base ( ) const

inline

Returns the static_buffer_base portion of this object.

template<std::size_t N>

std::size_t constexpr boost::beast::static_buffer< N >::capacity ( ) const

inline

Return the maximum sum of input and output sizes that can be held without an allocation.

template<std::size_t N>

std::size_t constexpr boost::beast::static_buffer< N >::max_size ( ) const

inline

Return the maximum sum of the input and output sequence sizes.

template<std::size_t N>

auto boost::beast::static_buffer< N >::operator=

(

static_buffer< N > const &

other

)

Assignment.

---

The documentation for this class was generated from the following files:

• 3pp/beast/boost/beast/core/static_buffer.hpp
• 3pp/beast/boost/beast/core/impl/static_buffer.ipp