...one of the most highly
regarded and expertly designed C++ library projects in the
world.
— Herb Sutter and Andrei
Alexandrescu, C++
Coding Standards
boost::interprocess::allocator
// In header: <boost/interprocess/interprocess_fwd.hpp> template<typename T, typename SegmentManager> class allocator { public: // construct/copy/destruct allocator(segment_manager *); allocator(const allocator &); template<typename T2> allocator(const allocator< T2, SegmentManager > &); // public member functions segment_manager * get_segment_manager() const; pointer allocate(size_type, cvoid_ptr = 0); void deallocate(const pointer &, size_type); size_type max_size() const; size_type size(const pointer &) const; std::pair< pointer, bool > allocation_command(boost::interprocess::allocation_type, size_type, size_type, size_type &, const pointer & = 0); void allocate_many(size_type, size_type, multiallocation_chain &); void allocate_many(const size_type *, size_type, multiallocation_chain &); void deallocate_many(multiallocation_chain &); pointer allocate_one(); void allocate_individual(size_type, multiallocation_chain &); void deallocate_one(const pointer &); void deallocate_individual(multiallocation_chain &); pointer address(reference) const; const_pointer address(const_reference) const; template<typename P> void construct(const pointer &, P &&); void destroy(const pointer &); // friend functions friend void swap(self_t &, self_t &); };
An STL compatible allocator that uses a segment manager as memory source. The internal pointer type will of the same type (raw, smart) as "typename SegmentManager::void_pointer" type. This allows placing the allocator in shared memory, memory mapped-files, etc...
allocator
public
construct/copy/destructallocator(segment_manager * segment_mngr);
Constructor from the segment manager. Never throws
allocator(const allocator & other);
Constructor from other allocator. Never throws
template<typename T2> allocator(const allocator< T2, SegmentManager > & other);
Constructor from related allocator. Never throws
allocator
public member functionssegment_manager * get_segment_manager() const;
Returns the segment manager. Never throws
pointer allocate(size_type count, cvoid_ptr hint = 0);
Allocates memory for an array of count elements. Throws boost::interprocess::bad_alloc
if there is no enough memory
void deallocate(const pointer & ptr, size_type);
Deallocates memory previously allocated. Never throws
size_type max_size() const;
Returns the number of elements that could be allocated. Never throws
size_type size(const pointer & p) const;
Returns maximum the number of objects the previously allocated memory pointed by p can hold. This size only works for memory allocated with allocate, allocation_command and allocate_many.
std::pair< pointer, bool > allocation_command(boost::interprocess::allocation_type command, size_type limit_size, size_type preferred_size, size_type & received_size, const pointer & reuse = 0);
void allocate_many(size_type elem_size, size_type num_elements, multiallocation_chain & chain);
Allocates many elements of size elem_size in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. The elements must be deallocated with deallocate(...)
void allocate_many(const size_type * elem_sizes, size_type n_elements, multiallocation_chain & chain);
Allocates n_elements elements, each one of size elem_sizes[i]in a contiguous block of memory. The elements must be deallocated
void deallocate_many(multiallocation_chain & chain);
Allocates many elements of size elem_size in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. The elements must be deallocated with deallocate(...)
pointer allocate_one();
Allocates just one object. Memory allocated with this function must be deallocated only with deallocate_one(). Throws boost::interprocess::bad_alloc
if there is no enough memory
void allocate_individual(size_type num_elements, multiallocation_chain & chain);
Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one().
void deallocate_one(const pointer & p);
Deallocates memory previously allocated with allocate_one(). You should never use deallocate_one to deallocate memory allocated with other functions different from allocate_one(). Never throws
void deallocate_individual(multiallocation_chain & chain);
Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one().
pointer address(reference value) const;
Returns address of mutable object. Never throws
const_pointer address(const_reference value) const;
Returns address of non mutable object. Never throws
template<typename P> void construct(const pointer & ptr, P && p);
Constructs an object Throws if T's constructor throws For backwards compatibility with libraries using C++03 allocators
void destroy(const pointer & ptr);
Destroys object. Throws if object's destructor throws
allocator
friend functionsfriend void swap(self_t & alloc1, self_t & alloc2);
Swap segment manager. Does not throw. If each allocator is placed in different memory segments, the result is undefined.
Swaps allocators. Does not throw. If each allocator is placed in a different shared memory segments, the result is undefined.
Swaps allocators. Does not throw. If each allocator is placed in a different memory segment, the result is undefined.