ezDelegateTask< T > Class Template Reference

Convenience task wrapper that executes delegate functions with parameters. More...

#include <DelegateTask.h>

Inheritance diagram for ezDelegateTask< T >:

Public Types
using	FunctionType = ezDelegate< void(const T &)>

Public Member Functions
	ezDelegateTask (const char *szTaskName, ezTaskNesting taskNesting, FunctionType func, const T &param)
Public Member Functions inherited from ezTask
void	ConfigureTask (const char *szTaskName, ezTaskNesting nestingMode, ezOnTaskFinishedCallback callback=ezOnTaskFinishedCallback())
	Sets the most important task properties. This has to be done before the task is added to a task group for the first time.
void	SetMultiplicity (ezUInt32 uiMultiplicity)
	Changes the multiplicity of this task.
ezUInt32	GetMultiplicity () const
bool	IsTaskFinished () const
	Returns whether the task has been finished. This includes being canceled.
bool	HasBeenCanceled () const
	Can be used inside an overridden 'Execute' function to terminate execution prematurely.
Public Member Functions inherited from ezRefCounted
virtual	~ezRefCounted ()=default
	Adds a virtual destructor.
Public Member Functions inherited from ezRefCountingImpl
	ezRefCountingImpl ()=default
	Constructor.
	ezRefCountingImpl (const ezRefCountingImpl &rhs)
void	operator= (const ezRefCountingImpl &rhs)
ezInt32	AddRef () const
	Increments the reference counter. Returns the new reference count.
ezInt32	ReleaseRef () const
	Decrements the reference counter. Returns the new reference count.
bool	IsReferenced () const
	Returns true if the reference count is greater than 0, false otherwise.
ezInt32	GetRefCount () const
	Returns the current reference count.

Private Member Functions
virtual void	Execute () override
	Override this to implement the task's supposed functionality.

Additional Inherited Members
Protected Member Functions inherited from ezTask
virtual void	ExecuteWithMultiplicity (ezUInt32 uiInvocation) const
	Override this to implement the task's supposed functionality.

Detailed Description

template<typename T>
class ezDelegateTask< T >

Convenience task wrapper that executes delegate functions with parameters.

Provides an easy way to wrap function calls (delegates) as tasks for the task system. The template parameter T specifies the type of data passed to the delegate function. Use the void specialization for parameterless functions. This eliminates the need to manually derive from ezTask for simple function execution scenarios.

Member Function Documentation

Execute()

template<typename T >

virtual void ezDelegateTask< T >::Execute ( )

inlineoverrideprivatevirtual

Override this to implement the task's supposed functionality.

This function is called for tasks that do not use multiplicity. They are executed a single time for each time they are added to the ezTaskSystem.

Reimplemented from ezTask.

---

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

• /home/runner/work/ezEngine/ezEngine/Code/Engine/Foundation/Threading/DelegateTask.h