\hypertarget{struct_ogre_1_1_work_queue_1_1_response}{}\section{Ogre\+:\+:Work\+Queue\+:\+:Response Struct Reference}
\label{struct_ogre_1_1_work_queue_1_1_response}\index{Ogre\+::\+Work\+Queue\+::\+Response@{Ogre\+::\+Work\+Queue\+::\+Response}}


General purpose response structure.  




{\ttfamily \#include $<$Ogre\+Work\+Queue.\+h$>$}



Inheritance diagram for Ogre\+:\+:Work\+Queue\+:\+:Response\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=235pt]{struct_ogre_1_1_work_queue_1_1_response__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{struct_ogre_1_1_work_queue_1_1_response_ac52fe09b4fd27a19612002f840a4e4fa}{Response} (const \hyperlink{class_ogre_1_1_work_queue_1_1_request}{Request} $\ast$rq, bool success, const \hyperlink{class_ogre_1_1_any}{Any} \&data, const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&msg=\hyperlink{group___general_gad842a4b416bd2f3245d2b44826a0aedc}{B\+L\+A\+N\+K\+S\+T\+R\+I\+NG})
\item 
\hyperlink{struct_ogre_1_1_work_queue_1_1_response_a684441758baf2168db5a4aab31d8d7d4}{$\sim$\+Response} ()
\item 
void \hyperlink{struct_ogre_1_1_work_queue_1_1_response_a29ac9eeab02d77b028ec3a3dd8f7964c}{abort\+Request} ()
\begin{DoxyCompactList}\small\item\em Abort the request. \end{DoxyCompactList}\item 
const \hyperlink{class_ogre_1_1_any}{Any} \& \hyperlink{struct_ogre_1_1_work_queue_1_1_response_a99beffe66389950f8095b7b2065b77bd}{get\+Data} () const
\begin{DoxyCompactList}\small\item\em Return the response data (user defined, only valid on success) \end{DoxyCompactList}\item 
const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \& \hyperlink{struct_ogre_1_1_work_queue_1_1_response_a99ae79484c768b0ea7355050a3f22058}{get\+Messages} () const
\begin{DoxyCompactList}\small\item\em Get any diagnostic messages about the process. \end{DoxyCompactList}\item 
const \hyperlink{class_ogre_1_1_work_queue_1_1_request}{Request} $\ast$ \hyperlink{struct_ogre_1_1_work_queue_1_1_response_a50b1db618a6184899ea625b4c6e73417}{get\+Request} () const
\begin{DoxyCompactList}\small\item\em Get the request that this is a response to (NB destruction destroys this) \end{DoxyCompactList}\item 
bool \hyperlink{struct_ogre_1_1_work_queue_1_1_response_ac1a95bd47cb0c88ef582e4b3f5b89f5c}{succeeded} () const
\begin{DoxyCompactList}\small\item\em Return whether this is a successful response. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_ogre_1_1_any}{Any} \hyperlink{struct_ogre_1_1_work_queue_1_1_response_a04980c518c8e22f1f669e6b543a10e20}{m\+Data}
\begin{DoxyCompactList}\small\item\em Data associated with the result of the process. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \hyperlink{struct_ogre_1_1_work_queue_1_1_response_aa79894f8c3badaddc48064f4b35141be}{m\+Messages}
\begin{DoxyCompactList}\small\item\em \hyperlink{class_ogre_1_1_any}{Any} diagnostic messages. \end{DoxyCompactList}\item 
const \hyperlink{class_ogre_1_1_work_queue_1_1_request}{Request} $\ast$ \hyperlink{struct_ogre_1_1_work_queue_1_1_response_afdbe309b03faf1265f97d4891af4d258}{m\+Request}
\begin{DoxyCompactList}\small\item\em Pointer to the request that this response is in relation to. \end{DoxyCompactList}\item 
bool \hyperlink{struct_ogre_1_1_work_queue_1_1_response_abe22e0d3b55dc09fe6ba3e592f7dc321}{m\+Success}
\begin{DoxyCompactList}\small\item\em Whether the work item succeeded or not. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
General purpose response structure. 

\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{struct_ogre_1_1_work_queue_1_1_response_ac52fe09b4fd27a19612002f840a4e4fa}\label{struct_ogre_1_1_work_queue_1_1_response_ac52fe09b4fd27a19612002f840a4e4fa}} 
\index{Ogre\+::\+Work\+Queue\+::\+Response@{Ogre\+::\+Work\+Queue\+::\+Response}!Response@{Response}}
\index{Response@{Response}!Ogre\+::\+Work\+Queue\+::\+Response@{Ogre\+::\+Work\+Queue\+::\+Response}}
\subsubsection{\texorpdfstring{Response()}{Response()}}
{\footnotesize\ttfamily Ogre\+::\+Work\+Queue\+::\+Response\+::\+Response (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_work_queue_1_1_request}{Request} $\ast$}]{rq,  }\item[{bool}]{success,  }\item[{const \hyperlink{class_ogre_1_1_any}{Any} \&}]{data,  }\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{msg = {\ttfamily \hyperlink{group___general_gad842a4b416bd2f3245d2b44826a0aedc}{B\+L\+A\+N\+K\+S\+T\+R\+I\+NG}} }\end{DoxyParamCaption})}

