\hypertarget{class_ogre_1_1_work_queue_1_1_request}{}\doxysection{Ogre\+::Work\+Queue\+::Request Class Reference}
\label{class_ogre_1_1_work_queue_1_1_request}\index{Ogre::WorkQueue::Request@{Ogre::WorkQueue::Request}}


General purpose request structure.  




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



Inheritance diagram for Ogre\+::Work\+Queue\+::Request\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=228pt]{class_ogre_1_1_work_queue_1_1_request__inherit__graph}
\end{center}
\end{figure}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{class_ogre_1_1_work_queue_1_1_request_af4747a039d3166c38a0f0646f87d10f4}{Request}} (\mbox{\hyperlink{namespace_ogre_aa8263b218e7d187ad5ef03a73a6ad7fd}{uint16}} channel, \mbox{\hyperlink{namespace_ogre_aa8263b218e7d187ad5ef03a73a6ad7fd}{uint16}} rtype, const \mbox{\hyperlink{class_ogre_1_1_any}{Any}} \&r\+Data, \mbox{\hyperlink{namespace_ogre_a119732ea9d1e88bbddc47b4ac0fa21cb}{uint8}} retry, \mbox{\hyperlink{class_ogre_1_1_work_queue_a1908257e726af6caa80f1a6cd5682d76}{Request\+ID}} rid)
\begin{DoxyCompactList}\small\item\em Constructor. \end{DoxyCompactList}\item 
\mbox{\hyperlink{class_ogre_1_1_work_queue_1_1_request_abc6f573b83b9828f994bca37720bfa1d}{$\sim$\+Request}} ()
\item 
void \mbox{\hyperlink{class_ogre_1_1_work_queue_1_1_request_ab7f8cc092ee42ae31d9ae0e31e597afd}{abort\+Request}} () const
\begin{DoxyCompactList}\small\item\em Set the abort flag. \end{DoxyCompactList}\item 
bool \mbox{\hyperlink{class_ogre_1_1_work_queue_1_1_request_a787e9f136393d10910474fbb433bf05a}{get\+Aborted}} () const
\begin{DoxyCompactList}\small\item\em Get the abort flag. \end{DoxyCompactList}\item 
\mbox{\hyperlink{namespace_ogre_aa8263b218e7d187ad5ef03a73a6ad7fd}{uint16}} \mbox{\hyperlink{class_ogre_1_1_work_queue_1_1_request_a060279eea8f56ee894b5fcd821938b2d}{get\+Channel}} () const
\begin{DoxyCompactList}\small\item\em Get the request channel (top level categorisation) \end{DoxyCompactList}\item 
const \mbox{\hyperlink{class_ogre_1_1_any}{Any}} \& \mbox{\hyperlink{class_ogre_1_1_work_queue_1_1_request_a18455c6b2c43468786656b480592c4fc}{get\+Data}} () const
\begin{DoxyCompactList}\small\item\em Get the user details of this request. \end{DoxyCompactList}\item 
\mbox{\hyperlink{class_ogre_1_1_work_queue_a1908257e726af6caa80f1a6cd5682d76}{Request\+ID}} \mbox{\hyperlink{class_ogre_1_1_work_queue_1_1_request_a9ada381b6f00e875b2e6b00e6ea9e205}{get\+ID}} () const
\begin{DoxyCompactList}\small\item\em Get the identifier of this request. \end{DoxyCompactList}\item 
\mbox{\hyperlink{namespace_ogre_a119732ea9d1e88bbddc47b4ac0fa21cb}{uint8}} \mbox{\hyperlink{class_ogre_1_1_work_queue_1_1_request_a43e13c709cfee50891c7b03ff99073fc}{get\+Retry\+Count}} () const
\begin{DoxyCompactList}\small\item\em Get the remaining retry count. \end{DoxyCompactList}\item 
\mbox{\hyperlink{namespace_ogre_aa8263b218e7d187ad5ef03a73a6ad7fd}{uint16}} \mbox{\hyperlink{class_ogre_1_1_work_queue_1_1_request_a702f89b4a3f1e8aa383be5894b2ed29c}{get\+Type}} () const
\begin{DoxyCompactList}\small\item\em Get the type of this request within the given channel. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Friends}
\begin{DoxyCompactItemize}
\item 
class \mbox{\hyperlink{class_ogre_1_1_work_queue_1_1_request_afc5a5e65333384e477426c2f77353b28}{Work\+Queue}}
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
General purpose request structure. 

