ezThreadWithDispatcher Class Reference

This class is the base class for threads which need dispatching of calls. More...

#include <ThreadWithDispatcher.h>

Inheritance diagram for ezThreadWithDispatcher:

Public Types
using	DispatchFunction = ezDelegate< void(), 128 >
Public Types inherited from ezThread
enum	ezThreadStatus { Created = 0 , Running , Finished }
	Describes the thread status.

Public Member Functions
	ezThreadWithDispatcher (const char *szName="ezThreadWithDispatcher", ezUInt32 uiStackSize=128 *1024)
	Initializes the runnable class.
virtual	~ezThreadWithDispatcher ()
	Destructor checks if the thread is deleted while still running, which is not allowed as this is a data hazard.
void	Dispatch (DispatchFunction &&delegate)
	Use this to enqueue a function call to the given delegate at some later point running in the given thread context.
Public Member Functions inherited from ezThread
	ezThread (ezStringView sName="ezThread", ezUInt32 uiStackSize=128 *1024)
	Initializes the runnable class.
virtual	~ezThread ()
	Destructor checks if the thread is deleted while still running, which is not allowed as this is a data hazard.
ezThreadStatus	GetThreadStatus () const
	Returns the thread status.
bool	IsRunning () const
	Helper function to determine if the thread is running.
const char *	GetThreadName () const
	Returns the thread name.
Public Member Functions inherited from ezOSThread
	ezOSThread (ezOSThreadEntryPoint threadEntryPoint, void *pUserData=nullptr, ezStringView sName="ezOSThread", ezUInt32 uiStackSize=128 *1024)
	Initializes the thread instance (e.g. thread creation etc.)
virtual	~ezOSThread ()
	Destructor.
void	Start ()
	Starts the thread.
void	Join ()
	Waits in the calling thread until the thread has finished execution (e.g. returned from the thread function)
const ezThreadID &	GetThreadID () const
	Returns the thread ID of the thread object, may be used in comparison operations with ezThreadUtils::GetCurrentThreadID() for example.

Protected Member Functions
void	DispatchQueue ()
	Needs to be called by derived thread implementations to dispatch the function calls.

Private Member Functions
virtual ezUInt32	Run ()=0
	The run function can be used to implement a long running task in a thread in a platform independent way.

Additional Inherited Members
Static Public Member Functions inherited from ezThread
static const ezThread *	GetCurrentThread ()
	Returns the current ezThread if the current platform thread is an ezThread. Returns nullptr otherwise.
Static Public Member Functions inherited from ezOSThread
static ezInt32	GetThreadCount ()
	Returns how many ezOSThreads are currently active.
Static Public Attributes inherited from ezThread
static ezEvent< const ezThreadEvent &, ezMutex >	s_ThreadEvents
	These events inform about threads starting and finishing.
Protected Attributes inherited from ezOSThread
ezThreadHandle	m_hHandle
ezThreadID	m_ThreadID
ezOSThreadEntryPoint	m_EntryPoint
void *	m_pUserData
ezString	m_sName
ezUInt32	m_uiStackSize

Detailed Description

This class is the base class for threads which need dispatching of calls.

Used by deriving from this class and overriding the Run() method. Call DispatchQueue() regurarely so that the collected messages can be dispatched.

Member Function Documentation

Run()

virtual ezUInt32 ezThreadWithDispatcher::Run ( )

privatepure virtual

The run function can be used to implement a long running task in a thread in a platform independent way.

Implements ezThread.

---

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

• /home/runner/work/ezEngine/ezEngine/Code/Engine/Foundation/Threading/ThreadWithDispatcher.h
• /home/runner/work/ezEngine/ezEngine/Code/Engine/Foundation/Threading/Implementation/ThreadWithDispatcher.cpp