Timeout.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Misc/Timespan.h"
#include "HAL/PlatformTime.h"
#include "CoreTypes.h"
 
namespace UE
{
    // utility class to handle timeouts
    // usage:
    // ------------------------------------
    // FTimeout Timeout(FTimespan::FromMilliseconds(2));
    // while (!Timeout) { ... }
    // ------------------------------------
    class FTimeout
    {
    public:
        explicit FTimeout(FTimespan Value)
            : Timeout(Value)
        {
        }
 
        explicit operator bool() const
        {
            return GetElapsedTime() >= Timeout;
        }
 
        FTimespan GetElapsedTime() const
        {
            return FTimespan::FromSeconds(FPlatformTime::Seconds()) - Start;
        }
 
        FTimespan GetRemainingTime() const
        {
            return Timeout - GetElapsedTime();
        }
 
    private:
        FTimespan Start{ FTimespan::FromSeconds(FPlatformTime::Seconds()) };
        FTimespan Timeout;
    };
}