OGRE: Ogre::WorkQueue::Response Struct Reference - OGRE Documentation

Public Member Functions | Public Attributes

# Ogre::WorkQueue::Response Struct Reference

General purpose response structure. More...

`#include <OgreWorkQueue.h>`

Inheritance diagram for Ogre::WorkQueue::Response:
[legend]

List of all members.

## Public Member Functions
| Response (const Request *rq, bool success, const Any &data, const String &msg=StringUtil::BLANK)
| ~Response ()
const Request * | getRequest () const
| Get the request that this is a response to (NB destruction destroys this).
bool | succeeded () const
| Return whether this is a successful response.
const String & | getMessages () const
| Get any diagnostic messages about the process.
const Any & | getData () const
| Return the response data (user defined, only valid on success).
void | abortRequest ()
| Abort the request.
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 * | operator new (size_t sz, void *ptr)
| placement operator new
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)
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 *)
## Public Attributes
const Request * | mRequest
| Pointer to the request that this response is in relation to.
bool | mSuccess
| Whether the work item succeeded or not.
String | mMessages
| Any diagnostic messages.
Any | mData
| Data associated with the result of the process.

## Detailed Description

General purpose response structure.

Definition at line 121 of file OgreWorkQueue.h.

## Constructor & Destructor Documentation

Ogre::WorkQueue::Response::Response | ( | const Request * | rq,
|  | bool | success,
|  | const Any & | data,
|  | const String & | msg = `StringUtil::BLANK` |
| ) |  |  |

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

## Member Function Documentation

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

Abort the request.

Definition at line 144 of file OgreWorkQueue.h.

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

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

Definition at line 142 of file OgreWorkQueue.h.

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

Get any diagnostic messages about the process.

Definition at line 140 of file OgreWorkQueue.h.

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

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

Definition at line 136 of file OgreWorkQueue.h.

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

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) | `[inherited]`

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |  |
| ) |  |  | `[inherited]`

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 118 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) | `[inherited]`

Definition at line 112 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | void * | ptr |
| ) |  |  | `[inherited]`

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

operator new, with debug line info

Definition at line 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 72 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

array operator new, with debug line info

Definition at line 85 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 90 of file OgreMemoryAllocatedObject.h.

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

Return whether this is a successful response.

Definition at line 138 of file OgreWorkQueue.h.

## Member Data Documentation

Any Ogre::WorkQueue::Response::mData

Data associated with the result of the process.

Definition at line 130 of file OgreWorkQueue.h.

String Ogre::WorkQueue::Response::mMessages

Any diagnostic messages.

Definition at line 128 of file OgreWorkQueue.h.

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

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

Definition at line 124 of file OgreWorkQueue.h.

bool Ogre::WorkQueue::Response::mSuccess

Whether the work item succeeded or not.

Definition at line 126 of file OgreWorkQueue.h.

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

- OgreWorkQueue.h

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Wed Nov 3 2010 19:25:03