#include <bdlma_bufferedsequentialallocator.h>

Inheritance diagram for bdlma::BufferedSequentialAllocator:

Public Types
typedef bsls::Types::size_type	size_type
Public Member Functions
	BufferedSequentialAllocator (char buffer, bsls::Types::size_type size, bslma::Allocator basicAllocator=0)
	BufferedSequentialAllocator (char buffer, bsls::Types::size_type size, bsls::BlockGrowth::Strategy growthStrategy, bslma::Allocator basicAllocator=0)
	BufferedSequentialAllocator (char buffer, bsls::Types::size_type size, bsls::Alignment::Strategy alignmentStrategy, bslma::Allocator basicAllocator=0)
	BufferedSequentialAllocator (char buffer, bsls::Types::size_type size, bsls::BlockGrowth::Strategy growthStrategy, bsls::Alignment::Strategy alignmentStrategy, bslma::Allocator basicAllocator=0)
	BufferedSequentialAllocator (char buffer, bsls::Types::size_type size, bsls::Types::size_type maxBufferSize, bslma::Allocator basicAllocator=0)
	BufferedSequentialAllocator (char buffer, bsls::Types::size_type size, bsls::Types::size_type maxBufferSize, bsls::BlockGrowth::Strategy growthStrategy, bslma::Allocator basicAllocator=0)
	BufferedSequentialAllocator (char buffer, bsls::Types::size_type size, bsls::Types::size_type maxBufferSize, bsls::Alignment::Strategy alignmentStrategy, bslma::Allocator basicAllocator=0)
	BufferedSequentialAllocator (char buffer, bsls::Types::size_type size, bsls::Types::size_type maxBufferSize, bsls::BlockGrowth::Strategy growthStrategy, bsls::Alignment::Strategy alignmentStrategy, bslma::Allocator basicAllocator=0)
virtual	~BufferedSequentialAllocator ()
virtual void *	allocate (size_type size)
virtual void	deallocate (void *address)
virtual void	release ()
virtual void	rewind ()
template<class TYPE >
void	deleteObject (const TYPE *object)
void	deleteObject (bsl::nullptr_t)
template<class TYPE >
void	deleteObjectRaw (const TYPE *object)
void	deleteObjectRaw (bsl::nullptr_t)
Static Public Member Functions
static void	throwBadAlloc ()

Detailed Description

This class implements the ManagedAllocator protocol to provide a fast allocator that dispenses heterogeneous blocks of memory (of varying, user-specified sizes) from an external buffer whose address and size (in bytes) are supplied at construction. If an allocation request exceeds the remaining free memory space in the external buffer, memory will be supplied by an (optional) allocator also supplied at construction; if no allocator is supplied, the currently installed default allocator is used. This class is exception neutral: If memory cannot be allocated, the behavior is defined by the (optional) allocator supplied at construction. Note that in no case will the buffered sequential allocator attempt to deallocate the external buffer.

See Component bdlma_bufferedsequentialallocator

Member Typedef Documentation

typedef bsls::Types::size_type bslma::Allocator::size_type [inherited]

Reimplemented in bdlma::ConcurrentPoolAllocator.

Constructor & Destructor Documentation

bdlma::BufferedSequentialAllocator::BufferedSequentialAllocator	(	char *	buffer,
		bsls::Types::size_type	size,
		bslma::Allocator *	basicAllocator = `0`
	)

bdlma::BufferedSequentialAllocator::BufferedSequentialAllocator	(	char *	buffer,
		bsls::Types::size_type	size,
		bsls::BlockGrowth::Strategy	growthStrategy,
		bslma::Allocator *	basicAllocator = `0`
	)

bdlma::BufferedSequentialAllocator::BufferedSequentialAllocator	(	char *	buffer,
		bsls::Types::size_type	size,
		bsls::Alignment::Strategy	alignmentStrategy,
		bslma::Allocator *	basicAllocator = `0`
	)

bdlma::BufferedSequentialAllocator::BufferedSequentialAllocator	(	char *	buffer,
		bsls::Types::size_type	size,
		bsls::BlockGrowth::Strategy	growthStrategy,
		bsls::Alignment::Strategy	alignmentStrategy,
		bslma::Allocator *	basicAllocator = `0`
	)

Create a buffered sequential allocator for allocating memory blocks from the specified external buffer having the specified size (in bytes). Optionally specify a growthStrategy used to control buffer growth. If a growthStrategy is not specified, geometric growth is used. Optionally specify an alignmentStrategy used to align allocated memory blocks. If an alignmentStrategy is not specified, natural alignment is used. Optionally specify a basicAllocator used to supply memory should the capacity of buffer be exhausted. If basicAllocator is 0, the currently installed default allocator is used. The behavior is undefined unless 0 < size, and buffer has at least size bytes. Note that, due to alignment effects, it is possible that not all size bytes of memory in buffer can be used for allocation. Also note that no limit is imposed on the size of the internal buffers when geometric growth is used. Also note that when constant growth is used, the size of the internal buffers will always be the same as size.

bdlma::BufferedSequentialAllocator::BufferedSequentialAllocator	(	char *	buffer,
		bsls::Types::size_type	size,
		bsls::Types::size_type	maxBufferSize,
		bslma::Allocator *	basicAllocator = `0`
	)

