\section{TPProto::Fail\-Frame Class Reference}
\label{classTPProto_1_1FailFrame}\index{TPProto::FailFrame@{TPProto::FailFrame}}
Represenation of fail or error \doxyref{Frame}{p.}{classTPProto_1_1Frame} from the server.  


{\tt \#include $<$failframe.h$>$}

Inheritance diagram for TPProto::Fail\-Frame::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2cm]{classTPProto_1_1FailFrame}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Fail\-Frame} ()\label{classTPProto_1_1FailFrame_feffd6b7a4bbc58f851aa54a413a7149}

\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
virtual {\bf $\sim$Fail\-Frame} ()\label{classTPProto_1_1FailFrame_021c004baf92e0e9cda403b5d07f6f57}

\begin{CompactList}\small\item\em Required virtual destructor. \item\end{CompactList}\item 
void {\bf pack\-Buffer} ({\bf Buffer} $\ast$buf)
\begin{CompactList}\small\item\em Assets(0). \item\end{CompactList}\item 
bool {\bf unpack\-Buffer} ({\bf Buffer} $\ast$buf)
\begin{CompactList}\small\item\em Unpack \doxyref{Fail\-Frame}{p.}{classTPProto_1_1FailFrame} from \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}. \item\end{CompactList}\item 
int {\bf get\-Error\-Code} ()
\begin{CompactList}\small\item\em Gets the error code. \item\end{CompactList}\item 
std::string {\bf get\-Error\-String} ()
\begin{CompactList}\small\item\em Gets the error string. \item\end{CompactList}\item 
std::map$<$ int32\_\-t, uint32\_\-t $>$ \textbf{get\-References} ()\label{classTPProto_1_1FailFrame_8dae8e0e169300076f6139ca19c71626}

\end{CompactItemize}


\subsection{Detailed Description}
Represenation of fail or error \doxyref{Frame}{p.}{classTPProto_1_1Frame} from the server. 



\subsection{Member Function Documentation}
\index{TPProto::FailFrame@{TPProto::Fail\-Frame}!packBuffer@{packBuffer}}
\index{packBuffer@{packBuffer}!TPProto::FailFrame@{TPProto::Fail\-Frame}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void TPProto::Fail\-Frame::pack\-Buffer ({\bf Buffer} $\ast$ {\em buf})\hspace{0.3cm}{\tt  [virtual]}}\label{classTPProto_1_1FailFrame_5ff0b263a905a2ca510433a78af4341b}


Assets(0). 

This method asserts 0 because it should never be sent to the server. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em buf}]The \doxyref{Buffer}{p.}{classTPProto_1_1Buffer} (ignored). \end{description}
\end{Desc}


Implements {\bf TPProto::Frame} \doxyref{}{p.}{classTPProto_1_1Frame_67b50ee76e90385e56f04202ce1da67e}.\index{TPProto::FailFrame@{TPProto::Fail\-Frame}!unpackBuffer@{unpackBuffer}}
\index{unpackBuffer@{unpackBuffer}!TPProto::FailFrame@{TPProto::Fail\-Frame}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool TPProto::Fail\-Frame::unpack\-Buffer ({\bf Buffer} $\ast$ {\em buf})\hspace{0.3cm}{\tt  [virtual]}}\label{classTPProto_1_1FailFrame_e38facc648c8bcad1026736ca7180a0a}


Unpack \doxyref{Fail\-Frame}{p.}{classTPProto_1_1FailFrame} from \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}. 

Unpacks the Frame\-Error\-Code and error string from the buffer. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em buf}]The \doxyref{Buffer}{p.}{classTPProto_1_1Buffer} to unpack from. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]True if successful. \end{Desc}


Implements {\bf TPProto::Frame} \doxyref{}{p.}{classTPProto_1_1Frame_fe220a4229f471a3cc6a143f7a27e321}.\index{TPProto::FailFrame@{TPProto::Fail\-Frame}!getErrorCode@{getErrorCode}}
\index{getErrorCode@{getErrorCode}!TPProto::FailFrame@{TPProto::Fail\-Frame}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int TPProto::Fail\-Frame::get\-Error\-Code ()}\label{classTPProto_1_1FailFrame_8608d3e3ef58cb953a036d5e50ece838}


Gets the error code. 

\begin{Desc}
\item[Returns:]The error code. \end{Desc}
\index{TPProto::FailFrame@{TPProto::Fail\-Frame}!getErrorString@{getErrorString}}
\index{getErrorString@{getErrorString}!TPProto::FailFrame@{TPProto::Fail\-Frame}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}std::string TPProto::Fail\-Frame::get\-Error\-String ()}\label{classTPProto_1_1FailFrame_11af07b05a9bc95d3e84aec50dd0e9f0}


Gets the error string. 

\begin{Desc}
\item[Returns:]The error string. \end{Desc}


The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
tpproto/{\bf failframe.h}\item 
tpproto/failframe.cpp\end{CompactItemize}