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

General purpose response structure. More...

#include <OgreWorkQueue.h>

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

Public Member Functions

 Response (const Request *rq, bool success, const Any &data, const String &msg=BLANKSTRING)
 
 ~Response ()
 
void abortRequest ()
 Abort the request. More...
 
const AnygetData () const
 Return the response data (user defined, only valid on success) More...
 
const StringgetMessages () const
 Get any diagnostic messages about the process. More...
 
const RequestgetRequest () const
 Get the request that this is a response to (NB destruction destroys this) 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)
 
bool succeeded () const
 Return whether this is a successful response. More...
 

Public Attributes

Any mData
 Data associated with the result of the process. More...
 
String mMessages
 Any diagnostic messages. More...
 
const RequestmRequest
 Pointer to the request that this response is in relation to. More...
 
bool mSuccess
 Whether the work item succeeded or not. More...
 

Detailed Description

General purpose response structure.

Definition at line 123 of file OgreWorkQueue.h.

Constructor & Destructor Documentation

Ogre::WorkQueue::Response::Response ( const Request rq,
bool  success,
const Any data,
const String msg = BLANKSTRING 
)
Ogre::WorkQueue::Response::~Response ( )

Member Function Documentation

void Ogre::WorkQueue::Response::abortRequest ( )
inline

Abort the request.

Definition at line 146 of file OgreWorkQueue.h.

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

Return the response data (user defined, only valid on success)

Definition at line 144 of file OgreWorkQueue.h.

const String& Ogre::WorkQueue::Response::getMessages ( ) const
inline

Get any diagnostic messages about the process.

Definition at line 142 of file OgreWorkQueue.h.

const Request* Ogre::WorkQueue::Response::getRequest ( ) const
inline

Get the request that this is a response to (NB destruction destroys this)

Definition at line 138 of file OgreWorkQueue.h.

Referenced by Ogre::WorkQueue::ResponseHandler::canHandleResponse().

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.

bool Ogre::WorkQueue::Response::succeeded ( ) const
inline

Return whether this is a successful response.

Definition at line 140 of file OgreWorkQueue.h.

Member Data Documentation

Any Ogre::WorkQueue::Response::mData

Data associated with the result of the process.

Definition at line 132 of file OgreWorkQueue.h.

String Ogre::WorkQueue::Response::mMessages

Any diagnostic messages.

Definition at line 130 of file OgreWorkQueue.h.

const Request* Ogre::WorkQueue::Response::mRequest

Pointer to the request that this response is in relation to.

Definition at line 126 of file OgreWorkQueue.h.

bool Ogre::WorkQueue::Response::mSuccess

Whether the work item succeeded or not.

Definition at line 128 of file OgreWorkQueue.h.


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