ExternalMutex.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Async/IntrusiveMutex.h"
#include "CoreTypes.h"
 
#include <atomic>
 
namespace UE
{
 
template <CIntrusiveMutexParams ParamsType>
class TExternalMutex final
{
    using StateType = TIntrusiveMutexStateType_T<ParamsType>;
 
public:
    TExternalMutex(const TExternalMutex&) = delete;
    TExternalMutex& operator=(const TExternalMutex&) = delete;
 
    inline constexpr explicit TExternalMutex(std::atomic<StateType>& InState)
        : State(InState)
    {
    }
 
    [[nodiscard]] inline bool IsLocked() const
    {
        return TIntrusiveMutex<ParamsType>::IsLocked(State);
    }
 
    [[nodiscard]] inline bool TryLock()
    {
        return TIntrusiveMutex<ParamsType>::TryLock(State);
    }
 
    inline void Lock()
    {
        TIntrusiveMutex<ParamsType>::Lock(State);
    }
 
    inline void Unlock()
    {
        TIntrusiveMutex<ParamsType>::Unlock(State);
    }
 
private:
    std::atomic<StateType>& State;
};
 
namespace Core::Private
{
 
struct FExternalMutexParams
{
    inline constexpr static uint8 IsLockedFlag = 1 << 0;
    inline constexpr static uint8 MayHaveWaitingLockFlag = 1 << 1;
};
 
} // Core::Private
 
using FExternalMutex UE_DEPRECATED(5.7, "Use TExternalMutex or TIntrusiveMutex.") = TExternalMutex<Core::Private::FExternalMutexParams>;
 
} // UE