bdlma::BufferedSequentialAllocator::BufferedSequentialAllocator	(	char *	buffer,
		bsls::Types::size_type	size,
		bsls::Types::size_type	maxBufferSize,
		bsls::BlockGrowth::Strategy	growthStrategy,
		bslma::Allocator *	basicAllocator = `0`
	)

bdlma::BufferedSequentialAllocator::BufferedSequentialAllocator	(	char *	buffer,
		bsls::Types::size_type	size,
		bsls::Types::size_type	maxBufferSize,
		bsls::Alignment::Strategy	alignmentStrategy,
		bslma::Allocator *	basicAllocator = `0`
	)

bdlma::BufferedSequentialAllocator::BufferedSequentialAllocator	(	char *	buffer,
		bsls::Types::size_type	size,
		bsls::Types::size_type	maxBufferSize,
		bsls::BlockGrowth::Strategy	growthStrategy,
		bsls::Alignment::Strategy	alignmentStrategy,
		bslma::Allocator *	basicAllocator = `0`
	)

Create a buffered sequential allocator for allocating memory blocks from the specified external buffer having the specified size (in bytes), or from an internal buffer (after the external buffer is exhausted) where the buffer growth is limited to the specified maxBufferSize (in bytes). Optionally specify a growthStrategy used to control buffer growth. If a growthStrategy is not specified, geometric growth is used. Optionally specify an alignmentStrategy used to align allocated memory blocks. If an alignmentStrategy is not specified, natural alignment is used. Optionally specify a basicAllocator used to supply memory should the capacity of buffer be exhausted. If basicAllocator is 0, the currently installed default allocator is used. The behavior is undefined unless 0 < size, size <= maxBufferSize, and buffer has at least size bytes. Note that, due to alignment effects, it is possible that not all size bytes of memory in buffer can be used for allocation. Also note that when constant growth is used, the size of the internal buffers will always be the same as size.

virtual bdlma::BufferedSequentialAllocator::~BufferedSequentialAllocator ( ) [virtual]

Destroy this buffered sequential allocator. All memory allocated from this allocator is released.

Member Function Documentation

virtual void* bdlma::BufferedSequentialAllocator::allocate ( size_type size ) [virtual]

Return the address of a contiguous block of memory of the specified size (in bytes) according to the alignment strategy specified at construction. If size is 0, no memory is allocated and 0 is returned. If the allocation request exceeds the remaining free memory space in the external buffer supplied at construction, use memory obtained from the allocator supplied at construction.

Implements bslma::Allocator.

virtual void bdlma::BufferedSequentialAllocator::deallocate ( void * address ) [virtual]

This method has no effect on the memory block at the specified address as all memory allocated by this allocator is managed. The behavior is undefined unless address is 0, or was allocated by this allocator and has not already been deallocated. The effect of using address after this call is undefined.

Implements bslma::Allocator.

virtual void bdlma::BufferedSequentialAllocator::release ( ) [virtual]

Release all memory allocated through this allocator and return to the underlying allocator all memory except the external buffer supplied at construction. The allocator is reset to its default-constructed state, making the memory from the entire external buffer supplied at construction available for subsequent allocations, retaining the alignment and growth strategies, and the initial and maximum buffer sizes in effect following construction. The effect of subsequently - to this invokation of release - using a pointer obtained from this object prior to this call to release is undefined.

Implements bdlma::ManagedAllocator.

virtual void bdlma::BufferedSequentialAllocator::rewind ( ) [virtual]

Release all memory allocated through this allocator and return to the underlying allocator only memory that was allocated outside of the typical internal buffer growth of this allocator (i.e., large blocks). All retained memory will be used to satisfy subsequent allocations. The effect of subsequently - to this invokation of rewind - using a pointer obtained from this object prior to this call to rewind is undefined.

static void bslma::Allocator::throwBadAlloc ( ) [static, inherited]

DEPRECATED: Use bsls::BslExceptionUtil::throwBadAlloc instead.

Throw std::bad_alloc if exceptions are enabled or abort the program otherwise. Derived classes and helper functions will typically call this function when they are unable to satisfy an allocation request. This function never returns.

template<class TYPE >

void bslma::Allocator::deleteObject ( const TYPE * object ) [inherited]

Destroy the specified object based on its dynamic type and then use this allocator to deallocate its memory footprint. Do nothing if object is a null pointer. The behavior is undefined unless object, when cast appropriately to void *, was allocated using this allocator 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.

void bslma::Allocator::deleteObject ( bsl::nullptr_t ) [inherited]

This function has no effect. Note that it exists to support calling deleteObject will a null pointer literal, that would otherwise not deduce to a pointer type for the method above. As calls to deleteObject with (typed) null pointer values have well-defined behavior, it should also support calls with a null pointer literal.

template<class TYPE >

void bslma::Allocator::deleteObjectRaw ( const TYPE * object ) [inherited]

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

void bslma::Allocator::deleteObjectRaw ( bsl::nullptr_t ) [inherited]

This function has no effect. Note that it exists to support calling deleteObjectRaw will a null pointer literal, that would otherwise not deduce to a pointer type for the method above. As calls to deleteObjectRaw with (typed) null pointer values have well-defined behavior, it should also support calls with a null pointer literal.

The documentation for this class was generated from the following file:

bdlma_bufferedsequentialallocator.h

bdlma::BufferedSequentialAllocator Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation