\hypertarget{classXrlJobQueue}{
\section{XrlJobQueue Class Reference}
\label{classXrlJobQueue}\index{XrlJobQueue@{XrlJobQueue}}
}


Class for buffering and dispatching XRLs.  




{\ttfamily \#include $<$common.hh$>$}

Inheritance diagram for XrlJobQueue:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=3.000000cm]{classXrlJobQueue}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classXrlJobQueue_aaf22d0909eb039a15cbdc698bb6b61a6}{
typedef \hyperlink{classref__ptr}{ref\_\-ptr}$<$ \hyperlink{classXrlJobBase}{XrlJobBase} $>$ {\bfseries Job}}
\label{classXrlJobQueue_aaf22d0909eb039a15cbdc698bb6b61a6}

\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classXrlJobQueue_a8ebabeb230d396ae899d677a1a87f4ed}{
\hyperlink{classXrlJobQueue_a8ebabeb230d396ae899d677a1a87f4ed}{XrlJobQueue} (\hyperlink{classEventLoop}{EventLoop} \&e, const string \&finder\_\-host, uint16\_\-t finder\_\-port, const string \&tgtname)}
\label{classXrlJobQueue_a8ebabeb230d396ae899d677a1a87f4ed}

\begin{DoxyCompactList}\small\item\em \hyperlink{classXrl}{Xrl} Job Queue. \item\end{DoxyCompactList}\item 
int \hyperlink{classXrlJobQueue_aaa10f1b613619228a48240a7d41a6f66}{startup} ()
\begin{DoxyCompactList}\small\item\em Start service. \item\end{DoxyCompactList}\item 
int \hyperlink{classXrlJobQueue_a5f5a1b5ad3d86d841a35c13939cc417a}{shutdown} ()
\begin{DoxyCompactList}\small\item\em \hyperlink{classShutdown}{Shutdown} service. \item\end{DoxyCompactList}\item 
\hypertarget{classXrlJobQueue_ae509c8f33cbb555ab21e00edddfa75e2}{
void {\bfseries dispatch\_\-complete} (const \hyperlink{classXrlError}{XrlError} \&xe, const \hyperlink{classXrlJobBase}{XrlJobBase} $\ast$cmd)}
\label{classXrlJobQueue_ae509c8f33cbb555ab21e00edddfa75e2}

\item 
\hypertarget{classXrlJobQueue_ac0895d4d10b952fb5724755e544615df}{
\hyperlink{classXrlSender}{XrlSender} $\ast$ {\bfseries sender} ()}
\label{classXrlJobQueue_ac0895d4d10b952fb5724755e544615df}

\item 
\hypertarget{classXrlJobQueue_a3f44ecc047fd20e535f5a02268a50c5a}{
const string \& {\bfseries target} () const }
\label{classXrlJobQueue_a3f44ecc047fd20e535f5a02268a50c5a}

\item 
\hypertarget{classXrlJobQueue_a0a15a1cb295ab108f54490f116be54bf}{
void {\bfseries enqueue} (const \hyperlink{classref__ptr}{Job} \&cmd)}
\label{classXrlJobQueue_a0a15a1cb295ab108f54490f116be54bf}

\end{DoxyCompactItemize}
\subsection*{Protected Member Functions}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classXrlJobQueue_a1e19ca75943b32299dff51730c761f15}{
bool {\bfseries xrl\_\-router\_\-ready\_\-poll} ()}
\label{classXrlJobQueue_a1e19ca75943b32299dff51730c761f15}

\item 
\hypertarget{classXrlJobQueue_a72b77dfc402ee7d03cad55b58d7eb1e4}{
void {\bfseries process\_\-next\_\-job} ()}
\label{classXrlJobQueue_a72b77dfc402ee7d03cad55b58d7eb1e4}

\end{DoxyCompactItemize}
\subsection*{Protected Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classXrlJobQueue_ab0adebe99eff56a5a10ee2efd1bf257c}{
\hyperlink{classEventLoop}{EventLoop} \& {\bfseries \_\-e}}
\label{classXrlJobQueue_ab0adebe99eff56a5a10ee2efd1bf257c}

\item 
\hypertarget{classXrlJobQueue_a9585b32a988de7325e829c7ee55a8edf}{
string {\bfseries \_\-fhost}}
\label{classXrlJobQueue_a9585b32a988de7325e829c7ee55a8edf}

\item 
\hypertarget{classXrlJobQueue_ae60dea9d7e0994bcf1b5f8ebe9109e43}{
uint16\_\-t {\bfseries \_\-fport}}
\label{classXrlJobQueue_ae60dea9d7e0994bcf1b5f8ebe9109e43}

\item 
\hypertarget{classXrlJobQueue_a6b6ac66c2470ae33eda17fe8fb9852e2}{
string {\bfseries \_\-tgt}}
\label{classXrlJobQueue_a6b6ac66c2470ae33eda17fe8fb9852e2}

\item 
\hypertarget{classXrlJobQueue_a360b242c79928b16599378c02a5eda75}{
list$<$ \hyperlink{classref__ptr}{Job} $>$ {\bfseries \_\-jobs}}
\label{classXrlJobQueue_a360b242c79928b16599378c02a5eda75}

\item 
\hypertarget{classXrlJobQueue_a04649edf61c72f9f9514e3dbc1d87738}{
\hyperlink{classXrlStdRouter}{XrlStdRouter} $\ast$ {\bfseries \_\-rtr}}
\label{classXrlJobQueue_a04649edf61c72f9f9514e3dbc1d87738}

\item 
\hypertarget{classXrlJobQueue_a9c3d0a91e7bb93ac39c8c7e8c3720bf2}{
\hyperlink{classXorpTimer}{XorpTimer} {\bfseries \_\-rtr\_\-poll}}
\label{classXrlJobQueue_a9c3d0a91e7bb93ac39c8c7e8c3720bf2}

\item 
\hypertarget{classXrlJobQueue_a36b550ff545fea70256594f025ae6a53}{
uint32\_\-t {\bfseries \_\-rtr\_\-poll\_\-cnt}}
\label{classXrlJobQueue_a36b550ff545fea70256594f025ae6a53}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
Class for buffering and dispatching XRLs. 

\subsection{Member Function Documentation}
\hypertarget{classXrlJobQueue_a5f5a1b5ad3d86d841a35c13939cc417a}{
\index{XrlJobQueue@{XrlJobQueue}!shutdown@{shutdown}}
\index{shutdown@{shutdown}!XrlJobQueue@{XrlJobQueue}}
\subsubsection[{shutdown}]{\setlength{\rightskip}{0pt plus 5cm}int XrlJobQueue::shutdown (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}virtual\mbox{]}}}}
\label{classXrlJobQueue_a5f5a1b5ad3d86d841a35c13939cc417a}


\hyperlink{classShutdown}{Shutdown} service. 

Service should transition from SERVICE\_\-RUNNING to SERVICE\_\-SHUTTING\_\-DOWN immediately and onto SERVICE\_\-SHUTDOWN or SERVICE\_\-FAILED in \hyperlink{protocolthe-p}{the} near future.

\begin{DoxyReturn}{Returns}
XORP\_\-OK on success, otherwise XORP\_\-ERROR. 
\end{DoxyReturn}


Implements \hyperlink{classServiceBase_a6ad34506fd5a446d5667abcb2e1b593b}{ServiceBase}.

\hypertarget{classXrlJobQueue_aaa10f1b613619228a48240a7d41a6f66}{
\index{XrlJobQueue@{XrlJobQueue}!startup@{startup}}
\index{startup@{startup}!XrlJobQueue@{XrlJobQueue}}
\subsubsection[{startup}]{\setlength{\rightskip}{0pt plus 5cm}int XrlJobQueue::startup (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}virtual\mbox{]}}}}
\label{classXrlJobQueue_aaa10f1b613619228a48240a7d41a6f66}


Start service. 

Service should transition from SERVICE\_\-READY to SERVICE\_\-STARTING immediately and onto SERVICE\_\-RUNNING or SERVICE\_\-FAILED in \hyperlink{protocolthe-p}{the} near future.

\begin{DoxyReturn}{Returns}
XORP\_\-OK on success, otherwise XORP\_\-ERROR. 
\end{DoxyReturn}


Implements \hyperlink{classServiceBase_a791755872b2056ddd82a2f00904c7d2b}{ServiceBase}.



The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
\item 
/home/greearb/git/xorp.ct.github/xorp/rip/tools/common.hh\item 
/home/greearb/git/xorp.ct.github/xorp/rip/tools/common.cc\end{DoxyCompactItemize}
