Cpl::Memory::ContiguousAllocator Class Reference

This abstract class is used 'extend' the Memory Allocator to have contiguous semantics. More...

Detailed Description

This abstract class is used 'extend' the Memory Allocator to have contiguous semantics.

This means all memory that is allocated can be viewed as single contiguous block of memory. In addition, the 'release' be is hidden and replaced with a reset() method that releases/frees ALL memory allocated.

#include <ContiguousAllocator.h>

Inheritance diagram for Cpl::Memory::ContiguousAllocator:

Collaboration diagram for Cpl::Memory::ContiguousAllocator:

Public Member Functions
virtual void	reset () noexcept=0
	Resets the allocator, i.e.
virtual uint8_t *	getMemoryStart (size_t &dstAllocatedLenInBytes) noexcept=0
	This method returns a pointer to the start of Allocator's contiguous memory AND the total number of bytes allocated so far.
Public Member Functions inherited from Cpl::Memory::Allocator
virtual void *	allocate (size_t numbytes)=0
	Allocate and returns a pointer to at least numBytes of storage.
virtual size_t	wordSize () const noexcept=0
	Returns the 'word' size of the allocator, i.e.
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.

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.

Member Function Documentation

getMemoryStart()

virtual uint8_t * Cpl::Memory::ContiguousAllocator::getMemoryStart ( size_t &  dstAllocatedLenInBytes )

pure virtualnoexcept

This method returns a pointer to the start of Allocator's contiguous memory AND the total number of bytes allocated so far.

NOTE: This method has GREAT POWER and it is the responsibility of the Application to use it correctly (Uncle Ben 2002).

Implemented in Cpl::Memory::LeanHeap.

reset()

virtual void Cpl::Memory::ContiguousAllocator::reset ( )

pure virtualnoexcept

Resets the allocator, i.e.

effectively frees all allocated memory. It is the caller's RESPONSIBILTY to ensure that it is kosher to free all of the memory.

Implemented in Cpl::Memory::LeanHeap.

---

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

• Cpl/Memory/ContiguousAllocator.h