Urho3D
Public Member Functions | Private Member Functions | Private Attributes | Friends
Urho3D::WorkQueue Class Reference

Work queue subsystem for multithreading. More...

#include <WorkQueue.h>

Inheritance diagram for Urho3D::WorkQueue:
Urho3D::Object Urho3D::RefCounted

List of all members.

Public Member Functions

 WorkQueue (Context *context)
 Construct.
 ~WorkQueue ()
 Destruct.
void CreateThreads (unsigned numThreads)
 Create worker threads. Can only be called once.
void AddWorkItem (const WorkItem &item)
 Add a work item and resume worker threads.
void Pause ()
 Pause worker threads.
void Resume ()
 Resume worker threads.
void Complete (unsigned priority)
 Finish all queued work which has at least the specified priority. Main thread will also execute priority work. Pause worker threads if no more work remains.
unsigned GetNumThreads () const
 Return number of worker threads.
bool IsCompleted (unsigned priority) const
 Return whether all work with at least the specified priority is finished.
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 Construct.
virtual ~Object ()
 Destruct. Clean up self from event sender & receiver structures.
virtual ShortStringHash GetType () const =0
 Return type hash.
virtual const StringGetTypeName () const =0
 Return type name.
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
void SubscribeToEvent (StringHash eventType, EventHandler *handler)
 Subscribe to an event that can be sent by any sender.
void SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *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 PODVector< StringHash > &exceptions, bool onlyUserData)
 Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events.)
void SendEvent (StringHash eventType)
 Send event to all subscribers.
void SendEvent (StringHash eventType, VariantMap &eventData)
 Send event with parameters to all subscribers.
ContextGetContext () const
 Return execution context.
ObjectGetSubsystem (ShortStringHash type) const
 Return subsystem by type.
ObjectGetEventSender () const
 Return active event sender. Null outside event handling.
EventHandlerGetEventHandler () 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.
template<class T >
T * GetSubsystem () const
 Template version of returning a subsystem.
- 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.
void AddRef ()
 Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
void ReleaseRef ()
 Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
int Refs () const
 Return reference count.
int WeakRefs () const
 Return weak reference count.
RefCountRefCountPtr ()
 Return pointer to the reference count structure.

Private Member Functions

 OBJECT (WorkQueue)
void ProcessItems (unsigned threadIndex)
 Process work items until shut down. Called by the worker threads.
void PurgeCompleted ()
 Purge completed work items and send completion events as necessary.
void HandleBeginFrame (StringHash eventType, VariantMap &eventData)
 Handle frame start event. Purge completed work from the main thread queue, and perform work if no threads at all.

Private Attributes

Vector< SharedPtr< WorkerThread > > threads_
 Worker threads.
List< WorkItemworkItems_
 Work item collection. Accessed only by the main thread.
List< WorkItem * > queue_
 Work item prioritized queue for worker threads. Pointers are guaranteed to be valid (point to workItems.)
Mutex queueMutex_
 Worker queue mutex.
volatile bool shutDown_
 Shutting down flag.
volatile bool pausing_
 Pausing flag. Indicates the worker threads should not contend for the queue mutex.
bool paused_
 Paused flag. Indicates the queue mutex being locked to prevent worker threads using up CPU time.

Friends

class WorkerThread

Additional Inherited Members

- Protected Attributes inherited from Urho3D::Object
Contextcontext_
 Execution context.

Detailed Description

Work queue subsystem for multithreading.


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