ParkingLot.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Misc/MonotonicTime.h"
#include "Templates/FunctionWithContext.h"
 
#include <type_traits>
 
#define UE_API CORE_API
 
namespace UE::ParkingLot
{
 
struct FWaitState final
{
    bool bDidWait = false;
    bool bDidWake = false;
    uint64 WakeToken = 0;
};
 
struct FWakeState final
{
    bool bDidWake = false;
    bool bHasWaitingThreads = false;
};
 
namespace Private
{
UE_API FWaitState Wait(const void* Address, bool (*CanWait)(void*), void* CanWaitContext, void (*BeforeWait)(void*), void* BeforeWaitContext);
UE_API FWaitState WaitFor(const void* Address, bool (*CanWait)(void*), void* CanWaitContext, void (*BeforeWait)(void*), void* BeforeWaitContext, FMonotonicTimeSpan WaitTime);
UE_API FWaitState WaitUntil(const void* Address, bool (*CanWait)(void*), void* CanWaitContext, void (*BeforeWait)(void*), void* BeforeWaitContext, FMonotonicTimePoint WaitTime);
UE_API void WakeOne(const void* Address, uint64 (*OnWakeState)(void*, FWakeState), void* OnWakeStateContext);
} // Private
 
inline FWaitState Wait(const void* Address, TFunctionWithContext<bool()> CanWait, TFunctionWithContext<void()> BeforeWait)
{
    return Private::Wait(Address, CanWait.GetFunction(), CanWait.GetContext(), BeforeWait.GetFunction(), BeforeWait.GetContext());
}
 
inline FWaitState WaitFor(const void* Address, TFunctionWithContext<bool()> CanWait, TFunctionWithContext<void()> BeforeWait, FMonotonicTimeSpan WaitTime)
{
    return Private::WaitFor(Address, CanWait.GetFunction(), CanWait.GetContext(), BeforeWait.GetFunction(), BeforeWait.GetContext(), WaitTime);
}
 
inline FWaitState WaitUntil(const void* Address, TFunctionWithContext<bool()> CanWait, TFunctionWithContext<void()> BeforeWait, FMonotonicTimePoint WaitTime)
{
    return Private::WaitUntil(Address, CanWait.GetFunction(), CanWait.GetContext(), BeforeWait.GetFunction(), BeforeWait.GetContext(), WaitTime);
}
 
inline void WakeOne(const void* Address, TFunctionWithContext<uint64(FWakeState)> OnWakeState)
{
    return Private::WakeOne(Address, OnWakeState.GetFunction(), OnWakeState.GetContext());
}
 
UE_API FWakeState WakeOne(const void* Address);
 
UE_API uint32 WakeMultiple(const void* Address, uint32 WakeCount);
 
UE_API uint32 WakeAll(const void* Address);
 
} // UE::ParkingLot
 
#undef UE_API
 
#if UE_ENABLE_INCLUDE_ORDER_DEPRECATED_IN_5_7
#include "Templates/Function.h"
#endif