Event.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Math/NumericLimits.h"
#include "Misc/Timespan.h"
#include "Templates/Atomic.h"
#include "Templates/SharedPointer.h"
 
class FEvent
{
public:
 
    UE_DEPRECATED(5.0, "Direct creation of FEvent is discouraged for performance reasons. Please use FPlatformProcess::GetSynchEventFromPool/ReturnSynchEventToPool.")
    virtual bool Create( bool bIsManualReset = false ) = 0;
 
    virtual bool IsManualReset() = 0;
 
    virtual void Trigger() = 0;
 
    virtual void Reset() = 0;
 
    virtual bool Wait( uint32 WaitTime, const bool bIgnoreThreadIdleStats = false ) = 0;
 
    bool Wait()
    {
        return Wait(MAX_uint32);
    }
 
    bool Wait( const FTimespan& WaitTime, const bool bIgnoreThreadIdleStats = false )
    {
        check(WaitTime.GetTicks() >= 0);
        return Wait((uint32)FMath::Clamp<int64>(WaitTime.GetTicks() / ETimespan::TicksPerMillisecond, 0, MAX_uint32), bIgnoreThreadIdleStats);
    }
 
    FEvent()
        : EventId( 0 )
        , EventStartCycles( 0 )
    {}
 
    virtual ~FEvent() 
    {}
 
    // DO NOT MODIFY THESE
 
    CORE_API void AdvanceStats();
 
protected:
    CORE_API void WaitForStats();
 
    CORE_API void TriggerForStats();
 
    CORE_API void ResetForStats();
 
    static CORE_API TAtomic<uint32> EventUniqueId;
 
    uint32 EventId;
 
    TAtomic<uint32> EventStartCycles;
};
 
enum class EEventMode { AutoReset, ManualReset };
 
class FEventRef final
{
public:
    CORE_API explicit FEventRef(EEventMode Mode = EEventMode::AutoReset);
 
    CORE_API ~FEventRef();
 
    FEventRef(const FEventRef&) = delete;
    FEventRef& operator=(const FEventRef&) = delete;
    FEventRef(FEventRef&& Other) = delete;
    FEventRef& operator=(FEventRef&& Other) = delete;
 
    FEvent* operator->() const
    {
        return Event;
    }
 
    FEvent* Get()
    {
        return Event;
    }
 
private:
    FEvent* Event;
};
 
class FSharedEventRef final
{
public:
    CORE_API explicit FSharedEventRef(EEventMode Mode = EEventMode::AutoReset);
 
    FEvent* operator->() const
    {
        return Ptr.Get();
    }
 
private:
    TSharedPtr<FEvent> Ptr;
};