Doxygen/html/common_2_honey_2_thread_2_lock_2_mutex_8h_source.html

 // Honeycomb, Copyright (C) 2015 NewGamePlus Inc.  Distributed under the Boost Software License v1.0.

 #pragma once


 #include "Honey/Core/Core.h"

 #include "Honey/Thread/Lock/platform/Mutex.h"


 namespace honey

 {


 template<class Lockable> class UniqueLock;


 class Mutex : platform::Mutex

 {

     typedef platform::Mutex Super;

 public:

     typedef Super::Handle Handle;

     typedef UniqueLock<Mutex> Scoped;


     Mutex() = default;

     Mutex(const Mutex&) {}


     Mutex& operator=(const Mutex&)                  { return *this; }


     void lock()                                     { Super::lock(); }

     void unlock()                                   { Super::unlock(); }

     bool tryLock()                                  { return Super::tryLock(); }


     Handle& handle()                                { return Super::handle(); }

 };


 }

honey::UniqueLock
A scoped lock that references any lockable. Locks on construction and unlocks on destruction.
Definition: Mutex.h:10

honey::Mutex::Handle
Super::Handle Handle
Definition: Mutex.h:21

honey::lock::lock
void lock(Locks &&...locks)
Lock all lockables safely without deadlocking.
Definition: Util.h:110

honey::Mutex::operator=
Mutex & operator=(const Mutex &)
Can't copy, silently does nothing.
Definition: Mutex.h:29

honey::Mutex::lock
void lock()
Acquire the lock. Thread suspends until lock becomes available.
Definition: Mutex.h:32

honey::Mutex::Scoped
UniqueLock< Mutex > Scoped
Definition: Mutex.h:22

Core.h

honey::Mutex::Mutex
Mutex()=default

honey::Mutex::tryLock
bool tryLock()
Attempt to acquire the lock, returns immediately. Returns true if the lock was acquired, false otherwise.
Definition: Mutex.h:36

honey::Mutex::Mutex
Mutex(const Mutex &)
Can't copy, silently inits to default.
Definition: Mutex.h:26

honey::Mutex::unlock
void unlock()
Release the lock.
Definition: Mutex.h:34

honey::Mutex::handle
Handle & handle()
Get platform handle.
Definition: Mutex.h:39

honey::Mutex
A thread lock where the lock is acquired by suspending thread execution until it becomes available...
Definition: Mutex.h:17

honey
Global Honeycomb namespace.

honey::lock::tryLock
int tryLock(Lock &l, Locks &...ls)
Try to lock all lockables. Locks either all or none.
Definition: Util.h:26