TGenericFifo Class Reference

#include <TFifo.h>

Inheritance diagram for TGenericFifo:

Protected Types
enum	Flags_ : Flags { Flags_None = 0 , Flags_PollSemaphore = BITFLAG( 0 ) , Flags_NoSemaphore = BITFLAG( 1 ) }
typedef uint8_t	Flags

Protected Member Functions
	TGenericFifo ()=default
TBOOL	Create (TCHAR *a_pBuffer, TINT a_iMaxItems, TINT a_iItemSize)
TBOOL	Destroy ()
TBOOL	Push (void *a_pItem, Flags a_iFlags)
TBOOL	Pop (void *a_pOut, Flags a_iFlags)

Detailed Description

Definition at line 10 of file TFifo.h.

Member Typedef Documentation

Flags

typedef uint8_t TGenericFifo::Flags

protected

Definition at line 13 of file TFifo.h.

Member Enumeration Documentation

Flags_

enum TGenericFifo::Flags_ : Flags

protected

Enumerator
Flags_None
Flags_PollSemaphore
Flags_NoSemaphore

Definition at line 14 of file TFifo.h.

    {
        Flags_None          = 0,
        Flags_PollSemaphore = BITFLAG( 0 ),
        Flags_NoSemaphore   = BITFLAG( 1 ),
    };

Constructor & Destructor Documentation

TGenericFifo()

TGenericFifo::TGenericFifo ( )

protecteddefault

Member Function Documentation

Create()

TBOOL TGenericFifo::Create ( TCHAR * a_pBuffer, TINT a_iMaxItems, TINT a_iItemSize )

protected

Definition at line 12 of file TFifo.cpp.

{
    TASSERT( a_iMaxItems > 0, "Max items is less than zero" );
    TASSERT( a_iItemSize > 0, "Item size is less than zero" );
 
    m_iItemSize       = a_iItemSize;
    m_iMaxItems       = a_iMaxItems;
    m_pDataPopCursor  = a_pBuffer;
    m_pDataPushCursor = a_pBuffer;
    m_pDataBegin      = a_pBuffer;
    m_pDataEnd        = a_pBuffer + ( a_iMaxItems * a_iItemSize );
 
    TBOOL bResult;
    bResult = m_Semaphore1.Create( m_iMaxItems, m_iMaxItems );
    TASSERT( bResult != TFALSE, "Unable to create semaphore for TGenericFifo" );
    bResult = m_Semaphore2.Create( 0, m_iMaxItems );
    TASSERT( bResult != TFALSE, "Unable to create semaphore for TGenericFifo" );
 
    InitializeCriticalSection( &m_CriticalSection );
    return TTRUE;
}

Destroy()

TBOOL TGenericFifo::Destroy ( )

protected

Definition at line 34 of file TFifo.cpp.

{
    DeleteCriticalSection( &m_CriticalSection );
    m_Semaphore1.Destroy();
    m_Semaphore2.Destroy();
    return TTRUE;
}

Pop()

TBOOL TGenericFifo::Pop ( void * a_pOut, Flags a_iFlags )

protected

Definition at line 67 of file TFifo.cpp.

{
    TBOOL bResult = ( a_iFlags & Flags_PollSemaphore ) ? m_Semaphore2.Poll() : m_Semaphore2.Wait();
    if ( !bResult ) return TFALSE;
 
    EnterCriticalSection( &m_CriticalSection );
 
    // Copy data to the output and move cursor
    TUtil::MemCopy( a_pOut, m_pDataPopCursor, m_iItemSize );
    m_pDataPopCursor += m_iItemSize;
 
    if ( m_pDataPopCursor == m_pDataEnd )
    {
        // Set cursor to the beginning if reached the end
        m_pDataPopCursor = m_pDataBegin;
    }
 
    LeaveCriticalSection( &m_CriticalSection );
 
    bResult = m_Semaphore1.Signal();
    TASSERT( bResult != TFALSE, "TSemaphore::Signal returned TFALSE" );
 
    return TTRUE;
}

Push()

TBOOL TGenericFifo::Push ( void * a_pItem, Flags a_iFlags )

protected

Definition at line 42 of file TFifo.cpp.

{
    TBOOL bResult = ( a_iFlags & Flags_PollSemaphore ) ? m_Semaphore1.Poll() : m_Semaphore1.Wait();
    if ( !bResult ) return TFALSE;
 
    EnterCriticalSection( &m_CriticalSection );
 
    // Copy data to the buffer and move cursor
    Toshi::TUtil::MemCopy( m_pDataPushCursor, a_pItem, m_iItemSize );
    m_pDataPushCursor += m_iItemSize;
 
    if ( m_pDataPushCursor == m_pDataEnd )
    {
        // Set cursor to the beginning if reached the end
        m_pDataPushCursor = m_pDataBegin;
    }
 
    LeaveCriticalSection( &m_CriticalSection );
 
    bResult = m_Semaphore2.Signal();
    TASSERT( bResult != TFALSE, "TSemaphore::Signal returned TFALSE" );
 
    return TTRUE;
}

---

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

• D:/_dev/OpenBarnyard/Source/Toshi/Source/Toshi/TFifo.h
• D:/_dev/OpenBarnyard/Source/Toshi/Source/Toshi/TFifo.cpp