OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::WorkQueue::Request Class Reference

General purpose request structure. More...

#include <OgreWorkQueue.h>

+ Inheritance diagram for Ogre::WorkQueue::Request:
+ Collaboration diagram for Ogre::WorkQueue::Request:

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 AnygetData () 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
 

Detailed Description

General purpose request structure.

Definition at line 84 of file OgreWorkQueue.h.

Constructor & Destructor Documentation

Ogre::WorkQueue::Request::Request ( uint16  channel,
uint16  rtype,
const Any rData,
uint8  retry,
RequestID  rid 
)

Constructor.

Ogre::WorkQueue::Request::~Request ( )

Member Function Documentation

void Ogre::WorkQueue::Request::abortRequest ( ) const
inline

Set the abort flag.

Definition at line 106 of file OgreWorkQueue.h.

bool Ogre::WorkQueue::Request::getAborted ( ) const
inline
uint16 Ogre::WorkQueue::Request::getChannel ( ) const
inline

Get the request channel (top level categorisation)

Definition at line 108 of file OgreWorkQueue.h.

const Any& Ogre::WorkQueue::Request::getData ( ) const
inline

Get the user details of this request.

Definition at line 112 of file OgreWorkQueue.h.

RequestID Ogre::WorkQueue::Request::getID ( ) const
inline

Get the identifier of this request.

Definition at line 116 of file OgreWorkQueue.h.

uint8 Ogre::WorkQueue::Request::getRetryCount ( ) const
inline

Get the remaining retry count.

Definition at line 114 of file OgreWorkQueue.h.

uint16 Ogre::WorkQueue::Request::getType ( void  ) const
inline

Get the type of this request within the given channel.

Definition at line 110 of file OgreWorkQueue.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

Friends And Related Function Documentation

friend class WorkQueue
friend

Definition at line 86 of file OgreWorkQueue.h.

Member Data Documentation

bool Ogre::WorkQueue::Request::mAborted
mutableprotected

Abort Flag.

Definition at line 99 of file OgreWorkQueue.h.

uint16 Ogre::WorkQueue::Request::mChannel
protected

The request channel, as an integer.

Definition at line 89 of file OgreWorkQueue.h.

Any Ogre::WorkQueue::Request::mData
protected

The details of the request (user defined)

Definition at line 93 of file OgreWorkQueue.h.

RequestID Ogre::WorkQueue::Request::mID
protected

Identifier (assigned by the system)

Definition at line 97 of file OgreWorkQueue.h.

uint8 Ogre::WorkQueue::Request::mRetryCount
protected

Retry count - set this to non-zero to have the request try again on failure.

Definition at line 95 of file OgreWorkQueue.h.

uint16 Ogre::WorkQueue::Request::mType
protected

The request type, as an integer within the channel (user can define enumerations on this)

Definition at line 91 of file OgreWorkQueue.h.


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