#include <T2Mutex_Win.h>

Public Types
enum	Flags_ : Flags { Flags_Standard = 0 , Flags_DoNotWait = 1 }

typedef TUINT32	Flags

Public Member Functions
constexpr	T2Mutex ()

	~T2Mutex ()

TBOOL	Create ()

TBOOL	Lock (Flags flags=Flags_Standard)

TBOOL	Unlock ()

void	Destroy ()

	operator TBOOL () const

Detailed Description

Definition at line 5 of file T2Mutex_Win.h.

Member Typedef Documentation

◆ Flags

typedef TUINT32 T2Mutex::Flags

Definition at line 8 of file T2Mutex_Win.h.

Member Enumeration Documentation

◆ Flags_

enum T2Mutex::Flags_ : Flags

Enumerator
Flags_Standard
Flags_DoNotWait

Definition at line 9 of file T2Mutex_Win.h.

    {
        Flags_Standard  = 0,
        Flags_DoNotWait = 1
    };

Constructor & Destructor Documentation

◆ T2Mutex()

T2Mutex::T2Mutex ( )

inlineconstexpr

Definition at line 16 of file T2Mutex_Win.h.

17 : m_Mutex( TNULL ) {}

TNULL

#define TNULL

Definition Typedefs.h:23

◆ ~T2Mutex()

T2Mutex::~T2Mutex ( )

inline

Definition at line 18 of file T2Mutex_Win.h.

18{ Destroy(); }

T2Mutex::Destroy

void Destroy()

Definition T2Mutex_Win.cpp:38

Member Function Documentation

◆ Create()

TBOOL T2Mutex::Create ( )

Definition at line 14 of file T2Mutex_Win.cpp.

{
    Destroy();
    m_Mutex = CreateMutexA( NULL, FALSE, NULL );
    TASSERT( m_Mutex != NULL, "Failed to create mutex" );
    return TTRUE;
}

◆ Destroy()

void T2Mutex::Destroy ( )

Definition at line 38 of file T2Mutex_Win.cpp.

{
    CloseHandle( m_Mutex );
    m_Mutex = NULL;
}

◆ Lock()

TBOOL T2Mutex::Lock ( Flags flags = Flags_Standard )

Definition at line 22 of file T2Mutex_Win.cpp.

{
    TASSERT( m_Mutex != NULL, "Mutex is NULL" );
 
    DWORD waitForMs = ( flags & Flags_DoNotWait ) ? 0 : INFINITE;
    DWORD result    = WaitForSingleObject( m_Mutex, waitForMs );
 
    return result == WAIT_OBJECT_0;
}

◆ operator TBOOL()

T2Mutex::operator TBOOL ( ) const

inline

Definition at line 32 of file T2Mutex_Win.h.

32{ return m_Mutex; }

◆ Unlock()

TBOOL T2Mutex::Unlock ( )

Definition at line 32 of file T2Mutex_Win.cpp.

{
    TASSERT( m_Mutex != NULL, "Mutex is NULL" );
    return ReleaseMutex( m_Mutex );
}

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

D:/_dev/OpenBarnyard/Source/Toshi/Source/Platform/Windows/T2Mutex_Win.h
D:/_dev/OpenBarnyard/Source/Toshi/Source/Platform/Windows/T2Mutex_Win.cpp

Public Types

Public Member Functions