A simple, non-recursive mutex that guarantees order of obtainment using a first-in, first-out (FIFO) scheduling mechanism. Although multiple locks can be acquired by a thread, a single unlock operation completely releases the mutex.

Interface

Constructor

os_simple_fifo_mutex( bool locked )

Constructs a mutex with an initial locked (default false ) state.

Throws: os_thread_toolkit_error

Destructor

~os_simple_fifo_mutex()

Destroys this mutex.

lock

void lock()

Acquires a lock, blocking if necessary. Multiple locks can be obtained by the same thread.

Throws: os_thread_toolkit_error

obtain

void obtain()

Synonym for lock() ; alternative acquisition syntax.

Throws: os_thread_toolkit_error

release

void release()

Synonym for unlock() ; alternative acquisition syntax.

Throws: os_thread_toolkit_error

try_lock

bool try_lock()

Attempts to acquire a lock without blocking. Returns true if successful.

Throws: os_thread_toolkit_error

unlock

void unlock()

Releases all locks. It is invalid for a thread to make subsequent calls to unlock() without first obtaining a new lock on the mutex.

Throws: os_thread_toolkit_error

simple_fifo_mutex

Library

Declaration

Interface