This class implements a memory pool that allocates and manages memory blocks of some uniform size specified at construction. This memory pool maintains an internal linked list of free memory blocks, and dispenses one block for each allocate method invocation. When a memory block is deallocated, it is returned to the free list for potential reuse.

Synopsis

Declared in <bdlma_concurrentpool.h>

class ConcurrentPool;

Description

This class guarantees thread safety while allocating or releasing memory.

Member Functions

Name

Description

ConcurrentPool [constructor]

Constructors

~ConcurrentPool [destructor]

Destroy this pool, releasing all associated memory back to the underlying allocator.

allocate

Return the address of a contiguous block of memory having the fixed block size specified at construction.

allocator

Return the allocator used by this object to allocate memory. Note that this allocator can not be used to deallocate memory allocated through this pool.

blockSize

Return the size (in bytes) of the memory blocks allocated from this pool object. Note that all blocks dispensed by this pool have the same size.

deallocate

Relinquish the memory block at the specified address back to this pool object for reuse. The behavior is undefined unless address is non‐zero, was allocated by this pool, and has not already been deallocated.

deleteObject

Destroy the specified object based on its dynamic type and then use this pool to deallocate its memory footprint. This method has no effect if object is 0. The behavior is undefined unless object, when cast appropriately to void *, was allocated using this pool and has not already been deallocated. Note that dynamic_cast<void *>(object) is applied if TYPE is polymorphic, and static_cast<void *>(object) is applied otherwise.

deleteObjectRaw

Destroy the specified object and then use this pool to deallocate its memory footprint. This method has no effect if object is 0. The behavior is undefined unless object is not a secondary base class pointer (i.e., the address is (numerically) the same as when it was originally dispensed by this pool), was allocated using this pool, and has not already been deallocated.

release

Relinquish all memory currently allocated via this pool object.

reserveCapacity

Reserve memory from this pool to satisfy memory requests for at least the specified numBlocks before the pool replenishes. The behavior is undefined unless 0 <= numBlocks.

Created with MrDocs