OGRE  1.9.0
Ogre::WorkQueue::Request Class Reference

General purpose request structure. More...

#include <OgreWorkQueue.h>

Inheritance diagram for Ogre::WorkQueue::Request:

Public Member Functions

 Request (uint16 channel, uint16 rtype, const Any &rData, uint8 retry, RequestID rid)
 Constructor.
 
 ~Request ()
 
void abortRequest () const
 Set the abort flag.
 
bool getAborted () const
 Get the abort flag.
 
uint16 getChannel () const
 Get the request channel (top level categorisation)
 
const AnygetData () const
 Get the user details of this request.
 
RequestID getID () const
 Get the identifier of this request.
 
uint8 getRetryCount () const
 Get the remaining retry count.
 
uint16 getType () const
 Get the type of this request within the given channel.
 
void operator delete (void *ptr)
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, void *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz)
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info
 
void * operator new (size_t sz, void *ptr)
 placement operator new
 
void * operator new (size_t sz, void *ptr)
 placement operator new
 
void * operator new[] (size_t sz)
 
void * operator new[] (size_t sz)
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info
 

Protected Attributes

bool mAborted
 Abort Flag.
 
uint16 mChannel
 The request channel, as an integer.
 
Any mData
 The details of the request (user defined)
 
RequestID mID
 Identifier (assigned by the system)
 
uint8 mRetryCount
 Retry count - set this to non-zero to have the request try again on failure.
 
uint16 mType
 The request type, as an integer within the channel (user can define enumerations on this)
 

Friends

class WorkQueue
 

Detailed Description

General purpose request structure.

Definition at line 83 of file OgreWorkQueue.h.

Constructor & Destructor Documentation

◆ Request()

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

Constructor.

◆ ~Request()

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

Member Function Documentation

◆ abortRequest()

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

Set the abort flag.

Definition at line 105 of file OgreWorkQueue.h.

References mAborted.

◆ getAborted()

bool Ogre::WorkQueue::Request::getAborted ( ) const

◆ getChannel()

uint16 Ogre::WorkQueue::Request::getChannel ( ) const

Get the request channel (top level categorisation)

Definition at line 107 of file OgreWorkQueue.h.

References mChannel.

◆ getData()

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

Get the user details of this request.

Definition at line 111 of file OgreWorkQueue.h.

References mData.

◆ getID()

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

Get the identifier of this request.

Definition at line 115 of file OgreWorkQueue.h.

References mID.

◆ getRetryCount()

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

Get the remaining retry count.

Definition at line 113 of file OgreWorkQueue.h.

References mRetryCount.

◆ getType()

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

Get the type of this request within the given channel.

Definition at line 109 of file OgreWorkQueue.h.

References mType.

◆ operator delete() [1/6]

void Ogre::AllocatedObject< GeneralAllocPolicy >::operator delete ( void * ptr)
inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [2/6]

void Ogre::AllocatedObject< GeneralAllocPolicy >::operator delete ( void * ptr)
inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [3/6]

void Ogre::AllocatedObject< GeneralAllocPolicy >::operator delete ( void * ptr,
const char * ,
int ,
const char *  )
inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [4/6]

void Ogre::AllocatedObject< GeneralAllocPolicy >::operator delete ( void * ptr,
const char * ,
int ,
const char *  )
inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [5/6]

void Ogre::AllocatedObject< GeneralAllocPolicy >::operator delete ( void * ptr,
void *  )
inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [6/6]

void Ogre::AllocatedObject< GeneralAllocPolicy >::operator delete ( void * ptr,
void *  )
inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

◆ operator delete[]() [1/4]

void Ogre::AllocatedObject< GeneralAllocPolicy >::operator delete[] ( void * ptr)
inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

◆ operator delete[]() [2/4]

void Ogre::AllocatedObject< GeneralAllocPolicy >::operator delete[] ( void * ptr)
inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

◆ operator delete[]() [3/4]

void Ogre::AllocatedObject< GeneralAllocPolicy >::operator delete[] ( void * ptr,
const char * ,
int ,
const char *  )
inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

◆ operator delete[]() [4/4]

void Ogre::AllocatedObject< GeneralAllocPolicy >::operator delete[] ( void * ptr,
const char * ,
int ,
const char *  )
inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

◆ operator new() [1/6]

void * Ogre::AllocatedObject< GeneralAllocPolicy >::operator new ( size_t sz)
inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

◆ operator new() [2/6]

void * Ogre::AllocatedObject< GeneralAllocPolicy >::operator new ( size_t sz)
inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

◆ operator new() [3/6]

void * Ogre::AllocatedObject< GeneralAllocPolicy >::operator new ( size_t sz,
const char * file,
int line,
const char * func )
inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

◆ operator new() [4/6]

void * Ogre::AllocatedObject< GeneralAllocPolicy >::operator new ( size_t sz,
const char * file,
int line,
const char * func )
inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

◆ operator new() [5/6]

void * Ogre::AllocatedObject< GeneralAllocPolicy >::operator new ( size_t sz,
void * ptr )
inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

◆ operator new() [6/6]

void * Ogre::AllocatedObject< GeneralAllocPolicy >::operator new ( size_t sz,
void * ptr )
inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

◆ operator new[]() [1/4]

void * Ogre::AllocatedObject< GeneralAllocPolicy >::operator new[] ( size_t sz)
inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

◆ operator new[]() [2/4]

void * Ogre::AllocatedObject< GeneralAllocPolicy >::operator new[] ( size_t sz)
inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

◆ operator new[]() [3/4]

void * Ogre::AllocatedObject< GeneralAllocPolicy >::operator new[] ( size_t sz,
const char * file,
int line,
const char * func )
inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

◆ operator new[]() [4/4]

void * Ogre::AllocatedObject< GeneralAllocPolicy >::operator new[] ( size_t sz,
const char * file,
int line,
const char * func )
inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

Friends And Related Symbol Documentation

◆ WorkQueue

friend class WorkQueue
friend

Definition at line 85 of file OgreWorkQueue.h.

References WorkQueue.

Referenced by WorkQueue.

Member Data Documentation

◆ mAborted

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

Abort Flag.

Definition at line 98 of file OgreWorkQueue.h.

Referenced by abortRequest(), and getAborted().

◆ mChannel

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

The request channel, as an integer.

Definition at line 88 of file OgreWorkQueue.h.

Referenced by getChannel().

◆ mData

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

The details of the request (user defined)

Definition at line 92 of file OgreWorkQueue.h.

Referenced by getData().

◆ mID

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

Identifier (assigned by the system)

Definition at line 96 of file OgreWorkQueue.h.

Referenced by getID().

◆ mRetryCount

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

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

Definition at line 94 of file OgreWorkQueue.h.

Referenced by getRetryCount().

◆ mType

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

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

Definition at line 90 of file OgreWorkQueue.h.

Referenced by getType().


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