\hypertarget{classXrlError}{
\section{XrlError Class Reference}
\label{classXrlError}\index{XrlError@{XrlError}}
}


All known error codes arising from XRL dispatches.  




{\ttfamily \#include $<$xrl\_\-error.hh$>$}

\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
XrlErrorCode \hyperlink{classXrlError_a4c3856b23dc0296e9c2c45d5dcea99bb}{error\_\-code} () const 
\item 
\hypertarget{classXrlError_a3d1b3d638be3a608a589549e56cb6b0f}{
bool {\bfseries isOK} () const }
\label{classXrlError_a3d1b3d638be3a608a589549e56cb6b0f}

\item 
const char $\ast$ \hyperlink{classXrlError_a4c6a4e7a43e6a4306d423d51f39ec545}{error\_\-msg} () const 
\item 
const string \& \hyperlink{classXrlError_a685ec8ac8a751659fb925877af501cb4}{note} () const 
\item 
string \hyperlink{classXrlError_ab7d6101e131018ce7d2fba138e226413}{str} () const 
\item 
\hypertarget{classXrlError_abc07eef0667c3879377b55852d74cb89}{
{\bfseries XrlError} (XrlErrorCode error\_\-code, const string \&note=\char`\"{}\char`\"{})}
\label{classXrlError_abc07eef0667c3879377b55852d74cb89}

\item 
\hypertarget{classXrlError_addf3cd1699a4740d00fe151ab2c51a29}{
{\bfseries XrlError} (const \hyperlink{classXrlError}{XrlError} \&xe)}
\label{classXrlError_addf3cd1699a4740d00fe151ab2c51a29}

\item 
\hypertarget{classXrlError_a4106912516f82bb711277327393abd21}{
{\bfseries XrlError} (const \hyperlink{classXrlErrlet}{XrlErrlet} \&x, const string \&note=\char`\"{}\char`\"{})}
\label{classXrlError_a4106912516f82bb711277327393abd21}

\item 
\hypertarget{classXrlError_a90f25b8680bbc778dba8ba94c892fade}{
{\bfseries XrlError} (const \hyperlink{classXrlErrlet}{XrlErrlet} $\ast$)}
\label{classXrlError_a90f25b8680bbc778dba8ba94c892fade}

\end{DoxyCompactItemize}
\subsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classXrlError_a4c5f9676fba7fbf8597ae8278e3006ed}{
static const \hyperlink{classXrlError}{XrlError} \& \hyperlink{classXrlError_a4c5f9676fba7fbf8597ae8278e3006ed}{OKAY} ()}
\label{classXrlError_a4c5f9676fba7fbf8597ae8278e3006ed}

\begin{DoxyCompactList}\small\item\em The value that should be returned by functions whose execution completed normally. \item\end{DoxyCompactList}\item 
\hypertarget{classXrlError_a71a88bd33c1ffafe240fd41621c497de}{
static const \hyperlink{classXrlError}{XrlError} \& \hyperlink{classXrlError_a71a88bd33c1ffafe240fd41621c497de}{BAD\_\-ARGS} ()}
\label{classXrlError_a71a88bd33c1ffafe240fd41621c497de}

\begin{DoxyCompactList}\small\item\em The value that should be returned when \hyperlink{protocolthe-p}{the} arguments in an XRL do not match what \hyperlink{protocolthe-p}{the} receiver expected. \item\end{DoxyCompactList}\item 
\hypertarget{classXrlError_a8bfb8f557244cf8802bd1331f3ad03c3}{
static const \hyperlink{classXrlError}{XrlError} \& \hyperlink{classXrlError_a8bfb8f557244cf8802bd1331f3ad03c3}{COMMAND\_\-FAILED} ()}
\label{classXrlError_a8bfb8f557244cf8802bd1331f3ad03c3}

\begin{DoxyCompactList}\small\item\em The value that should be returned when \hyperlink{protocolthe-p}{the} command cannot be executed by \hyperlink{classXrl}{Xrl} Target. \item\end{DoxyCompactList}\item 
\hypertarget{classXrlError_aa6bd2949f43d473616f93eb53c5e387d}{
static const \hyperlink{classXrlError}{XrlError} \& \hyperlink{classXrlError_aa6bd2949f43d473616f93eb53c5e387d}{NO\_\-FINDER} ()}
\label{classXrlError_aa6bd2949f43d473616f93eb53c5e387d}

\begin{DoxyCompactList}\small\item\em The \hyperlink{classXrl}{Xrl} \hyperlink{classFinder}{Finder} process is not running or not ready to resolve \hyperlink{classXrl}{Xrl} target names. \item\end{DoxyCompactList}\item 
\hypertarget{classXrlError_a9ae8d68245c0499ccf09b006fb6f058b}{
static const \hyperlink{classXrlError}{XrlError} \& \hyperlink{classXrlError_a9ae8d68245c0499ccf09b006fb6f058b}{RESOLVE\_\-FAILED} ()}
\label{classXrlError_a9ae8d68245c0499ccf09b006fb6f058b}

\begin{DoxyCompactList}\small\item\em Returned when an XRL cannot be dispatched because \hyperlink{protocolthe-p}{the} target name is not registered in \hyperlink{protocolthe-p}{the} system. \item\end{DoxyCompactList}\item 
\hypertarget{classXrlError_a78da799154448ce0ae6c62411ff11e54}{
static const \hyperlink{classXrlError}{XrlError} \& \hyperlink{classXrlError_a78da799154448ce0ae6c62411ff11e54}{NO\_\-SUCH\_\-METHOD} ()}
\label{classXrlError_a78da799154448ce0ae6c62411ff11e54}

\begin{DoxyCompactList}\small\item\em Returned when \hyperlink{protocolthe-p}{the} method within \hyperlink{protocolthe-p}{the} XRL is not recognized by \hyperlink{protocolthe-p}{the} receiver. \item\end{DoxyCompactList}\item 
\hypertarget{classXrlError_a1a6d6c2d95de0320b0e077178c13682c}{
static const \hyperlink{classXrlError}{XrlError} \& \hyperlink{classXrlError_a1a6d6c2d95de0320b0e077178c13682c}{SEND\_\-FAILED} ()}
\label{classXrlError_a1a6d6c2d95de0320b0e077178c13682c}

\begin{DoxyCompactList}\small\item\em Returned when \hyperlink{protocolthe-p}{the} underlying XRL transport mechanism fails. \item\end{DoxyCompactList}\item 
\hypertarget{classXrlError_a8b495fade4927faf5903d5915a55efb6}{
static const \hyperlink{classXrlError}{XrlError} \& \hyperlink{classXrlError_a8b495fade4927faf5903d5915a55efb6}{REPLY\_\-TIMED\_\-OUT} ()}
\label{classXrlError_a8b495fade4927faf5903d5915a55efb6}

\begin{DoxyCompactList}\small\item\em Returned when \hyperlink{protocolthe-p}{the} reply is not returned within \hyperlink{protocolthe-p}{the} timeout period of \hyperlink{protocolthe-p}{the} underlying transport mechanism. \item\end{DoxyCompactList}\item 
\hypertarget{classXrlError_a5726dd7834254b3a03f1ccdede74e3f0}{
static const \hyperlink{classXrlError}{XrlError} \& \hyperlink{classXrlError_a5726dd7834254b3a03f1ccdede74e3f0}{SEND\_\-FAILED\_\-TRANSIENT} ()}
\label{classXrlError_a5726dd7834254b3a03f1ccdede74e3f0}

\begin{DoxyCompactList}\small\item\em Returned when \hyperlink{protocolthe-p}{the} underlying XRL transport mechanism fails. \item\end{DoxyCompactList}\item 
static const \hyperlink{classXrlError}{XrlError} \& \hyperlink{classXrlError_a5ca94820c12f8d3615e776d26f92a505}{INTERNAL\_\-ERROR} ()
\begin{DoxyCompactList}\small\item\em An error has occurred within \hyperlink{protocolthe-p}{the} XRL system. \item\end{DoxyCompactList}\item 
static bool \hyperlink{classXrlError_a8ed9b731c7bb2709f2da6741e1787872}{known\_\-code} (uint32\_\-t code)
\end{DoxyCompactItemize}
\subsection*{Protected Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classXrlError_adcb3298cb360a4e5026ec860854f1b00}{
const \hyperlink{classXrlErrlet}{XrlErrlet} $\ast$ {\bfseries \_\-errlet}}
\label{classXrlError_adcb3298cb360a4e5026ec860854f1b00}

\item 
\hypertarget{classXrlError_a3ccdf9fba6d46c73bebd20ac304a9e00}{
string {\bfseries \_\-note}}
\label{classXrlError_a3ccdf9fba6d46c73bebd20ac304a9e00}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
All known error codes arising from XRL dispatches. These include underlying transport, transport location, and invocation failures.

This class can be sub-\/classed to provide a sub-\/set of \hyperlink{protocolthe-p}{the} known errors, and also to append domain specific errors. 

\subsection{Member Function Documentation}
\hypertarget{classXrlError_a4c3856b23dc0296e9c2c45d5dcea99bb}{
\index{XrlError@{XrlError}!error\_\-code@{error\_\-code}}
\index{error\_\-code@{error\_\-code}!XrlError@{XrlError}}
\subsubsection[{error\_\-code}]{\setlength{\rightskip}{0pt plus 5cm}XrlErrorCode XrlError::error\_\-code (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}
\label{classXrlError_a4c3856b23dc0296e9c2c45d5dcea99bb}
\begin{DoxyReturn}{Returns}
\hyperlink{protocolthe-p}{the} unique identifer number associated with error. 
\end{DoxyReturn}
\hypertarget{classXrlError_a4c6a4e7a43e6a4306d423d51f39ec545}{
\index{XrlError@{XrlError}!error\_\-msg@{error\_\-msg}}
\index{error\_\-msg@{error\_\-msg}!XrlError@{XrlError}}
\subsubsection[{error\_\-msg}]{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ XrlError::error\_\-msg (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}
\label{classXrlError_a4c6a4e7a43e6a4306d423d51f39ec545}
\begin{DoxyReturn}{Returns}
string containing textual description of error. 
\end{DoxyReturn}
\hypertarget{classXrlError_a5ca94820c12f8d3615e776d26f92a505}{
\index{XrlError@{XrlError}!INTERNAL\_\-ERROR@{INTERNAL\_\-ERROR}}
\index{INTERNAL\_\-ERROR@{INTERNAL\_\-ERROR}!XrlError@{XrlError}}
\subsubsection[{INTERNAL\_\-ERROR}]{\setlength{\rightskip}{0pt plus 5cm}static const {\bf XrlError}\& XrlError::INTERNAL\_\-ERROR (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}static\mbox{]}}}}
\label{classXrlError_a5ca94820c12f8d3615e776d26f92a505}


An error has occurred within \hyperlink{protocolthe-p}{the} XRL system. 

This is usually a sign of an implementation issue. This error replaces no longer existent errors of CORRUPT\_\-XRL, CORRUPT\_\-XRL\_\-RESPONSE, and BAD\_\-PROTOCOL\_\-VERSION. The note associated with \hyperlink{protocolthe-p}{the} error should contain more information. \hypertarget{classXrlError_a8ed9b731c7bb2709f2da6741e1787872}{
\index{XrlError@{XrlError}!known\_\-code@{known\_\-code}}
\index{known\_\-code@{known\_\-code}!XrlError@{XrlError}}
\subsubsection[{known\_\-code}]{\setlength{\rightskip}{0pt plus 5cm}bool XrlError::known\_\-code (
\begin{DoxyParamCaption}
\item[{uint32\_\-t}]{code}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}static\mbox{]}}}}
\label{classXrlError_a8ed9b731c7bb2709f2da6741e1787872}
\begin{DoxyReturn}{Returns}
true if error\_\-code corresponds to known error. 
\end{DoxyReturn}
\hypertarget{classXrlError_a685ec8ac8a751659fb925877af501cb4}{
\index{XrlError@{XrlError}!note@{note}}
\index{note@{note}!XrlError@{XrlError}}
\subsubsection[{note}]{\setlength{\rightskip}{0pt plus 5cm}const string\& XrlError::note (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classXrlError_a685ec8ac8a751659fb925877af501cb4}
\begin{DoxyReturn}{Returns}
string containing user annotation about source of error (if set). 
\end{DoxyReturn}
\hypertarget{classXrlError_ab7d6101e131018ce7d2fba138e226413}{
\index{XrlError@{XrlError}!str@{str}}
\index{str@{str}!XrlError@{XrlError}}
\subsubsection[{str}]{\setlength{\rightskip}{0pt plus 5cm}string XrlError::str (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classXrlError_ab7d6101e131018ce7d2fba138e226413}
\begin{DoxyReturn}{Returns}
string containing \hyperlink{classXrlError_a4c3856b23dc0296e9c2c45d5dcea99bb}{error\_\-code()}, \hyperlink{classXrlError_a4c6a4e7a43e6a4306d423d51f39ec545}{error\_\-msg()}, and \hyperlink{classXrlError_a685ec8ac8a751659fb925877af501cb4}{note()}. 
\end{DoxyReturn}


The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
\item 
/home/greearb/git/xorp.ct.github/xorp/libxipc/xrl\_\-error.hh\item 
/home/greearb/git/xorp.ct.github/xorp/libxipc/xrl\_\-error.cc\end{DoxyCompactItemize}
