#include <Mutex.hpp>

Collaboration diagram for Mutex:

Public Member Functions
	Mutex (const char *name=nullptr)

bool	lock ()

bool	tryLock ()

bool	unlock ()

Private Attributes
bool	m_isLocked

struct task_sync	m_taskSync

Detailed Description

Definition at line 16 of file Mutex.hpp.

Constructor & Destructor Documentation

◆ Mutex()

Mutex::Mutex ( const char * name = nullptr )

Construct a new Mutex object.

Parameters

name	Mutex name (for debugging / printing)

Definition at line 13 of file Mutex.cpp.

     : m_isLocked(false)
 {
     m_taskSync.dbg_name = name;
     tasks_sync_init(&m_taskSync);
 };

Member Function Documentation

◆ lock()

bool Mutex::lock ( )

Aquire the mutex.

Returns: int Returns true on success.

Definition at line 20 of file Mutex.cpp.

 {
     while (__atomic_test_and_set(&m_isLocked, __ATOMIC_RELEASE)) {
         TASK_ONLY tasks_sync_block(&m_taskSync);
     }
  
     return true;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ tryLock()

bool Mutex::tryLock ( )

Try to aquire the mutex and return immediately if already locked.

Returns: int Returns true on success.

Definition at line 29 of file Mutex.cpp.

 {
     if (__atomic_test_and_set(&m_isLocked, __ATOMIC_RELEASE)) {
         return false;
     }
  
     return true;
 }

◆ unlock()

bool Mutex::unlock ( )

Release the mutex.

Returns: int Returns true on success.

Definition at line 38 of file Mutex.cpp.

 {
     __atomic_clear(&m_isLocked, __ATOMIC_RELEASE);
     TASK_ONLY tasks_sync_unblock(&m_taskSync);
  
     return true;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ m_isLocked

bool Mutex::m_isLocked

private

Definition at line 48 of file Mutex.hpp.

◆ m_taskSync

struct task_sync Mutex::m_taskSync