Cpl::Memory::LeanHeap Class Reference

This class manages an allocate-only-heap. More...

Detailed Description

This class manages an allocate-only-heap.

Memory allocated by this class cannot be freed. All of the memory is aligned to size_t boundaries.

Note: The heap has a 'reset' method that can be used to free all of the memory allocated by the instance - HOWEVER it is the responsibility of the Application to ensure the proper behavior when this method is used (i.e. that is okay to 'free everything')

#include <LeanHeap.h>

Inheritance diagram for Cpl::Memory::LeanHeap:

Collaboration diagram for Cpl::Memory::LeanHeap:

Public Member Functions
	LeanHeap (size_t *heapMemory, size_t sizeInBytes)
	Constructor.
void *	allocate (size_t numbytes)
	See Cpl::Memory::ContiguousAllocator.
void	reset () noexcept
	See Cpl::Memory::ContiguousAllocator.
uint8_t *	getMemoryStart (size_t &dstAllocatedLenInBytes) noexcept
	See Cpl::Memory::ContiguousAllocator.
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
size_t *	m_ptrBase
	Pointer to the base of the original heap memory.
size_t	m_staringHeapSize
	Size (in words) of the original heap memory.
size_t *	m_ptr
	Pointer to the next available free byte of memory.
size_t	m_wordsRemaining
	The amount of remaining free memory in size_t words.

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

LeanHeap()

Cpl::Memory::LeanHeap::LeanHeap	(	size_t *	heapMemory,
		size_t	sizeInBytes
	)

Constructor.

The memory size of 'heapMemory' MUST be a multiple of sizeof(size_t).

Member Function Documentation

allocate()

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

virtual

See Cpl::Memory::ContiguousAllocator.

Implements Cpl::Memory::Allocator.

getMemoryStart()

uint8_t * Cpl::Memory::LeanHeap::getMemoryStart ( size_t &  dstAllocatedLenInBytes )

virtualnoexcept

See Cpl::Memory::ContiguousAllocator.

Implements Cpl::Memory::ContiguousAllocator.

reset()

void Cpl::Memory::LeanHeap::reset ( )

virtualnoexcept

See Cpl::Memory::ContiguousAllocator.

Implements Cpl::Memory::ContiguousAllocator.

wordSize()

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

inlinevirtualnoexcept

See Cpl::Memory::Allocator.

Implements Cpl::Memory::Allocator.

Member Data Documentation

m_ptr

size_t* Cpl::Memory::LeanHeap::m_ptr

protected

Pointer to the next available free byte of memory.

m_ptrBase

size_t* Cpl::Memory::LeanHeap::m_ptrBase

protected

Pointer to the base of the original heap memory.

m_staringHeapSize

size_t Cpl::Memory::LeanHeap::m_staringHeapSize

protected

Size (in words) of the original heap memory.

m_wordsRemaining

size_t Cpl::Memory::LeanHeap::m_wordsRemaining

protected

The amount of remaining free memory in size_t words.

---

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

• Cpl/Memory/LeanHeap.h