\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_ogre_1_1_work_queue_1_1_request_af4747a039d3166c38a0f0646f87d10f4}\label{class_ogre_1_1_work_queue_1_1_request_af4747a039d3166c38a0f0646f87d10f4}} 
\index{Ogre::WorkQueue::Request@{Ogre::WorkQueue::Request}!Request@{Request}}
\index{Request@{Request}!Ogre::WorkQueue::Request@{Ogre::WorkQueue::Request}}
\doxysubsubsection{\texorpdfstring{Request()}{Request()}}
{\footnotesize\ttfamily Ogre\+::\+Work\+Queue\+::\+Request\+::\+Request (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_aa8263b218e7d187ad5ef03a73a6ad7fd}{uint16}}}]{channel,  }\item[{\mbox{\hyperlink{namespace_ogre_aa8263b218e7d187ad5ef03a73a6ad7fd}{uint16}}}]{rtype,  }\item[{const \mbox{\hyperlink{class_ogre_1_1_any}{Any}} \&}]{r\+Data,  }\item[{\mbox{\hyperlink{namespace_ogre_a119732ea9d1e88bbddc47b4ac0fa21cb}{uint8}}}]{retry,  }\item[{\mbox{\hyperlink{class_ogre_1_1_work_queue_a1908257e726af6caa80f1a6cd5682d76}{Request\+ID}}}]{rid }\end{DoxyParamCaption})}



Constructor. 

