Faro::IThreadInterface Class Reference

Abstract interface of a thread. More...

#include <Thread.hpp>

Inheritance diagram for Faro::IThreadInterface:

Public Member Functions
virtual	~IThreadInterface ()=default
void	AddTask (ThreadTask task)
	Schedule the supplied task to be executed ont this thread.
virtual String	GetThreadId ()=0

Protected Member Functions
virtual void	ThreadInit ()=0
	Executed while starting the thread.
virtual void	ThreadUpdate ()=0
	Executed while the thread is active.
virtual void	ThreadDestroy ()=0
	Executed when the thread is being stopped.
void	RunTasks ()
	Executed any pending tasks.
void	RegisterThread ()
void	UnregisterThread ()

Detailed Description

Abstract interface of a thread.

Constructor & Destructor Documentation

~IThreadInterface()

virtual Faro::IThreadInterface::~IThreadInterface ( )

virtualdefault

Member Function Documentation

AddTask()

void Faro::IThreadInterface::AddTask

(

ThreadTask

task

)

Schedule the supplied task to be executed ont this thread.

Parameters

task	Task function to execute

GetThreadId()

virtual String Faro::IThreadInterface::GetThreadId ( )

pure virtual

Implemented in Faro::MainThread, and Faro::IThread.

RegisterThread()

void Faro::IThreadInterface::RegisterThread ( )

protected

RunTasks()

void Faro::IThreadInterface::RunTasks ( )

protected

Executed any pending tasks.

ThreadDestroy()

virtual void Faro::IThreadInterface::ThreadDestroy ( )

protectedpure virtual

Executed when the thread is being stopped.

Implemented in Faro::MainThread.

ThreadInit()

virtual void Faro::IThreadInterface::ThreadInit ( )

protectedpure virtual

Executed while starting the thread.

Implemented in Faro::MainThread.

ThreadUpdate()

virtual void Faro::IThreadInterface::ThreadUpdate ( )

protectedpure virtual

Executed while the thread is active.

Implemented in Faro::MainThread.

UnregisterThread()

void Faro::IThreadInterface::UnregisterThread ( )

protected

---

The documentation for this class was generated from the following files:

• /github/workspace/Source/Engine/Platform/PlatformBase/Source/Thread.hpp
• /github/workspace/Source/Engine/Platform/PlatformBase/Source/Thread.cpp