CyberEngineMkIII/_mutex_8hpp_source.html

 #pragma once

 namespace CYB {

     namespace API {

         class Mutex : public Interop::Allocatable {

         public:

             using Constructor = Interop::EmptyConstructor;

         public:

             virtual ~Mutex() = default;

             virtual void Lock(void) noexcept = 0;

             virtual bool TryLock(void) noexcept = 0;

             virtual void Unlock(void) noexcept = 0;

         };

     };

 };

 CYB_SET_ALLOCATABLE_ID(Mutex);

 //! @endcond

CYB::API::Mutex::TryLock
virtual bool TryLock(void) noexcept=0
Attempt to acquire a lock on a Mutex. This will not block the current thread. The Mutex must not be o...

CYB::API::Mutex::Unlock
virtual void Unlock(void) noexcept=0
Release a lock on a Mutex. Should only be called after a Lock or TryLock on the same Mutex was aquire...

CYB::API::Interop::Constructor< void >
Used as a base class by all constructors.
Definition: Constructor.hpp:56

CYB::API::Mutex::Lock
virtual void Lock(void) noexcept=0
Acquire a lock on a Mutex. This will block the current thread until the lock is aquired. The Mutex must not be owned by the current thread.

CYB::API::Interop::EmptyConstructor
Constructor< void > EmptyConstructor
Constructor<void> alias.
Definition: Constructor.hpp:106

CYB::API::Mutex::~Mutex
virtual ~Mutex()=default
Destroy a Mutex. Mutex must be unlocked.

CYB::API::Mutex
A fast locking, no order guaranteed, mutex.
Definition: Mutex.hpp:10

CYB::API::Interop::Allocatable
Defines the base class for allocatable engine objects.
Definition: Allocatable.hpp:7