OGRE  1.12.9
Object-Oriented Graphics Rendering Engine
Ogre::WorkQueue::Response Struct Reference

General purpose response structure. More...

#include <OgreWorkQueue.h>

+ Inheritance 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...
 
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.

Constructor & Destructor Documentation

◆ Response()

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

◆ ~Response()

Ogre::WorkQueue::Response::~Response ( )

Member Function Documentation

◆ getRequest()

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

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

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

◆ succeeded()

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

Return whether this is a successful response.

◆ getMessages()

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

Get any diagnostic messages about the process.

◆ getData()

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

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

◆ abortRequest()

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

Abort the request.

References Ogre::WorkQueue::Request::abortRequest(), and Ogre::Any::reset().

Member Data Documentation

◆ mRequest

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

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

◆ mSuccess

bool Ogre::WorkQueue::Response::mSuccess

Whether the work item succeeded or not.

◆ mMessages

String Ogre::WorkQueue::Response::mMessages

Any diagnostic messages.

◆ mData

Any Ogre::WorkQueue::Response::mData

Data associated with the result of the process.


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