The allocator interface. More...

#include <IAllocator.h>

Inheritance diagram for nctl::IAllocator:

[legend]

Collaboration diagram for nctl::IAllocator:

Public Types
using	AllocateFunction = void ()(IAllocator *allocator, size_t, uint8_t)

using	ReallocateFunction = void ()(IAllocator allocator, void , size_t, uint8_t, size_t &)

using	DeallocateFunction = void()(IAllocator allocator, void *)

Public Member Functions
	IAllocator (const char *name, AllocateFunction allocFunc, ReallocateFunction reallocFunc, DeallocateFunction deallocFunc)

	IAllocator (const char name, AllocateFunction allocFunc, ReallocateFunction reallocFunc, DeallocateFunction deallocFunc, size_t size, void base)

void *	allocate (size_t bytes, uint8_t alignment)
	Tries to allocate the specified amount of memory with the specified alignment requirement.

void *	allocate (size_t bytes)

void *	reallocate (void *ptr, size_t bytes, uint8_t alignment)
	Tries to reallocate the allocation at the specified pointer with a different size.

void *	reallocate (void *ptr, size_t bytes)

void	deallocate (void *ptr)
	Deallocates the allocation at the specified pointer.

const char *	name () const
	Returns the name of the allocator.

size_t	size () const
	Returns the size of the buffer used for allocations.

void *	base () const
	Returns the address of the buffer used for allocations.

size_t	usedMemory () const

size_t	freeMemory () const

size_t	numAllocations () const
	Returns the number of active allocations.

bool	copyOnReallocation () const
	Returns the state of the copy on reallocation flag.

void	setCopyOnReallocation (bool value)
	Sets the state of the copy on reallocation flag.

template<class T , typename... Args>
T *	newObject (Args &&... args)

template<class T >
void	deleteObject (T *ptr)

template<class T >
T *	newArray (size_t numElements)

template<class T >
void	deleteArray (T *ptr)

Static Public Attributes
static const uint8_t	DefaultAlignment = 2 * sizeof(void *)
	16 bytes default alignment on 64bit and 8 bytes on 32bit

static const unsigned int	MaxNameLength = 64
	Maximum length for the allocator name string.

Detailed Description

The allocator interface.

Member Function Documentation

size_t nctl::IAllocator::freeMemory ( ) const

inline

Returns the amount of memory available in the buffer It can be less than the memory availble to allocations due to overhead or fragmentation *‍/

void nctl::IAllocator::setCopyOnReallocation ( bool value )

inline

Sets the state of the copy on reallocation flag.

Note: When the flag is true a growing reallocation might move the data in a new place

size_t nctl::IAllocator::usedMemory ( ) const

inline

Returns the amount of memory in use

Note: It can be more than the memory used by allocations due to overhead *‍/

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