summaryrefslogtreecommitdiff
path: root/boost/container/pmr/pool_options.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'boost/container/pmr/pool_options.hpp')
-rw-r--r--boost/container/pmr/pool_options.hpp52
1 files changed, 52 insertions, 0 deletions
diff --git a/boost/container/pmr/pool_options.hpp b/boost/container/pmr/pool_options.hpp
new file mode 100644
index 0000000000..e9f72896b1
--- /dev/null
+++ b/boost/container/pmr/pool_options.hpp
@@ -0,0 +1,52 @@
+//////////////////////////////////////////////////////////////////////////////
+//
+// (C) Copyright Ion Gaztanaga 2015-2015. 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)
+//
+// See http://www.boost.org/libs/container for documentation.
+//
+//////////////////////////////////////////////////////////////////////////////
+
+#ifndef BOOST_CONTAINER_PMR_POOL_OPTIONS_HPP
+#define BOOST_CONTAINER_PMR_POOL_OPTIONS_HPP
+
+#if defined (_MSC_VER)
+# pragma once
+#endif
+
+#include <cstddef>
+
+namespace boost {
+namespace container {
+namespace pmr {
+
+//! 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.
+struct pool_options
+{
+ pool_options()
+ : max_blocks_per_chunk(0u), largest_required_pool_block(0u)
+ {}
+ std::size_t max_blocks_per_chunk;
+ std::size_t largest_required_pool_block;
+};
+
+} //namespace pmr {
+} //namespace container {
+} //namespace boost {
+
+#endif //BOOST_CONTAINER_PMR_POOL_OPTIONS_HPP