Thread.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "HAL/Platform.h"
#include "HAL/PlatformAffinity.h"
#include "Templates/Function.h"
#include "Templates/SharedPointer.h"
 
class FThread final
{
public:
    // indicates if the thread should be forked in case the owning process is forked
    enum EForkable { Forkable, NonForkable };
 
    FThread()
    {}
 
    CORE_API FThread(
        TCHAR const* ThreadName,
        TUniqueFunction<void()>&& ThreadFunction,
        uint32 StackSize = 0,
        EThreadPriority ThreadPriority = TPri_Normal,
        FThreadAffinity ThreadAffinity = FThreadAffinity(),
        EForkable IsForkable = NonForkable
    );
 
    // with SingleThreadTickFunction that will be executed every frame if running with `-nothreading
    // (FPlatformProcess::SupportsMultithreading() == false)
    CORE_API FThread(
        TCHAR const* ThreadName,
        TUniqueFunction<void()>&& ThreadFunction,
        TUniqueFunction<void()>&& SingleThreadTickFunction,
        uint32 StackSize = 0,
        EThreadPriority ThreadPriority = TPri_Normal,
        FThreadAffinity ThreadAffinity = FThreadAffinity(),
        EForkable IsForkable = NonForkable
    );
 
    // non-copyable
    FThread(const FThread&) = delete;
    FThread& operator=(const FThread&) = delete;
 
    FThread(FThread&&) = default;
    CORE_API FThread& operator=(FThread&& Other);
 
    CORE_API ~FThread();
 
    CORE_API bool IsJoinable() const;
 
    CORE_API void Join();
 
    static constexpr uint32 InvalidThreadId = ~uint32(0);
 
    CORE_API uint32 GetThreadId() const;
 
#if 0 // disabled as it doesn't work as intended
 
    CORE_API void Detach();
 
#endif
 
private:
    TSharedPtr<class FThreadImpl, ESPMode::ThreadSafe> Impl; // "shared" with `FThreadImpl::Self`
};