Ogre::WorkQueue::Response Struct Reference

General purpose response structure. More...

#include <OgreWorkQueue.h>

Inheritance diagram for Ogre::WorkQueue::Response:

List of all members.

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

---

Detailed Description

General purpose response structure.

Definition at line 122 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 145 of file OgreWorkQueue.h.

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.

const String& Ogre::WorkQueue::Response::getMessages

(

)

const

Get any diagnostic messages about the process.

Definition at line 141 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 137 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 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 102 of file OgreMemoryAllocatedObject.h.

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.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[]

(

void *

ptr

)

[inherited]

Definition at line 113 of file OgreMemoryAllocatedObject.h.

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.

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.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new

(

size_t

sz

)

[inherited]

Definition at line 73 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 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
	)		[inherited]

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

)

[inherited]

Definition at line 91 of file OgreMemoryAllocatedObject.h.

bool Ogre::WorkQueue::Response::succeeded

(

)

const

Return whether this is a successful response.

Definition at line 139 of file OgreWorkQueue.h.

---

Member Data Documentation

Any Ogre::WorkQueue::Response::mData

Data associated with the result of the process.

Definition at line 131 of file OgreWorkQueue.h.

String Ogre::WorkQueue::Response::mMessages

Any diagnostic messages.

Definition at line 129 of file OgreWorkQueue.h.

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.

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