OSX::OSXMemoryPool Class Reference

#include <osxmemorypool.h>

Detailed Description

FIXME: IMPLEMENT ME!

(C) 2010 Radon Labs GmbH (C) 2013-2018 Individual contributors, see AUTHORS file

Public Member Functions
	OSXMemoryPool ()
	constructor
	~OSXMemoryPool ()
	destructor
void	Setup (Memory::HeapType heapType, uint blockSize, uint numBlocks)
	setup the memory pool
void *	Alloc ()
	allocate a block from the pool (NOTE: returns 0 if pool exhausted!)
void	Free (void *ptr)
	deallocate a block from the pool
bool	IsPoolBlock (void *ptr) const
	return true if block is owned by this pool
uint	GetNumBlocks () const
	get number of allocated blocks in pool
uint	GetBlockSize () const
	get block size
uint	GetAlignedBlockSize () const
	get aligned block size
uint	GetPoolSize () const
	get pool size

Static Public Member Functions
static uint	ComputeAlignedBlockSize (uint blockSize)
	compute the actual block size including alignment and management data

Constructor & Destructor Documentation

OSXMemoryPool()

OSX::OSXMemoryPool::OSXMemoryPool

(

)

constructor

~OSXMemoryPool()

OSX::OSXMemoryPool::~OSXMemoryPool

(

)

destructor

Member Function Documentation

Alloc()

void * OSX::OSXMemoryPool::Alloc

(

)

allocate a block from the pool (NOTE: returns 0 if pool exhausted!)

ComputeAlignedBlockSize()

uint OSX::OSXMemoryPool::ComputeAlignedBlockSize ( uint blockSize )

inlinestatic

compute the actual block size including alignment and management data

Free()

void OSX::OSXMemoryPool::Free

(

void *

ptr

)

deallocate a block from the pool

GetAlignedBlockSize()

uint OSX::OSXMemoryPool::GetAlignedBlockSize ( ) const

inline

get aligned block size

GetBlockSize()

uint OSX::OSXMemoryPool::GetBlockSize ( ) const

inline

get block size

GetNumBlocks()

uint OSX::OSXMemoryPool::GetNumBlocks ( ) const

inline

get number of allocated blocks in pool

GetPoolSize()

uint OSX::OSXMemoryPool::GetPoolSize ( ) const

inline

get pool size

IsPoolBlock()

bool OSX::OSXMemoryPool::IsPoolBlock ( void * ptr ) const

inline

return true if block is owned by this pool

Setup()

void OSX::OSXMemoryPool::Setup	(	Memory::HeapType	heapType,
		uint	blockSize,
		uint	numBlocks )

setup the memory pool

NOTE: name must be a static string!

---

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

• /github/workspace/code/foundation/memory/osx/osxmemorypool.h
• /github/workspace/code/foundation/memory/osx/osxmemorypool.cc