multi_buffer

A typical multi buffer.

Synopsis

Defined in header <boost/beast/core/multi_buffer.hpp>

using multi_buffer = basic_multi_buffer< std::allocator< char >>;

Types

Name	Description
allocator_type	The type of allocator used.
const_buffers_type	The type used to represent the input sequence as a list of buffers.
mutable_buffers_type	The type used to represent the output sequence as a list of buffers.

Member Functions

Name	Description
basic_multi_buffer	Constructor. Move constructor. Copy constructor.
capacity	Returns the maximum sum of the sizes of the input sequence and output sequence the buffer can hold without requiring reallocation.
commit	Move bytes from the output sequence to the input sequence.
consume	Remove bytes from the input sequence.
data	Get a list of buffers that represents the input sequence.
get_allocator	Returns a copy of the associated allocator.
max_size	Returns the permitted maximum sum of the sizes of the input and output sequence.
operator=	Move assignment. Copy assignment.
prepare	Get a list of buffers that represents the output sequence, with the given size.
size	Returns the size of the input sequence.
~basic_multi_buffer	Destructor.

Friends

Name	Description
swap

The implementation uses a sequence of one or more character arrays of varying sizes. Additional character array objects are appended to the sequence to accommodate changes in the size of the character sequence.

Remarks

Meets the requirements of DynamicBuffer.

Template Parameters

Type	Description
`Allocator`	The allocator to use for managing memory.

Convenience header <boost/beast/core.hpp>