TimedLockGuard.h

/*
 * Copyright(c) Sophist Solutions, Inc. 1990-2025.  All rights reserved
 */
#ifndef _Stroika_Foundation_Execution_TimedLockGuard_h_
#define _Stroika_Foundation_Execution_TimedLockGuard_h_ 1
 
#include "Stroika/Foundation/StroikaPreComp.h"
 
#include <mutex>
 
#include "Stroika/Foundation/Execution/TimeOutException.h"
#include "Stroika/Foundation/Time/Duration.h"
 
namespace Stroika::Foundation::Execution {
 
    /**
     *  Like lock_guard, but only used on TIMED mutexes, and instead of unique_lock::try_lock() returning false
     *  or the CTOR just silently failing to lock, this throws a lock failure.
     * 
     *  \see also UniqueLock
     */
    template <typename MUTEX = timed_mutex>
    class TimedLockGuard {
    public:
        /**
         *  \note   if argument duration is <= 0, this always throws regardless if whether or not the mutex could be acquired.
         */
        template <typename FAILURE_EXCEPTION = TimeOutException>
        TimedLockGuard (MUTEX& m, const Time::Duration& waitUpTo, const FAILURE_EXCEPTION& timeoutException = FAILURE_EXCEPTION{});
        TimedLockGuard (const TimedLockGuard&)            = delete;
        TimedLockGuard& operator= (const TimedLockGuard&) = delete;
        ~TimedLockGuard ();
 
    private:
        MUTEX& fMutex_;
    };
 
}
 
/*
 ********************************************************************************
 ***************************** Implementation Details ***************************
 ********************************************************************************
 */
#include "TimedLockGuard.inl"
 
#endif /*_Stroika_Foundation_Execution_TimedLockGuard_h_*/