\hypertarget{classCommitStatus}{
\section{CommitStatus Class Reference}
\label{classCommitStatus}\index{CommitStatus@{CommitStatus}}
}


A class for storing information regarding \hyperlink{protocolthe-p}{the} current phase of commit operations.  




{\ttfamily \#include $<$slave\_\-conf\_\-tree.hh$>$}

\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
enum {\bfseries Phase} \{ \par
{\bfseries COMMIT\_\-PHASE\_\-NONE} =  0, 
{\bfseries COMMIT\_\-PHASE\_\-1}, 
{\bfseries COMMIT\_\-PHASE\_\-2}, 
{\bfseries COMMIT\_\-PHASE\_\-3}, 
\par
{\bfseries COMMIT\_\-PHASE\_\-4}, 
{\bfseries COMMIT\_\-PHASE\_\-5}, 
{\bfseries COMMIT\_\-PHASE\_\-DONE}
 \}
\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classCommitStatus_ae5167d12ea02626359e8f82baaae1f1a}{
\hyperlink{classCommitStatus_ae5167d12ea02626359e8f82baaae1f1a}{CommitStatus} ()}
\label{classCommitStatus_ae5167d12ea02626359e8f82baaae1f1a}

\begin{DoxyCompactList}\small\item\em Default constructor. \item\end{DoxyCompactList}\item 
\hypertarget{classCommitStatus_a1a82036f85846d6dd26dd0946cd9e59c}{
void \hyperlink{classCommitStatus_a1a82036f85846d6dd26dd0946cd9e59c}{reset} ()}
\label{classCommitStatus_a1a82036f85846d6dd26dd0946cd9e59c}

\begin{DoxyCompactList}\small\item\em Reset \hyperlink{protocolthe-p}{the} commit status. \item\end{DoxyCompactList}\item 
bool \hyperlink{classCommitStatus_a4aa4cdd8137606a9f8b7c49c5ea450d7}{success} () const 
\begin{DoxyCompactList}\small\item\em Test if \hyperlink{protocolthe-p}{the} current phase has been successful. \item\end{DoxyCompactList}\item 
const string \& \hyperlink{classCommitStatus_a4f23589d74c12bab032c32dc192ff24b}{error\_\-msg} () const 
\begin{DoxyCompactList}\small\item\em Get a string with \hyperlink{protocolthe-p}{the} current error message. \item\end{DoxyCompactList}\item 
void \hyperlink{classCommitStatus_a99692673bfc57b27081dc1a42255265f}{set\_\-error} (const string \&error\_\-msg)
\begin{DoxyCompactList}\small\item\em Set \hyperlink{protocolthe-p}{the} commit status as being in error. \item\end{DoxyCompactList}\item 
CommitStatus::Phase \hyperlink{classCommitStatus_a870809297a776760d8a1d6f7db24d93a}{commit\_\-phase} () const 
\begin{DoxyCompactList}\small\item\em Get \hyperlink{protocolthe-p}{the} current commit phase. \item\end{DoxyCompactList}\item 
void \hyperlink{classCommitStatus_af72b7ec2298846d00783ca15cf55e8c6}{set\_\-commit\_\-phase} (CommitStatus::Phase commit\_\-phase)
\begin{DoxyCompactList}\small\item\em Set \hyperlink{protocolthe-p}{the} current commit phase. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classCommitStatus_a20dcfafa68b56aac31a207cf8ce46ca8}{
bool {\bfseries \_\-success}}
\label{classCommitStatus_a20dcfafa68b56aac31a207cf8ce46ca8}

\item 
\hypertarget{classCommitStatus_aeaba86507a0f1700936fb0600f725f9e}{
string {\bfseries \_\-error\_\-msg}}
\label{classCommitStatus_aeaba86507a0f1700936fb0600f725f9e}

\item 
\hypertarget{classCommitStatus_a2fbc4183a3f2e3f3bf424ee1e5b42ab6}{
Phase {\bfseries \_\-commit\_\-phase}}
\label{classCommitStatus_a2fbc4183a3f2e3f3bf424ee1e5b42ab6}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
A class for storing information regarding \hyperlink{protocolthe-p}{the} current phase of commit operations. 

