Zth (libzth)
zth::Mutex Class Reference

Fiber-aware mutex. More...

#include <sync.h>

Inheritance diagram for zth::Mutex:
zth::Synchronizer zth::RefCounted zth::UniqueID< Synchronizer > zth::UniqueIDBase

Public Member Functions

 Mutex (cow_string const &name="Mutex")
 
 Mutex (cow_string &&name)
 
virtual ~Mutex () override=default
 
void lock ()
 
bool trylock () noexcept
 
void unlock () noexcept
 
- Public Member Functions inherited from zth::Synchronizer
 Synchronizer (cow_string const &name="Synchronizer")
 
 Synchronizer (cow_string &&name)
 
virtual ~Synchronizer () override
 
- Public Member Functions inherited from zth::RefCounted
 RefCounted () noexcept
 
virtual ~RefCounted ()=default
 
void used () noexcept
 
void unused ()
 
- Public Member Functions inherited from zth::UniqueID< Synchronizer >
 UniqueID (UniqueID const &)=delete
 
 UniqueID (UniqueID &&u) noexcept
 
 UniqueID (string const &name)
 
 UniqueID (string &&name)
 
 UniqueID (char const *name=nullptr)
 
UniqueIDoperator= (UniqueID const &)=delete
 
UniqueIDoperator= (UniqueID &&u) noexcept
 
virtual ~UniqueID ()=default
 
void const * normptr () const noexcept
 
uint64_t id () const noexcept
 
string const & name () const noexcept
 
void setName (string const &name)
 
void setName (char const *name)
 
void setName (string &&name)
 
virtual char const * id_str () const override
 

Additional Inherited Members

- Static Public Member Functions inherited from zth::UniqueID< Synchronizer >
static uint64_t getID () noexcept
 
- Protected Member Functions inherited from zth::Synchronizer
void block ()
 
bool unblock (Fiber &f) noexcept
 Unblock the specific fiber. More...
 
bool unblockFirst () noexcept
 
bool unblockAll () noexcept
 
bool block (Timestamp const &timeout, Timestamp const &now=Timestamp::now())
 Block, with timeout. More...
 
bool block (TimeInterval const &timeout, Timestamp const &now=Timestamp::now())
 Block, with timeout. More...
 
- Protected Member Functions inherited from zth::UniqueIDBase
virtual ~UniqueIDBase ()=default
 

Detailed Description

Fiber-aware mutex.

Examples
4_sync.cpp.

Definition at line 340 of file sync.h.

Constructor & Destructor Documentation

◆ Mutex() [1/2]

zth::Mutex::Mutex ( cow_string const &  name = "Mutex")
inlineexplicit

Definition at line 343 of file sync.h.

◆ Mutex() [2/2]

zth::Mutex::Mutex ( cow_string &&  name)
inlineexplicit

Definition at line 349 of file sync.h.

◆ ~Mutex()

virtual zth::Mutex::~Mutex ( )
overridevirtualdefault

Member Function Documentation

◆ lock()

void zth::Mutex::lock ( )
inline
Examples
4_sync.cpp.

Definition at line 357 of file sync.h.

◆ trylock()

bool zth::Mutex::trylock ( )
inlinenoexcept

Definition at line 365 of file sync.h.

◆ unlock()

void zth::Mutex::unlock ( )
inlinenoexcept
Examples
4_sync.cpp.

Definition at line 374 of file sync.h.


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