FCommonChain::FCommonRunnableMechanic Struct Reference

The common runnable mechanic base. More...

#include <CommonChain.h>

Inheritance diagram for FCommonChain::FCommonRunnableMechanic:

Collaboration diagram for FCommonChain::FCommonRunnableMechanic:

Public Member Functions
bool	ShouldStop () const
void	Stop () override
auto	HasFinished () const
	Check if the runnable has finished its execution.
EApparatusStatus	Halt (bool bShouldWait=true)
	Halt the execution of the runnable on its thread.
EApparatusStatus	WaitForCompletion ()
	Wait for the mechanic to complete.
	FCommonRunnableMechanic (const bool bInConcurrent)
	Initialize the base mechanic.
	~FCommonRunnableMechanic () override

Protected Attributes
bool	bConcurrent = false
	Is the runnable asynchronous (concurrent).
FRunnableThread *	Thread = nullptr
	The executing thread.
std::atomic< bool >	bStop {false}
	Manual stop signal.
std::atomic< bool >	bFinished {false}
	Has the runnable finished executing.

Detailed Description

The common runnable mechanic base.

Constructor & Destructor Documentation

FCommonRunnableMechanic()

FCommonChain::FCommonRunnableMechanic::FCommonRunnableMechanic ( const bool  bInConcurrent )

inline

Initialize the base mechanic.

Parameters

bInConcurrent

Should the mechanic be executed in a concurrent environment.

~FCommonRunnableMechanic()

FCommonChain::FCommonRunnableMechanic::~FCommonRunnableMechanic ( )

inlineoverride

Member Function Documentation

Halt()

EApparatusStatus FCommonChain::FCommonRunnableMechanic::Halt ( bool  bShouldWait = true )

inline

Halt the execution of the runnable on its thread.

Returns

The status of the operation.

HasFinished()

auto FCommonChain::FCommonRunnableMechanic::HasFinished ( ) const

inline

Check if the runnable has finished its execution.

ShouldStop()

bool FCommonChain::FCommonRunnableMechanic::ShouldStop ( ) const

inline

Stop()

void FCommonChain::FCommonRunnableMechanic::Stop ( )

inlineoverride

WaitForCompletion()

EApparatusStatus FCommonChain::FCommonRunnableMechanic::WaitForCompletion ( )

inline

Wait for the mechanic to complete.

Member Data Documentation

bConcurrent

bool FCommonChain::FCommonRunnableMechanic::bConcurrent = false

protected

Is the runnable asynchronous (concurrent).

bFinished

std::atomic<bool> FCommonChain::FCommonRunnableMechanic::bFinished {false}

protected

Has the runnable finished executing.

bStop

std::atomic<bool> FCommonChain::FCommonRunnableMechanic::bStop {false}

protected

Manual stop signal.

Thread

FRunnableThread* FCommonChain::FCommonRunnableMechanic::Thread = nullptr

protected

The executing thread.

---

The documentation for this struct was generated from the following file:

• CommonChain.h