General purpose request structure. More...
#include <OgreWorkQueue.h>
Public Member Functions | |
Request (uint16 channel, uint16 rtype, const Any &rData, uint8 retry, RequestID rid) | |
Constructor. More... | |
~Request () | |
void | abortRequest () const |
Set the abort flag. More... | |
bool | getAborted () const |
Get the abort flag. More... | |
uint16 | getChannel () const |
Get the request channel (top level categorisation) More... | |
const Any & | getData () const |
Get the user details of this request. More... | |
RequestID | getID () const |
Get the identifier of this request. More... | |
uint8 | getRetryCount () const |
Get the remaining retry count. More... | |
uint16 | getType () const |
Get the type of this request within the given channel. 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) |
Protected Attributes | |
bool | mAborted |
Abort Flag. More... | |
uint16 | mChannel |
The request channel, as an integer. More... | |
Any | mData |
The details of the request (user defined) More... | |
RequestID | mID |
Identifier (assigned by the system) More... | |
uint8 | mRetryCount |
Retry count - set this to non-zero to have the request try again on failure. More... | |
uint16 | mType |
The request type, as an integer within the channel (user can define enumerations on this) More... | |
Friends | |
class | WorkQueue |
General purpose request structure.
Definition at line 83 of file OgreWorkQueue.h.
Ogre::WorkQueue::Request::Request | ( | uint16 | channel, |
uint16 | rtype, | ||
const Any & | rData, | ||
uint8 | retry, | ||
RequestID | rid | ||
) |
Constructor.
Ogre::WorkQueue::Request::~Request | ( | ) |
void Ogre::WorkQueue::Request::abortRequest | ( | ) | const |
Set the abort flag.
Definition at line 105 of file OgreWorkQueue.h.
bool Ogre::WorkQueue::Request::getAborted | ( | ) | const |
Get the abort flag.
Definition at line 117 of file OgreWorkQueue.h.
Referenced by Ogre::WorkQueue::RequestHandler::canHandleRequest(), and Ogre::WorkQueue::ResponseHandler::canHandleResponse().
uint16 Ogre::WorkQueue::Request::getChannel | ( | ) | const |
Get the request channel (top level categorisation)
Definition at line 107 of file OgreWorkQueue.h.
const Any& Ogre::WorkQueue::Request::getData | ( | ) | const |
Get the user details of this request.
Definition at line 111 of file OgreWorkQueue.h.
RequestID Ogre::WorkQueue::Request::getID | ( | ) | const |
Get the identifier of this request.
Definition at line 115 of file OgreWorkQueue.h.
uint8 Ogre::WorkQueue::Request::getRetryCount | ( | ) | const |
Get the remaining retry count.
Definition at line 113 of file OgreWorkQueue.h.
uint16 Ogre::WorkQueue::Request::getType | ( | void | ) | const |
Get the type of this request within the given channel.
Definition at line 109 of file OgreWorkQueue.h.
|
inherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
friend |
Definition at line 85 of file OgreWorkQueue.h.
|
mutableprotected |
Abort Flag.
Definition at line 98 of file OgreWorkQueue.h.
|
protected |
The request channel, as an integer.
Definition at line 88 of file OgreWorkQueue.h.
|
protected |
The details of the request (user defined)
Definition at line 92 of file OgreWorkQueue.h.
|
protected |
Identifier (assigned by the system)
Definition at line 96 of file OgreWorkQueue.h.
|
protected |
Retry count - set this to non-zero to have the request try again on failure.
Definition at line 94 of file OgreWorkQueue.h.
|
protected |
The request type, as an integer within the channel (user can define enumerations on this)
Definition at line 90 of file OgreWorkQueue.h.
Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Fri Dec 20 2013 11:14:02