CyberEngineMkIII/_lock_guard_8hpp_source.html

 #pragma once


 namespace CYB {

     namespace API {

         class LockGuard {

         private:

             Mutex* FMutex;

         public:

             LockGuard(Mutex& AMutex, const bool APreLocked = false) noexcept;

             LockGuard(const LockGuard&) = delete;

             LockGuard(LockGuard&& AMove) noexcept;

             LockGuard& operator=(LockGuard&& AMove) noexcept;

             ~LockGuard();


             void Release(void) noexcept;

         };

     }

 }


 #include "LockGuard.inl"

CYB::API::LockGuard
A RAII locking mechanism.
Definition: LockGuard.hpp:7

CYB::API::LockGuard::FMutex
Mutex * FMutex
A reference to the owned Mutex.
Definition: LockGuard.hpp:9

CYB::API::LockGuard::Release
void Release(void) noexcept
Releases the lock on Mutex, this same LockGuard can never reaquire it.

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

CYB::API::LockGuard::LockGuard
LockGuard(Mutex &AMutex, const bool APreLocked=false) noexcept
Construct a LockGuard that will hold a lock on AMutex.