Interface to a general purpose request / response style background work queue. More...
#include <OgreWorkQueue.h>
Classes | |
class | Request |
General purpose request structure. More... | |
class | RequestHandler |
Interface definition for a handler of requests. More... | |
struct | Response |
General purpose response structure. More... | |
class | ResponseHandler |
Interface definition for a handler of responses. More... | |
Public Types | |
typedef unsigned long long int | RequestID |
Numeric identifier for a request. More... | |
Public Member Functions | |
WorkQueue () | |
virtual | ~WorkQueue () |
virtual void | abortAllRequests ()=0 |
Abort all previously issued requests. More... | |
virtual void | abortRequest (RequestID id)=0 |
Abort a previously issued request. More... | |
virtual void | abortRequestsByChannel (uint16 channel)=0 |
Abort all previously issued requests in a given channel. More... | |
virtual RequestID | addRequest (uint16 channel, uint16 requestType, const Any &rData, uint8 retryCount=0, bool forceSynchronous=false)=0 |
Add a new request to the queue. More... | |
virtual void | addRequestHandler (uint16 channel, RequestHandler *rh)=0 |
Add a request handler instance to the queue. More... | |
virtual void | addResponseHandler (uint16 channel, ResponseHandler *rh)=0 |
Add a response handler instance to the queue. More... | |
virtual uint16 | getChannel (const String &channelName) |
Get a channel ID for a given channel name. More... | |
virtual bool | getRequestsAccepted () const =0 |
Returns whether requests are being accepted right now. More... | |
virtual unsigned long | getResponseProcessingTimeLimit () const =0 |
Get the time limit imposed on the processing of responses in a single frame, in milliseconds (0 indicates no limit). More... | |
virtual bool | isPaused () const =0 |
Return whether the queue is paused ie not sending more work to workers. More... | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, void *) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz, const char *file, int line, const char *func) |
operator new, with debug line info More... | |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *ptr) |
placement operator new More... | |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info More... | |
void * | operator new[] (size_t sz) |
virtual void | processResponses ()=0 |
Process the responses in the queue. More... | |
virtual void | removeRequestHandler (uint16 channel, RequestHandler *rh)=0 |
Remove a request handler. More... | |
virtual void | removeResponseHandler (uint16 channel, ResponseHandler *rh)=0 |
Remove a Response handler. More... | |
virtual void | setPaused (bool pause)=0 |
Set whether to pause further processing of any requests. More... | |
virtual void | setRequestsAccepted (bool accept)=0 |
Set whether to accept new requests or not. More... | |
virtual void | setResponseProcessingTimeLimit (unsigned long ms)=0 |
Set the time limit imposed on the processing of responses in a single frame, in milliseconds (0 indicates no limit). More... | |
virtual void | shutdown ()=0 |
Shut down the queue. More... | |
virtual void | startup (bool forceRestart=true)=0 |
Start up the queue with the options that have been set. More... | |
Protected Types | |
typedef std::map< String, uint16 > | ChannelMap |
Protected Attributes | |
ChannelMap | mChannelMap |
uint16 | mNextChannel |
Interface to a general purpose request / response style background work queue.
Definition at line 69 of file OgreWorkQueue.h.
|
protected |
Definition at line 72 of file OgreWorkQueue.h.
typedef unsigned long long int Ogre::WorkQueue::RequestID |
Numeric identifier for a request.
Definition at line 78 of file OgreWorkQueue.h.
|
inline |
Definition at line 220 of file OgreWorkQueue.h.
|
inlinevirtual |
Definition at line 221 of file OgreWorkQueue.h.
|
pure virtual |
Abort all previously issued requests.
Any requests still waiting to be processed will be removed from the queue. Any requests that are being processed will still complete.
Implemented in Ogre::DefaultWorkQueueBase.
|
pure virtual |
Abort a previously issued request.
If the request is still waiting to be processed, it will be removed from the queue.
id | The ID of the previously issued request. |
Implemented in Ogre::DefaultWorkQueueBase.
|
pure virtual |
Abort all previously issued requests in a given channel.
Any requests still waiting to be processed of the given channel, will be removed from the queue.
channel | The type of request to be aborted |
Implemented in Ogre::DefaultWorkQueueBase.
|
pure virtual |
Add a new request to the queue.
channel | The channel this request will go into = 0; the channel is the top-level categorisation of the request |
requestType | An identifier that's unique within this queue which identifies the type of the request (user decides the actual value) |
rData | The data required by the request process. |
retryCount | The number of times the request should be retried if it fails. |
forceSynchronous | Forces the request to be processed immediately even if threading is enabled. |
Implemented in Ogre::DefaultWorkQueueBase.
|
pure virtual |
Add a request handler instance to the queue.
channel | The channel for requests you want to handle |
rh | Your handler |
Implemented in Ogre::DefaultWorkQueueBase.
|
pure virtual |
Add a response handler instance to the queue.
channel | The channel for responses you want to handle |
rh | Your handler |
Implemented in Ogre::DefaultWorkQueueBase.
Get a channel ID for a given channel name.
|
pure virtual |
Returns whether requests are being accepted right now.
Implemented in Ogre::DefaultWorkQueueBase.
|
pure virtual |
Get the time limit imposed on the processing of responses in a single frame, in milliseconds (0 indicates no limit).
Implemented in Ogre::DefaultWorkQueueBase.
|
pure virtual |
Return whether the queue is paused ie not sending more work to workers.
Implemented in Ogre::DefaultWorkQueueBase.
|
inlineinherited |
Definition at line 95 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 101 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 107 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 112 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 118 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 67 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 72 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 78 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 85 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 90 of file OgreMemoryAllocatedObject.h.
|
pure virtual |
Process the responses in the queue.
Implemented in Ogre::DefaultWorkQueueBase.
|
pure virtual |
Remove a request handler.
Implemented in Ogre::DefaultWorkQueueBase.
|
pure virtual |
Remove a Response handler.
Implemented in Ogre::DefaultWorkQueueBase.
|
pure virtual |
Set whether to pause further processing of any requests.
If true, any further requests will simply be queued and not processed until setPaused(false) is called. Any requests which are in the process of being worked on already will still continue.
Implemented in Ogre::DefaultWorkQueueBase.
|
pure virtual |
Set whether to accept new requests or not.
If true, requests are added to the queue as usual. If false, requests are silently ignored until setRequestsAccepted(true) is called.
Implemented in Ogre::DefaultWorkQueueBase.
|
pure virtual |
Set the time limit imposed on the processing of responses in a single frame, in milliseconds (0 indicates no limit).
This sets the maximum time that will be spent in processResponses() in a single frame. The default is 8ms.
Implemented in Ogre::DefaultWorkQueueBase.
|
pure virtual |
Shut down the queue.
Implemented in Ogre::DefaultWorkQueue, and Ogre::DefaultWorkQueue.
|
pure virtual |
Start up the queue with the options that have been set.
forceRestart | If the queue is already running, whether to shut it down and restart. |
Implemented in Ogre::DefaultWorkQueue, and Ogre::DefaultWorkQueue.
|
protected |
Definition at line 73 of file OgreWorkQueue.h.
|
protected |
Definition at line 74 of file OgreWorkQueue.h.