Ogre::WorkQueue::Response Struct Reference

General purpose response structure. More...

`#include <OgreWorkQueue.h>`

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

## Public Member Functions

| Response (const Request *rq, bool success, const Any &data, const String &msg=StringUtil::BLANK)
| ~Response ()
void | abortRequest ()
| Abort the request. More...
const Any & | getData () const
| Return the response data (user defined, only valid on success) More...
const String & | getMessages () const
| Get any diagnostic messages about the process. More...
const Request * | getRequest () 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 Request * | mRequest
| 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 122 of file OgreWorkQueue.h.

## Constructor & Destructor Documentation

## Response()

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

## ~Response()

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

## Member Function Documentation

## abortRequest()

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

Abort the request.

Definition at line 145 of file OgreWorkQueue.h.

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

## getData()

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

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

Definition at line 143 of file OgreWorkQueue.h.

## getMessages()

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

Get any diagnostic messages about the process.

Definition at line 141 of file OgreWorkQueue.h.

## getRequest()

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

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

Definition at line 137 of file OgreWorkQueue.h.

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

## operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) |

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

## operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |
| ) |  |

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

## operator delete() [3/3]

template<class Alloc >

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

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [1/2]

template<class Alloc >

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

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

## operator new() [1/3]

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 68 of file OgreMemoryAllocatedObject.h.

## operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) |

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

## operator new() [3/3]

template<class Alloc >

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

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

## operator new[]() [1/2]

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 86 of file OgreMemoryAllocatedObject.h.

## operator new[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

## succeeded()

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

Return whether this is a successful response.

Definition at line 139 of file OgreWorkQueue.h.

## Member Data Documentation

## mData

Any Ogre::WorkQueue::Response::mData

Data associated with the result of the process.

Definition at line 131 of file OgreWorkQueue.h.

## mMessages

String Ogre::WorkQueue::Response::mMessages

Any diagnostic messages.

Definition at line 129 of file OgreWorkQueue.h.

## mRequest

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

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

Definition at line 125 of file OgreWorkQueue.h.

## mSuccess

bool Ogre::WorkQueue::Response::mSuccess

Whether the work item succeeded or not.

Definition at line 127 of file OgreWorkQueue.h.

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

- OgreWorkQueue.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.