static_buffer_base

A dynamic buffer providing a fixed size, circular buffer.

Synopsis

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

class static_buffer_base

Types

Name	Description
const_buffers_type	The ConstBufferSequence used to represent the readable bytes.
mutable_buffers_type	The MutableBufferSequence used to represent the writable bytes.

Member Functions

Name	Description
capacity	Return the maximum number of bytes, both readable and writable, that can be held without requiring an allocation.
cdata	Returns a constant buffer sequence representing the readable bytes.
clear	Clear the readable and writable bytes to zero.
commit	Append writable bytes to the readable bytes.
consume	Remove bytes from beginning of the readable bytes.
data	Returns a constant buffer sequence representing the readable bytes. Returns a mutable buffer sequence representing the readable bytes.
max_size	Return the maximum number of bytes, both readable and writable, that can ever be held.
prepare	Returns a mutable buffer sequence representing writable bytes.
size	Returns the number of readable bytes.
static_buffer_base	Constructor.

A dynamic buffer encapsulates memory storage that may be automatically resized as required, where the memory is divided into two regions: readable bytes followed by writable bytes. These memory regions are internal to the dynamic buffer, but direct access to the elements is provided to permit them to be efficiently used with I/O operations. Objects of this type meet the requirements of DynamicBuffer and have the following additional properties:

A mutable buffer sequence representing the readable bytes is returned by data when this is non-const.
Buffer sequences representing the readable and writable bytes, returned by data and prepare, may have length up to two.
All operations execute in constant time.
Ownership of the underlying storage belongs to the derived class.

Remarks

Variables are usually declared using the template class static_buffer; however, to reduce the number of template instantiations, objects should be passed static_buffer_base&.

Boost C++ Libraries