\mbox{\Hypertarget{struct_ogre_1_1_work_queue_1_1_response_a684441758baf2168db5a4aab31d8d7d4}\label{struct_ogre_1_1_work_queue_1_1_response_a684441758baf2168db5a4aab31d8d7d4}} 
\index{Ogre\+::\+Work\+Queue\+::\+Response@{Ogre\+::\+Work\+Queue\+::\+Response}!````~Response@{$\sim$\+Response}}
\index{````~Response@{$\sim$\+Response}!Ogre\+::\+Work\+Queue\+::\+Response@{Ogre\+::\+Work\+Queue\+::\+Response}}
\subsubsection{\texorpdfstring{$\sim$\+Response()}{~Response()}}
{\footnotesize\ttfamily Ogre\+::\+Work\+Queue\+::\+Response\+::$\sim$\+Response (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



\subsection{Member Function Documentation}
\mbox{\Hypertarget{struct_ogre_1_1_work_queue_1_1_response_a50b1db618a6184899ea625b4c6e73417}\label{struct_ogre_1_1_work_queue_1_1_response_a50b1db618a6184899ea625b4c6e73417}} 
\index{Ogre\+::\+Work\+Queue\+::\+Response@{Ogre\+::\+Work\+Queue\+::\+Response}!get\+Request@{get\+Request}}
\index{get\+Request@{get\+Request}!Ogre\+::\+Work\+Queue\+::\+Response@{Ogre\+::\+Work\+Queue\+::\+Response}}
\subsubsection{\texorpdfstring{get\+Request()}{getRequest()}}
{\footnotesize\ttfamily const \hyperlink{class_ogre_1_1_work_queue_1_1_request}{Request}$\ast$ Ogre\+::\+Work\+Queue\+::\+Response\+::get\+Request (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



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



Referenced by Ogre\+::\+Work\+Queue\+::\+Response\+Handler\+::can\+Handle\+Response().

\mbox{\Hypertarget{struct_ogre_1_1_work_queue_1_1_response_ac1a95bd47cb0c88ef582e4b3f5b89f5c}\label{struct_ogre_1_1_work_queue_1_1_response_ac1a95bd47cb0c88ef582e4b3f5b89f5c}} 
\index{Ogre\+::\+Work\+Queue\+::\+Response@{Ogre\+::\+Work\+Queue\+::\+Response}!succeeded@{succeeded}}
\index{succeeded@{succeeded}!Ogre\+::\+Work\+Queue\+::\+Response@{Ogre\+::\+Work\+Queue\+::\+Response}}
\subsubsection{\texorpdfstring{succeeded()}{succeeded()}}
{\footnotesize\ttfamily bool Ogre\+::\+Work\+Queue\+::\+Response\+::succeeded (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Return whether this is a successful response. 

\mbox{\Hypertarget{struct_ogre_1_1_work_queue_1_1_response_a99ae79484c768b0ea7355050a3f22058}\label{struct_ogre_1_1_work_queue_1_1_response_a99ae79484c768b0ea7355050a3f22058}} 
\index{Ogre\+::\+Work\+Queue\+::\+Response@{Ogre\+::\+Work\+Queue\+::\+Response}!get\+Messages@{get\+Messages}}
\index{get\+Messages@{get\+Messages}!Ogre\+::\+Work\+Queue\+::\+Response@{Ogre\+::\+Work\+Queue\+::\+Response}}
\subsubsection{\texorpdfstring{get\+Messages()}{getMessages()}}
{\footnotesize\ttfamily const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}\& Ogre\+::\+Work\+Queue\+::\+Response\+::get\+Messages (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get any diagnostic messages about the process. 

\mbox{\Hypertarget{struct_ogre_1_1_work_queue_1_1_response_a99beffe66389950f8095b7b2065b77bd}\label{struct_ogre_1_1_work_queue_1_1_response_a99beffe66389950f8095b7b2065b77bd}} 
\index{Ogre\+::\+Work\+Queue\+::\+Response@{Ogre\+::\+Work\+Queue\+::\+Response}!get\+Data@{get\+Data}}
\index{get\+Data@{get\+Data}!Ogre\+::\+Work\+Queue\+::\+Response@{Ogre\+::\+Work\+Queue\+::\+Response}}
\subsubsection{\texorpdfstring{get\+Data()}{getData()}}
{\footnotesize\ttfamily const \hyperlink{class_ogre_1_1_any}{Any}\& Ogre\+::\+Work\+Queue\+::\+Response\+::get\+Data (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



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

\mbox{\Hypertarget{struct_ogre_1_1_work_queue_1_1_response_a29ac9eeab02d77b028ec3a3dd8f7964c}\label{struct_ogre_1_1_work_queue_1_1_response_a29ac9eeab02d77b028ec3a3dd8f7964c}} 
\index{Ogre\+::\+Work\+Queue\+::\+Response@{Ogre\+::\+Work\+Queue\+::\+Response}!abort\+Request@{abort\+Request}}
\index{abort\+Request@{abort\+Request}!Ogre\+::\+Work\+Queue\+::\+Response@{Ogre\+::\+Work\+Queue\+::\+Response}}
\subsubsection{\texorpdfstring{abort\+Request()}{abortRequest()}}
{\footnotesize\ttfamily void Ogre\+::\+Work\+Queue\+::\+Response\+::abort\+Request (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Abort the request. 



References Ogre\+::\+Work\+Queue\+::\+Request\+::abort\+Request(), and Ogre\+::\+Any\+::reset().



\subsection{Member Data Documentation}
\mbox{\Hypertarget{struct_ogre_1_1_work_queue_1_1_response_afdbe309b03faf1265f97d4891af4d258}\label{struct_ogre_1_1_work_queue_1_1_response_afdbe309b03faf1265f97d4891af4d258}} 
\index{Ogre\+::\+Work\+Queue\+::\+Response@{Ogre\+::\+Work\+Queue\+::\+Response}!m\+Request@{m\+Request}}
\index{m\+Request@{m\+Request}!Ogre\+::\+Work\+Queue\+::\+Response@{Ogre\+::\+Work\+Queue\+::\+Response}}
\subsubsection{\texorpdfstring{m\+Request}{mRequest}}
{\footnotesize\ttfamily const \hyperlink{class_ogre_1_1_work_queue_1_1_request}{Request}$\ast$ Ogre\+::\+Work\+Queue\+::\+Response\+::m\+Request}



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

\mbox{\Hypertarget{struct_ogre_1_1_work_queue_1_1_response_abe22e0d3b55dc09fe6ba3e592f7dc321}\label{struct_ogre_1_1_work_queue_1_1_response_abe22e0d3b55dc09fe6ba3e592f7dc321}} 
\index{Ogre\+::\+Work\+Queue\+::\+Response@{Ogre\+::\+Work\+Queue\+::\+Response}!m\+Success@{m\+Success}}
\index{m\+Success@{m\+Success}!Ogre\+::\+Work\+Queue\+::\+Response@{Ogre\+::\+Work\+Queue\+::\+Response}}
\subsubsection{\texorpdfstring{m\+Success}{mSuccess}}
{\footnotesize\ttfamily bool Ogre\+::\+Work\+Queue\+::\+Response\+::m\+Success}



Whether the work item succeeded or not. 

\mbox{\Hypertarget{struct_ogre_1_1_work_queue_1_1_response_aa79894f8c3badaddc48064f4b35141be}\label{struct_ogre_1_1_work_queue_1_1_response_aa79894f8c3badaddc48064f4b35141be}} 
\index{Ogre\+::\+Work\+Queue\+::\+Response@{Ogre\+::\+Work\+Queue\+::\+Response}!m\+Messages@{m\+Messages}}
\index{m\+Messages@{m\+Messages}!Ogre\+::\+Work\+Queue\+::\+Response@{Ogre\+::\+Work\+Queue\+::\+Response}}
\subsubsection{\texorpdfstring{m\+Messages}{mMessages}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} Ogre\+::\+Work\+Queue\+::\+Response\+::m\+Messages}



\hyperlink{class_ogre_1_1_any}{Any} diagnostic messages. 

\mbox{\Hypertarget{struct_ogre_1_1_work_queue_1_1_response_a04980c518c8e22f1f669e6b543a10e20}\label{struct_ogre_1_1_work_queue_1_1_response_a04980c518c8e22f1f669e6b543a10e20}} 
\index{Ogre\+::\+Work\+Queue\+::\+Response@{Ogre\+::\+Work\+Queue\+::\+Response}!m\+Data@{m\+Data}}
\index{m\+Data@{m\+Data}!Ogre\+::\+Work\+Queue\+::\+Response@{Ogre\+::\+Work\+Queue\+::\+Response}}
\subsubsection{\texorpdfstring{m\+Data}{mData}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_any}{Any} Ogre\+::\+Work\+Queue\+::\+Response\+::m\+Data}



Data associated with the result of the process. 



The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
\hyperlink{_ogre_work_queue_8h}{Ogre\+Work\+Queue.\+h}\end{DoxyCompactItemize}
