\hypertarget{structXrlCmdError}{
\section{XrlCmdError Struct Reference}
\label{structXrlCmdError}\index{XrlCmdError@{XrlCmdError}}
}


Error codes for user callbacks.  




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

\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hypertarget{structXrlCmdError_a5c147bf470c970a4e630263d064928cb}{
\hyperlink{structXrlCmdError_a5c147bf470c970a4e630263d064928cb}{operator XrlError} () const }
\label{structXrlCmdError_a5c147bf470c970a4e630263d064928cb}

\begin{DoxyCompactList}\small\item\em Convert to \hyperlink{classXrlError}{XrlError} (needed for XRL protocol families). \item\end{DoxyCompactList}\item 
string \hyperlink{structXrlCmdError_afae65c4f3ab46dbdbfb65417a137008e}{str} () const 
\item 
XrlErrorCode \hyperlink{structXrlCmdError_ab92bf742f831117765b53d6ff2792de2}{error\_\-code} () const 
\item 
\hypertarget{structXrlCmdError_a879c14ec1588769d34b2aa71d685ccca}{
bool {\bfseries isOK} () const }
\label{structXrlCmdError_a879c14ec1588769d34b2aa71d685ccca}

\item 
const string \& \hyperlink{structXrlCmdError_a786ab3730c8229963af9ba27e9a13991}{note} () const 
\end{DoxyCompactItemize}
\subsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static const \hyperlink{structXrlCmdError}{XrlCmdError} \& \hyperlink{structXrlCmdError_a29404542500500fe4ce37bfdd8d3cc51}{OKAY} ()
\begin{DoxyCompactList}\small\item\em The default return value. \item\end{DoxyCompactList}\item 
\hypertarget{structXrlCmdError_aa7d027758c1aeaa60112ec33c9750622}{
static const \hyperlink{structXrlCmdError}{XrlCmdError} \hyperlink{structXrlCmdError_aa7d027758c1aeaa60112ec33c9750622}{BAD\_\-ARGS} (const string \&reason=\char`\"{}\char`\"{})}
\label{structXrlCmdError_aa7d027758c1aeaa60112ec33c9750622}

\begin{DoxyCompactList}\small\item\em Return value when \hyperlink{protocolthe-p}{the} method arguments are incorrect. \item\end{DoxyCompactList}\item 
\hypertarget{structXrlCmdError_a2de788040e14d25630f3a4ec7132d180}{
static const \hyperlink{structXrlCmdError}{XrlCmdError} \hyperlink{structXrlCmdError_a2de788040e14d25630f3a4ec7132d180}{COMMAND\_\-FAILED} (const string \&reason=\char`\"{}\char`\"{})}
\label{structXrlCmdError_a2de788040e14d25630f3a4ec7132d180}

\begin{DoxyCompactList}\small\item\em Return value when \hyperlink{protocolthe-p}{the} method could not be execute. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Private Member Functions}
\begin{DoxyCompactItemize}
\item 
\hypertarget{structXrlCmdError_aa883352ea712b199ac310abc98ca5b32}{
{\bfseries XrlCmdError} (const \hyperlink{classXrlError}{XrlError} \&xe)}
\label{structXrlCmdError_aa883352ea712b199ac310abc98ca5b32}

\end{DoxyCompactItemize}
\subsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{structXrlCmdError_a7a4b78ddeaf56dd4fb917126f3209b07}{
\hyperlink{classXrlError}{XrlError} {\bfseries \_\-xrl\_\-error}}
\label{structXrlCmdError_a7a4b78ddeaf56dd4fb917126f3209b07}

\end{DoxyCompactItemize}
\subsection*{Static Private Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{structXrlCmdError_ab1f5ad0d632b053d454c43ff82a67c48}{
static \hyperlink{structXrlCmdError}{XrlCmdError} {\bfseries \_\-xce\_\-ok}}
\label{structXrlCmdError_ab1f5ad0d632b053d454c43ff82a67c48}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
Error codes for user callbacks. These are a subset of \hyperlink{classXrlError}{XrlError} TODO: Passing these on \hyperlink{protocolthe-p}{the} stack wastes resources, and comparing them with generated values != \hyperlink{structXrlCmdError_a29404542500500fe4ce37bfdd8d3cc51}{XrlCmdError::OKAY()}, for instance, is not good for performance or code size either. 

\subsection{Member Function Documentation}
\hypertarget{structXrlCmdError_ab92bf742f831117765b53d6ff2792de2}{
\index{XrlCmdError@{XrlCmdError}!error\_\-code@{error\_\-code}}
\index{error\_\-code@{error\_\-code}!XrlCmdError@{XrlCmdError}}
\subsubsection[{error\_\-code}]{\setlength{\rightskip}{0pt plus 5cm}XrlErrorCode XrlCmdError::error\_\-code (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{structXrlCmdError_ab92bf742f831117765b53d6ff2792de2}
\begin{DoxyReturn}{Returns}
\hyperlink{protocolthe-p}{the} unique identifer number associated with error. 
\end{DoxyReturn}
\hypertarget{structXrlCmdError_a786ab3730c8229963af9ba27e9a13991}{
\index{XrlCmdError@{XrlCmdError}!note@{note}}
\index{note@{note}!XrlCmdError@{XrlCmdError}}
\subsubsection[{note}]{\setlength{\rightskip}{0pt plus 5cm}const string\& XrlCmdError::note (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{structXrlCmdError_a786ab3730c8229963af9ba27e9a13991}
\begin{DoxyReturn}{Returns}
note associated with origin of error (i.e., \hyperlink{protocolthe-p}{the} reason). 
\end{DoxyReturn}
\hypertarget{structXrlCmdError_a29404542500500fe4ce37bfdd8d3cc51}{
\index{XrlCmdError@{XrlCmdError}!OKAY@{OKAY}}
\index{OKAY@{OKAY}!XrlCmdError@{XrlCmdError}}
\subsubsection[{OKAY}]{\setlength{\rightskip}{0pt plus 5cm}static const {\bf XrlCmdError}\& XrlCmdError::OKAY (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline, static\mbox{]}}}}
\label{structXrlCmdError_a29404542500500fe4ce37bfdd8d3cc51}


The default return value. 

Indicates that \hyperlink{protocolthe-p}{the} arguments to \hyperlink{protocolthe-p}{the} XRL method were correct. Inability to perform operation should still return \hyperlink{structXrlCmdError_a29404542500500fe4ce37bfdd8d3cc51}{OKAY()}, but \hyperlink{protocolthe-p}{the} return list should indicate \hyperlink{protocolthe-p}{the} error. \hypertarget{structXrlCmdError_afae65c4f3ab46dbdbfb65417a137008e}{
\index{XrlCmdError@{XrlCmdError}!str@{str}}
\index{str@{str}!XrlCmdError@{XrlCmdError}}
\subsubsection[{str}]{\setlength{\rightskip}{0pt plus 5cm}string XrlCmdError::str (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{structXrlCmdError_afae65c4f3ab46dbdbfb65417a137008e}
\begin{DoxyReturn}{Returns}
string containing representation of command error. 
\end{DoxyReturn}


The documentation for this struct 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}
