#include <Urho3D/Core/WorkQueue.h>

Inheritance diagram for Urho3D::WorkQueue:

Public Member Functions
	WorkQueue (Context *context)
	Construct.

	~WorkQueue () override
	Destruct.

void	Initialize (unsigned numThreads)
	Create worker threads. Can only be called once.

void	Update ()
	Do work in main thread. Usually called once per frame.

void	PostTask (TaskFunction &&task, TaskPriority priority=TaskPriority::Medium)
	Post the task for any processing thread.

void	PostTaskForThread (TaskFunction &&task, TaskPriority priority, unsigned threadIndex)
	Post the task for specified processing thread.

void	PostTaskForMainThread (TaskFunction &&task, TaskPriority priority=TaskPriority::Medium)
	Post the task for main thread.

void	PostDelayedTaskForMainThread (TaskFunction &&task)
	Post delayed task for main thread. It is guaranteed to be invoked between frames.

void	CompleteImmediateForThisThread ()

void	CompleteAll ()

unsigned	GetNumIncomplete () const
	Return number of incomplete tasks.

bool	IsCompleted () const
	Return whether all work is finished.

void	SetNonThreadedWorkMs (int ms)
	Set how many milliseconds maximum per frame to spend on low-priority work, when there are no worker threads.

int	GetNonThreadedWorkMs () const
	Return how many milliseconds maximum to spend on non-threaded low-priority work.

unsigned	GetNumProcessingThreads () const
	Return total number of threads processing tasks, including main thread.

bool	IsMultithreaded () const
	Return whether the queue is actually using multithreading.


void	CallFromMainThread (WorkFunction workFunction)

void	Complete (unsigned priority)

SharedPtr< WorkItem >	GetFreeItem ()

void	AddWorkItem (const SharedPtr< WorkItem > &item)

SharedPtr< WorkItem >	AddWorkItem (WorkFunction workFunction, unsigned priority=0)

Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.

	~Object () override
	Destruct. Clean up self from event sender & receiver structures.

virtual StringHash	GetType () const =0

virtual const ea::string &	GetTypeName () const =0

virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.

virtual bool	IsInstanceOf (StringHash type) const =0
	Check whether current instance implements specified type.

virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.

virtual void	SerializeInBlock (Archive &archive)
	Serialize content from/to archive. May throw ArchiveException.

template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.

template<typename T >
T *	Cast ()
	Cast the object to specified most derived class.

template<typename T >
const T *	Cast () const
	Cast the object to specified most derived class.

void	SubscribeToEventManual (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.

void	SubscribeToEventManual (Object sender, StringHash eventType, EventHandler handler)
	Subscribe to a specific sender's event.

template<class T >
void	SubscribeToEvent (StringHash eventType, T handler)
	Subscribe to an event that can be sent by any sender.

template<class T >
void	SubscribeToEvent (Object *sender, StringHash eventType, T handler)
	Subscribe to a specific sender's event.

void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.

void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.

void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.

void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.

void	UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions)
	Unsubscribe from all events except those listed.

void	UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
	Unsubscribe from all events except those with listed senders.

void	SendEvent (StringHash eventType)
	Send event to all subscribers.

void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers.

VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.

template<typename... Args>
void	SendEvent (StringHash eventType, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.

Context *	GetContext () const
	Return execution context.

const Variant &	GetGlobalVar (StringHash key) const

const VariantMap &	GetGlobalVars () const

void	SetGlobalVar (StringHash key, const Variant &value)

Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.

Object *	GetEventSender () const
	Return active event sender. Null outside event handling.

EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.

bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.

bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.

bool	HasEventHandlers () const
	Return whether has subscribed to any event.

template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.

const ea::string &	GetCategory () const

void	SendEvent (StringHash eventType, const VariantMap &eventData)
	Send event with parameters to all subscribers.

void	SetBlockEvents (bool block)
	Block object from sending and receiving events.

bool	GetBlockEvents () const
	Return sending and receiving events blocking status.

Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.

virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.

	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.

RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.

int	AddRef ()

int	ReleaseRef ()

int	Refs () const

int	WeakRefs () const

RefCount *	RefCountPtr () const
	Return pointer to the reference count structure.

bool	HasScriptObject () const
	Return true if script runtime object wrapping this native object exists.

bool	IsScriptStrongRef () const
	Return true if script reference is strong.

Static Public Member Functions
static unsigned	GetThreadIndex ()
	Return current thread index.

static unsigned	GetThreadIndexCount ()
	Return number of threads used by WorkQueue, including main thread. Current thread index is always lower.

static bool	IsProcessingThread ()
	Return whether current thread is one of processing threads.

Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Private Member Functions
	URHO3D_OBJECT (WorkQueue, Object)

void	ProcessPostedTasks ()

void	ProcessMainThreadTasks ()

void	PurgeProcessedTasksInFallbackQueue ()

void	CompleteImmediateForAnotherThread (unsigned threadIndex)

Private Attributes
ea::vector< ea::pair< TaskPriority, TaskFunction > >	fallbackTaskQueue_

unsigned	numProcessingThreads_ {}
	Total number of threads, including main thread.

ea::vector< TaskFunction >	mainThreadTasks_
	Tasks to be invoked from main thread.

ea::vector< TaskFunction >	mainThreadTasksSwap_

Mutex	mainThreadTasksMutex_

int	maxNonThreadedWorkMs_ {5}
	Maximum milliseconds per frame to spend on low-priority work, when there are no worker threads.

Friends
class	WorkerThread

template<class T >
void	PostTask (T task, TaskPriority priority=TaskPriority::Medium)

template<class T >
void	PostTaskForThread (T task, TaskPriority priority, unsigned threadIndex)

template<class T >
void	PostTaskForMainThread (T task, TaskPriority priority=TaskPriority::Medium)

template<class T >
void	PostDelayedTaskForMainThread (T task)

template<class T >
static TaskFunction	WrapTask (T &&task)

Additional Inherited Members
Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}

Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Detailed Description

Work queue subsystem for multithreading. Tasks can be posted from any thread, but it is the most efficient from main thread or worker threads. Tasks posted from other threads may be posted with up to one frame delay and require heap allocation.

Member Function Documentation

◆ CallFromMainThread()

void Urho3D::WorkQueue::CallFromMainThread ( WorkFunction workFunction )

Deprecated API.

◆ CompleteAll()

void Urho3D::WorkQueue::CompleteAll ( )

Wait for completion of all tasks. Should be called only from main thread.

◆ CompleteImmediateForThisThread()

void Urho3D::WorkQueue::CompleteImmediateForThisThread ( )

Complete tasks with Immediate priority, posted from this thread. Can be called only from main thread or from another task.

◆ WrapTask()

template<class T >

TaskFunction Urho3D::WorkQueue::WrapTask ( T && task )

staticprivate

WorkQueue implementation

Member Data Documentation

◆ fallbackTaskQueue_

ea::vector<ea::pair<TaskPriority, TaskFunction> > Urho3D::WorkQueue::fallbackTaskQueue_

private

Task queue used for fallback if no threads available. Used only for PostTask and PostTaskForThread, therefore no need for mutex.

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

Urho3D/Core/WorkQueue.h
Urho3D/Core/WorkQueue.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members