\mbox{\Hypertarget{class_ogre_1_1_work_queue_1_1_request_abc6f573b83b9828f994bca37720bfa1d}\label{class_ogre_1_1_work_queue_1_1_request_abc6f573b83b9828f994bca37720bfa1d}} 
\index{Ogre::WorkQueue::Request@{Ogre::WorkQueue::Request}!````~Request@{$\sim$Request}}
\index{````~Request@{$\sim$Request}!Ogre::WorkQueue::Request@{Ogre::WorkQueue::Request}}
\doxysubsubsection{\texorpdfstring{$\sim$Request()}{~Request()}}
{\footnotesize\ttfamily Ogre\+::\+Work\+Queue\+::\+Request\+::$\sim$\+Request (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_work_queue_1_1_request_ab7f8cc092ee42ae31d9ae0e31e597afd}\label{class_ogre_1_1_work_queue_1_1_request_ab7f8cc092ee42ae31d9ae0e31e597afd}} 
\index{Ogre::WorkQueue::Request@{Ogre::WorkQueue::Request}!abortRequest@{abortRequest}}
\index{abortRequest@{abortRequest}!Ogre::WorkQueue::Request@{Ogre::WorkQueue::Request}}
\doxysubsubsection{\texorpdfstring{abortRequest()}{abortRequest()}}
{\footnotesize\ttfamily void Ogre\+::\+Work\+Queue\+::\+Request\+::abort\+Request (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Set the abort flag. 



Referenced by Ogre\+::\+Work\+Queue\+::\+Response\+::abort\+Request().

\mbox{\Hypertarget{class_ogre_1_1_work_queue_1_1_request_a060279eea8f56ee894b5fcd821938b2d}\label{class_ogre_1_1_work_queue_1_1_request_a060279eea8f56ee894b5fcd821938b2d}} 
\index{Ogre::WorkQueue::Request@{Ogre::WorkQueue::Request}!getChannel@{getChannel}}
\index{getChannel@{getChannel}!Ogre::WorkQueue::Request@{Ogre::WorkQueue::Request}}
\doxysubsubsection{\texorpdfstring{getChannel()}{getChannel()}}
{\footnotesize\ttfamily \mbox{\hyperlink{namespace_ogre_aa8263b218e7d187ad5ef03a73a6ad7fd}{uint16}} Ogre\+::\+Work\+Queue\+::\+Request\+::get\+Channel (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the request channel (top level categorisation) 

\mbox{\Hypertarget{class_ogre_1_1_work_queue_1_1_request_a702f89b4a3f1e8aa383be5894b2ed29c}\label{class_ogre_1_1_work_queue_1_1_request_a702f89b4a3f1e8aa383be5894b2ed29c}} 
\index{Ogre::WorkQueue::Request@{Ogre::WorkQueue::Request}!getType@{getType}}
\index{getType@{getType}!Ogre::WorkQueue::Request@{Ogre::WorkQueue::Request}}
\doxysubsubsection{\texorpdfstring{getType()}{getType()}}
{\footnotesize\ttfamily \mbox{\hyperlink{namespace_ogre_aa8263b218e7d187ad5ef03a73a6ad7fd}{uint16}} Ogre\+::\+Work\+Queue\+::\+Request\+::get\+Type (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the type of this request within the given channel. 

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



Get the user details of this request. 

\mbox{\Hypertarget{class_ogre_1_1_work_queue_1_1_request_a43e13c709cfee50891c7b03ff99073fc}\label{class_ogre_1_1_work_queue_1_1_request_a43e13c709cfee50891c7b03ff99073fc}} 
\index{Ogre::WorkQueue::Request@{Ogre::WorkQueue::Request}!getRetryCount@{getRetryCount}}
\index{getRetryCount@{getRetryCount}!Ogre::WorkQueue::Request@{Ogre::WorkQueue::Request}}
\doxysubsubsection{\texorpdfstring{getRetryCount()}{getRetryCount()}}
{\footnotesize\ttfamily \mbox{\hyperlink{namespace_ogre_a119732ea9d1e88bbddc47b4ac0fa21cb}{uint8}} Ogre\+::\+Work\+Queue\+::\+Request\+::get\+Retry\+Count (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the remaining retry count. 

\mbox{\Hypertarget{class_ogre_1_1_work_queue_1_1_request_a9ada381b6f00e875b2e6b00e6ea9e205}\label{class_ogre_1_1_work_queue_1_1_request_a9ada381b6f00e875b2e6b00e6ea9e205}} 
\index{Ogre::WorkQueue::Request@{Ogre::WorkQueue::Request}!getID@{getID}}
\index{getID@{getID}!Ogre::WorkQueue::Request@{Ogre::WorkQueue::Request}}
\doxysubsubsection{\texorpdfstring{getID()}{getID()}}
{\footnotesize\ttfamily \mbox{\hyperlink{class_ogre_1_1_work_queue_a1908257e726af6caa80f1a6cd5682d76}{Request\+ID}} Ogre\+::\+Work\+Queue\+::\+Request\+::get\+ID (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the identifier of this request. 

\mbox{\Hypertarget{class_ogre_1_1_work_queue_1_1_request_a787e9f136393d10910474fbb433bf05a}\label{class_ogre_1_1_work_queue_1_1_request_a787e9f136393d10910474fbb433bf05a}} 
\index{Ogre::WorkQueue::Request@{Ogre::WorkQueue::Request}!getAborted@{getAborted}}
\index{getAborted@{getAborted}!Ogre::WorkQueue::Request@{Ogre::WorkQueue::Request}}
\doxysubsubsection{\texorpdfstring{getAborted()}{getAborted()}}
{\footnotesize\ttfamily bool Ogre\+::\+Work\+Queue\+::\+Request\+::get\+Aborted (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the abort flag. 



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



\doxysubsection{Friends And Related Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_work_queue_1_1_request_afc5a5e65333384e477426c2f77353b28}\label{class_ogre_1_1_work_queue_1_1_request_afc5a5e65333384e477426c2f77353b28}} 
\index{Ogre::WorkQueue::Request@{Ogre::WorkQueue::Request}!WorkQueue@{WorkQueue}}
\index{WorkQueue@{WorkQueue}!Ogre::WorkQueue::Request@{Ogre::WorkQueue::Request}}
\doxysubsubsection{\texorpdfstring{WorkQueue}{WorkQueue}}
{\footnotesize\ttfamily friend class \mbox{\hyperlink{class_ogre_1_1_work_queue}{Work\+Queue}}\hspace{0.3cm}{\ttfamily [friend]}}



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