Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for a snapshot of the master branch, built from commit 25d613dfbc.
PrevUpHomeNext

Struct pool_options

boost::container::pmr::pool_options

Synopsis

// In header: <boost/container/pmr/pool_options.hpp>


struct pool_options {
  // construct/copy/destruct
  pool_options();

  // public data members
  std::size_t max_blocks_per_chunk;
  std::size_t largest_required_pool_block;
};

Description

The members of pool_options comprise a set of constructor options for pool resources. The effect of each option on the pool resource behavior is described below:

  • std::size_t max_blocks_per_chunk: The maximum number of blocks that will be allocated at once from the upstream memory resource to replenish a pool. If the value of max_blocks_per_chunk is zero or is greater than an implementation-defined limit, that limit is used instead. The implementation may choose to use a smaller value than is specified in this field and may use different values for different pools.

  • std::size_t largest_required_pool_block: The largest allocation size that is required to be fulfilled using the pooling mechanism. Attempts to allocate a single block larger than this threshold will be allocated directly from the upstream memory resource. If largest_required_pool_block is zero or is greater than an implementation-defined limit, that limit is used instead. The implementation may choose a pass-through threshold larger than specified in this field.

pool_options public construct/copy/destruct

  1. pool_options();

PrevUpHomeNext