Cpl::Memory::Pool_ Class Reference

This private concrete class implements a Memory Allocator using a pool of fixed size blocks. More...

Detailed Description

This private concrete class implements a Memory Allocator using a pool of fixed size blocks.

The implementation relies on a sub-class to allocate the actual memory for the blocks.

#include <Pool_.h>

Inheritance diagram for Cpl::Memory::Pool_:

Collaboration diagram for Cpl::Memory::Pool_:

Classes
class	BlockInfo_
	Helper class so I can put my blocks into to my standard containers. More...

Public Member Functions
	Pool_ (BlockInfo_ infoBlocks[], size_t blockSize, size_t alignedBlockSize, size_t numBlocks, void *arrayOfBlocks, bool fatalErrors)
	Constructor.
	~Pool_ ()
	Destructor.
void *	allocate (size_t numbytes)
	See Cpl::Memory::Allocator.
void	release (void *ptr)
	See Cpl::Memory::Allocator.
size_t	wordSize () const noexcept
	See Cpl::Memory::Allocator.
Public Member Functions inherited from Cpl::Memory::Allocator
size_t	allocatedSizeForNBytes (size_t nbytes) const noexcept
	Convenience method that determines the actual amount of memory that actually allocated for a successful allocate request of N bytes.
virtual	~Allocator ()
	Provide a virtual destructor.
Public Member Functions inherited from Cpl::Container::Item
bool	insert_ (void *newContainerPtr)
	Helper method to trap when inserting an item in multiple containers.
bool	isInContainer_ (const void *containerPtr) const noexcept
	Returns 'true' if the instance is in the specified container.

Protected Attributes
Cpl::Container::DList< BlockInfo_ >	m_freeList
	My free list of blocks.
Cpl::Container::DList< BlockInfo_ >	m_allocatedList
	My list of allocated blocks.
size_t	m_blockSize
	Block size.
size_t	m_alignedBlockSize
	Block size.
bool	m_fatalErrors
	Flag that controls memory errors behavior.

Additional Inherited Members
Static Public Member Functions inherited from Cpl::Container::Item
static void	remove_ (Item *itemPtr) noexcept
	Helper method to do the proper 'clean-up' for the multiple-containers-error-trap when removing an item from a container.
Public Attributes inherited from Cpl::Container::Item
void *	m_nextPtr_
	The link field.
void *	m_inListPtr_
	Debug field.
Protected Member Functions inherited from Cpl::Container::Item
	Item ()
	Constructor.
	Item (const char *)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Constructor & Destructor Documentation

Pool_()

Cpl::Memory::Pool_::Pool_	(	BlockInfo_	infoBlocks[],
		size_t	blockSize,
		size_t	alignedBlockSize,
		size_t	numBlocks,
		void *	arrayOfBlocks,
		bool	fatalErrors )

Constructor.

~Pool_()

Cpl::Memory::Pool_::~Pool_

(

)

Destructor.

Member Function Documentation

allocate()

void * Cpl::Memory::Pool_::allocate ( size_t numbytes )

virtual

See Cpl::Memory::Allocator.

Implements Cpl::Memory::Allocator.

release()

void Cpl::Memory::Pool_::release ( void * ptr )

virtual

See Cpl::Memory::Allocator.

Implements Cpl::Memory::Allocator.

wordSize()

size_t Cpl::Memory::Pool_::wordSize ( ) const

virtualnoexcept

See Cpl::Memory::Allocator.

Implements Cpl::Memory::Allocator.

Member Data Documentation

m_alignedBlockSize

size_t Cpl::Memory::Pool_::m_alignedBlockSize

protected

Block size.

m_allocatedList

Cpl::Container::DList<BlockInfo_> Cpl::Memory::Pool_::m_allocatedList

protected

My list of allocated blocks.

m_blockSize

size_t Cpl::Memory::Pool_::m_blockSize

protected

Block size.

m_fatalErrors

bool Cpl::Memory::Pool_::m_fatalErrors

protected

Flag that controls memory errors behavior.

m_freeList

Cpl::Container::DList<BlockInfo_> Cpl::Memory::Pool_::m_freeList

protected

My free list of blocks.

---

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

• Cpl/Memory/Pool_.h