T2GenericObjectPool Class Reference

#include <T2ObjectPool.h>

Inheritance diagram for T2GenericObjectPool:

Classes
struct	UnusedObject

Public Member Functions
virtual	~T2GenericObjectPool ()=default

Protected Member Functions
virtual void *	Malloc (TSIZE a_uiSize, TSIZE a_uiAlignment) OVERRIDE
virtual void *	Malloc (TSIZE a_uiSize) OVERRIDE
virtual void	Free (void *a_pPtr) OVERRIDE
virtual TBOOL	CanAllocate (TSIZE size) const OVERRIDE
virtual void *	TryMalloc (TSIZE size, TSIZE alignment) OVERRIDE
virtual void *	TryMalloc (TSIZE size) OVERRIDE
void	Initialise (UnusedObject *a_pObjects, TUINT a_uiMaxNumber, TUINT a_uiObjectSize)
UnusedObject *	GetObject ()
void	ReturnObject (UnusedObject *a_pObject)
TUINT	GetNumFreeObjects () const
Protected Member Functions inherited from T2Allocator
virtual size_t	GetUsedSize () const =0
virtual size_t	GetCapacity () const =0
template<class T, class... Args>
T *	New (Args &&... args)
template<class T>
void	Delete (T *ptr)

Protected Attributes
UnusedObject *	m_pHead

Detailed Description

Definition at line 8 of file T2ObjectPool.h.

Constructor & Destructor Documentation

~T2GenericObjectPool()

virtual T2GenericObjectPool::~T2GenericObjectPool ( )

virtualdefault

Member Function Documentation

CanAllocate()

virtual TBOOL T2GenericObjectPool::CanAllocate ( TSIZE size ) const

inlineprotectedvirtual

Implements T2Allocator.

Definition at line 35 of file T2ObjectPool.h.

    {
        return m_pHead != TNULL;
    }

Free()

virtual void T2GenericObjectPool::Free ( void * a_pPtr )

inlineprotectedvirtual

Implements T2Allocator.

Definition at line 30 of file T2ObjectPool.h.

    {
        ReturnObject( TSTATICCAST( UnusedObject, a_pPtr ) );
    }

GetNumFreeObjects()

TUINT T2GenericObjectPool::GetNumFreeObjects ( ) const

inlineprotected

Definition at line 85 of file T2ObjectPool.h.

    {
        TUINT uiNumber = 0;
        for ( auto it = m_pHead; it != TNULL; it = it->pNextObject, uiNumber++ )
            ;
 
        return uiNumber;
    }

GetObject()

UnusedObject * T2GenericObjectPool::GetObject ( )

inlineprotected

Definition at line 72 of file T2ObjectPool.h.

    {
        UnusedObject* pNode = m_pHead;
        m_pHead             = m_pHead->pNextObject;
        return pNode;
    }

Initialise()

void T2GenericObjectPool::Initialise ( UnusedObject * a_pObjects, TUINT a_uiMaxNumber, TUINT a_uiObjectSize )

inlineprotected

Definition at line 56 of file T2ObjectPool.h.

    {
        TASSERT( a_uiMaxNumber > 1 );
        m_pHead               = a_pObjects;
        UnusedObject* pObject = a_pObjects;
 
        for ( TUINT i = a_uiMaxNumber - 1; i != 0; i-- )
        {
            UnusedObject* pNext  = TREINTERPRETCAST( UnusedObject*, TREINTERPRETCAST( TUINTPTR, pObject ) + a_uiObjectSize );
            pObject->pNextObject = pNext;
            pObject              = pNext;
        }
 
        pObject->pNextObject = TNULL;
    }

Malloc() [1/2]

virtual void * T2GenericObjectPool::Malloc ( TSIZE a_uiSize )

inlineprotectedvirtual

Implements T2Allocator.

Definition at line 25 of file T2ObjectPool.h.

    {
        return GetObject();
    }

Malloc() [2/2]

virtual void * T2GenericObjectPool::Malloc ( TSIZE a_uiSize, TSIZE a_uiAlignment )

inlineprotectedvirtual

Implements T2Allocator.

Definition at line 20 of file T2ObjectPool.h.

    {
        return TNULL;
    }

ReturnObject()

void T2GenericObjectPool::ReturnObject ( UnusedObject * a_pObject )

inlineprotected

Definition at line 79 of file T2ObjectPool.h.

    {
        a_pObject->pNextObject = m_pHead;
        m_pHead                = a_pObject;
    }

TryMalloc() [1/2]

virtual void * T2GenericObjectPool::TryMalloc ( TSIZE size )

inlineprotectedvirtual

Implements T2Allocator.

Definition at line 45 of file T2ObjectPool.h.

    {
        if ( m_pHead != TNULL )
        {
            return GetObject();
        }
 
        return TNULL;
    }

TryMalloc() [2/2]

virtual void * T2GenericObjectPool::TryMalloc ( TSIZE size, TSIZE alignment )

inlineprotectedvirtual

Implements T2Allocator.

Definition at line 40 of file T2ObjectPool.h.

    {
        return TNULL;
    }

Member Data Documentation

m_pHead

UnusedObject* T2GenericObjectPool::m_pHead

protected

Definition at line 95 of file T2ObjectPool.h.

---

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

• D:/_dev/OpenBarnyard/Source/Toshi/Source/Toshi/T2ObjectPool.h