bpf::system::Thread class
#include <Base/include/Framework/System/Thread.hpp>

Contents

Utility class to represent a cross platform thread

Public types

enum EState { PENDING, RUNNING, EXITING, STOPPED, FINISHED }

Public static functions

static void Sleep(uint32 milliseconds)

Constructors, destructors, conversion operators

Thread(const String& name)
~Thread() virtual
Thread(Thread&& other) noexcept

Public functions

auto operator=(Thread&& other) -> Thread& noexcept
void Start()
void Kill(bool force = false)
void Join() noexcept
auto GetState() const -> EState noexcept
auto IsRunning() const -> bool noexcept
auto GetName() const -> const String& noexcept
void Run() pure virtual

Friends

void _bpf_internal_state(Thread& ptr, EState state)
auto _bpf_internal_special(Thread& ptr) -> bool

Enum documentation

enum bpf::system::Thread::EState

Enumeration for thread state

Enumerators
PENDING

The thread is pending start
RUNNING

The thread is running
EXITING

The thread is marked for shut down
STOPPED

The thread has terminated unexpectedly
FINISHED

The thread has finished

Function documentation

static void bpf::system::Thread::Sleep(uint32 milliseconds)

Parameters
milliseconds number of milliseconds to wait

Yields the current thread for a certain amount of time

bpf::system::Thread::Thread(const String& name)

Parameters
name the thread name

Constructs a Thread

bpf::system::Thread::Thread(Thread&& other) noexcept

Move constructor

Thread& bpf::system::Thread::operator=(Thread&& other) noexcept

Move assignment operator

void bpf::system::Thread::Start()

Starts the thread

void bpf::system::Thread::Kill(bool force = false)

Parameters
force if true a hard kill will be performed and memory may leak, otherwise the thread is marked for shut down

Kills the thread

void bpf::system::Thread::Join() noexcept

Joins the thread with the current thread

EState bpf::system::Thread::GetState() const noexcept

Returns copy of the current thread state

Returns the state

bool bpf::system::Thread::IsRunning() const noexcept

Returns true if this thread is running, false otherwise

Checks whether this thread is still running

const String& bpf::system::Thread::GetName() const noexcept

Returns high-level string

Returns the thread name

void bpf::system::Thread::Run() pure virtual

The actual threaded function