\subsection{Member Function Documentation}
\hypertarget{classCommitStatus_a870809297a776760d8a1d6f7db24d93a}{
\index{CommitStatus@{CommitStatus}!commit\_\-phase@{commit\_\-phase}}
\index{commit\_\-phase@{commit\_\-phase}!CommitStatus@{CommitStatus}}
\subsubsection[{commit\_\-phase}]{\setlength{\rightskip}{0pt plus 5cm}CommitStatus::Phase CommitStatus::commit\_\-phase (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classCommitStatus_a870809297a776760d8a1d6f7db24d93a}


Get \hyperlink{protocolthe-p}{the} current commit phase. 

\begin{DoxyReturn}{Returns}
\hyperlink{protocolthe-p}{the} current commit phase. 
\end{DoxyReturn}
\hypertarget{classCommitStatus_a4f23589d74c12bab032c32dc192ff24b}{
\index{CommitStatus@{CommitStatus}!error\_\-msg@{error\_\-msg}}
\index{error\_\-msg@{error\_\-msg}!CommitStatus@{CommitStatus}}
\subsubsection[{error\_\-msg}]{\setlength{\rightskip}{0pt plus 5cm}const string\& CommitStatus::error\_\-msg (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classCommitStatus_a4f23589d74c12bab032c32dc192ff24b}


Get a string with \hyperlink{protocolthe-p}{the} current error message. 

\begin{DoxyReturn}{Returns}
a string with \hyperlink{protocolthe-p}{the} current error message. 
\end{DoxyReturn}
\hypertarget{classCommitStatus_af72b7ec2298846d00783ca15cf55e8c6}{
\index{CommitStatus@{CommitStatus}!set\_\-commit\_\-phase@{set\_\-commit\_\-phase}}
\index{set\_\-commit\_\-phase@{set\_\-commit\_\-phase}!CommitStatus@{CommitStatus}}
\subsubsection[{set\_\-commit\_\-phase}]{\setlength{\rightskip}{0pt plus 5cm}void CommitStatus::set\_\-commit\_\-phase (
\begin{DoxyParamCaption}
\item[{CommitStatus::Phase}]{commit\_\-phase}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classCommitStatus_af72b7ec2298846d00783ca15cf55e8c6}


Set \hyperlink{protocolthe-p}{the} current commit phase. 


\begin{DoxyParams}{Parameters}
{\em commit\_\-phase} & \hyperlink{protocolthe-p}{the} new value of \hyperlink{protocolthe-p}{the} current commit phase. \\
\hline
\end{DoxyParams}
\hypertarget{classCommitStatus_a99692673bfc57b27081dc1a42255265f}{
\index{CommitStatus@{CommitStatus}!set\_\-error@{set\_\-error}}
\index{set\_\-error@{set\_\-error}!CommitStatus@{CommitStatus}}
\subsubsection[{set\_\-error}]{\setlength{\rightskip}{0pt plus 5cm}void CommitStatus::set\_\-error (
\begin{DoxyParamCaption}
\item[{const string \&}]{error\_\-msg}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classCommitStatus_a99692673bfc57b27081dc1a42255265f}


Set \hyperlink{protocolthe-p}{the} commit status as being in error. 


\begin{DoxyParams}{Parameters}
{\em error\_\-msg} & \hyperlink{protocolthe-p}{the} message that describes \hyperlink{protocolthe-p}{the} error. \\
\hline
\end{DoxyParams}
\hypertarget{classCommitStatus_a4aa4cdd8137606a9f8b7c49c5ea450d7}{
\index{CommitStatus@{CommitStatus}!success@{success}}
\index{success@{success}!CommitStatus@{CommitStatus}}
\subsubsection[{success}]{\setlength{\rightskip}{0pt plus 5cm}bool CommitStatus::success (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classCommitStatus_a4aa4cdd8137606a9f8b7c49c5ea450d7}


Test if \hyperlink{protocolthe-p}{the} current phase has been successful. 

\begin{DoxyReturn}{Returns}
true if \hyperlink{protocolthe-p}{the} current phase has been successful, otherwise false. 
\end{DoxyReturn}


The documentation for this class was generated from the following file:\begin{DoxyCompactItemize}
\item 
/home/greearb/git/xorp.ct.github/xorp/rtrmgr/slave\_\-conf\_\-tree.hh\end{DoxyCompactItemize}
