RWLock.h

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Base
File: RWLock
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/BaseValues.h>
#include <NDEVR/Dictionary.h>
#include <NDEVR/Buffer.h>
#include <mutex>
namespace NDEVR
{
    class UUID;
    class TimeSpan;

    class NDEVR_BASE_API RWLock
    {
    public:
        RWLock();
        RWLock(const RWLock& lock) = delete;
        ~RWLock();

        void readLock();
        void writeLock();

        bool tryReadLock();
        bool tryWriteLock();

        bool tryReadLock(uint08 time);
        bool tryWriteLock(uint08 time);

        void readUnlock();
        void writeUnlock();
        [[nodiscard]] uint04 numOfWriteLocksHeld() const;
        [[nodiscard]] uint04 numOfWriteLocks() const;
        [[nodiscard]] uint04 numOfReadLocksHeld() const;
        [[nodiscard]] uint04 numOfReadLocks() const;
    private:
        bool _TryReadLock();
        bool _TryWriteLock();
 
    private:
        std::mutex m_critical_section; 
        volatile uint04 m_write_owner; 
        volatile uint04 m_readers; 
        volatile uint04 m_writers; 
        volatile uint04 m_write_waiters; 
    public:
        static RWLock* getEntry(const void* entry);
    };

    class NDEVR_BASE_API RLock
    {
    public:
        explicit RLock(const void* lock);
        explicit RLock(const UUID& lock);
        explicit RLock(RWLock& lock);
        RLock(const void* lock, uint08 timeout);
        RLock(const void* lock, bool& didAquire);
        RLock(RLock&& lock) noexcept;
        RLock(const RLock&) = delete;
        ~RLock();
        static bool HasLock(const void* lock);
        static bool HasLock(const RWLock& lock);
        bool isLocked() const;
        void operator=(const RLock&) = delete;
    private:
        RWLock* m_lock; 
    };

    class NDEVR_BASE_API MultiRLock
    {
    public:
        MultiRLock(std::initializer_list<const void*> l);
        MultiRLock(std::initializer_list<RWLock*> l);
        MultiRLock(std::initializer_list<const void*> l, uint08 timeout);
        MultiRLock(MultiRLock&& lock) noexcept;
        MultiRLock(const MultiRLock&) = delete;
        void operator=(const MultiRLock&) = delete;
        bool isLocked() const;
        ~MultiRLock();
    private:
        void sortAndAcquire();
        Buffer<RWLock*> m_lock; 
    };

    class NDEVR_BASE_API WLock
    {
    public:
        explicit WLock(const void* lock);
        explicit WLock(const UUID& lock);
        explicit WLock(RWLock& lock);
        WLock(WLock&& lock) noexcept;
        WLock(const WLock&) = delete;
        void operator=(const WLock&) = delete;
        WLock(const void* lock, uint08 timeout);
        WLock(const void* lock, const TimeSpan& timeout);
        bool isLocked() const;
        static bool HasLock(const void* lock);
        static bool HasLock(const RWLock& lock);
        ~WLock();
    private:
        RWLock* m_lock; 
    };

    class NDEVR_BASE_API MultiWLock
    {
    public:
        MultiWLock(std::initializer_list<const void*> l);
        MultiWLock(std::initializer_list<const void*> l, uint08 timeout);
        MultiWLock(std::initializer_list<RWLock*> l);
        MultiWLock(MultiWLock&& lock) noexcept;
        MultiWLock(const MultiWLock&) = delete;
        void operator=(const MultiWLock&) = delete;
        bool isLocked() const;
        ~MultiWLock();
    private:
        void sortAndAcquire();
        Buffer<RWLock*> m_lock; 
    };
}