\section{TPProto::Command\-Desc\-Cache Class Reference} \label{classTPProto_1_1CommandDescCache}\index{TPProto::CommandDescCache@{TPProto::CommandDescCache}} A \doxyref{Cache}{p.}{classTPProto_1_1Cache} that caches Order\-Descriptions. {\tt \#include $<$commanddesccache.h$>$} Inheritance diagram for TPProto::Command\-Desc\-Cache::\begin{figure}[H] \begin{center} \leavevmode \includegraphics[height=2cm]{classTPProto_1_1CommandDescCache} \end{center} \end{figure} \subsection*{Public Member Functions} \begin{CompactItemize} \item {\bf Command\-Desc\-Cache} ()\label{classTPProto_1_1CommandDescCache_ba4afd0631034dbaf4a498304064a846} \begin{CompactList}\small\item\em Default Constructor. \item\end{CompactList}\item virtual {\bf $\sim$Command\-Desc\-Cache} ()\label{classTPProto_1_1CommandDescCache_474ccb1faa9fa25cbfe1d400b21fc146} \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item void {\bf request\-Command\-Description} (uint32\_\-t cmdtype, const Command\-Desc\-Callback \&cb) \begin{CompactList}\small\item\em Request a command description. \item\end{CompactList}\item boost::signals::connection {\bf watch\-Command\-Description} (uint32\_\-t cmdtype, const Command\-Desc\-Callback \&cb) \begin{CompactList}\small\item\em Watch a command description. \item\end{CompactList}\item void {\bf request\-Command\-Types} (const Id\-Set\-Callback \&cb) \begin{CompactList}\small\item\em Request a list of command type IDs. \item\end{CompactList}\item boost::signals::connection {\bf watch\-Command\-Types} (const Id\-Set\-Callback \&cb) \begin{CompactList}\small\item\em Watch the list of command type IDs. \item\end{CompactList}\item virtual {\bf Get\-Id\-Sequence} $\ast$ {\bf create\-Get\-Id\-Sequence\-Frame} () \begin{CompactList}\small\item\em Create a Get \doxyref{Command}{p.}{classTPProto_1_1Command} Type IDs frame. \item\end{CompactList}\item virtual {\bf Get\-By\-Id} $\ast$ {\bf create\-Get\-By\-Id\-Frame} () \begin{CompactList}\small\item\em Create a Get \doxyref{Command}{p.}{classTPProto_1_1Command} Description frame. \item\end{CompactList}\item virtual uint32\_\-t {\bf get\-Id\-From\-Frame} ({\bf Frame} $\ast$frame) \begin{CompactList}\small\item\em Get the command type ID from a \doxyref{Command}{p.}{classTPProto_1_1Command} Description frame. \item\end{CompactList}\item virtual uint64\_\-t {\bf get\-Mod\-Time\-From\-Frame} ({\bf Frame} $\ast$frame) \begin{CompactList}\small\item\em Get the modification time from a \doxyref{Command}{p.}{classTPProto_1_1Command} Description frame. \item\end{CompactList}\item virtual void {\bf new\-Item} (boost::shared\_\-ptr$<$ {\bf Frame} $>$ item) \begin{CompactList}\small\item\em Receive a new or updated version of an item from the \doxyref{Cache\-Method}{p.}{classTPProto_1_1CacheMethod}. \item\end{CompactList}\item virtual void {\bf existing\-Item} (boost::shared\_\-ptr$<$ {\bf Frame} $>$ item) \begin{CompactList}\small\item\em Receive an existing item from the \doxyref{Cache\-Method}{p.}{classTPProto_1_1CacheMethod}. \item\end{CompactList}\end{CompactItemize} \subsection{Detailed Description} A \doxyref{Cache}{p.}{classTPProto_1_1Cache} that caches Order\-Descriptions. \subsection{Member Function Documentation} \index{TPProto::CommandDescCache@{TPProto::Command\-Desc\-Cache}!requestCommandDescription@{requestCommandDescription}} \index{requestCommandDescription@{requestCommandDescription}!TPProto::CommandDescCache@{TPProto::Command\-Desc\-Cache}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}void TPProto::Command\-Desc\-Cache::request\-Command\-Description (uint32\_\-t {\em cmdtype}, const Command\-Desc\-Callback \& {\em cb})}\label{classTPProto_1_1CommandDescCache_4ab76ad479d9d33126a6d4964e73ed36} Request a command description. \begin{Desc} \item[Parameters:] \begin{description} \item[{\em cmdtype}]The command type ID. \item[{\em cb}]The callback function for the description. \end{description} \end{Desc} \index{TPProto::CommandDescCache@{TPProto::Command\-Desc\-Cache}!watchCommandDescription@{watchCommandDescription}} \index{watchCommandDescription@{watchCommandDescription}!TPProto::CommandDescCache@{TPProto::Command\-Desc\-Cache}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}boost::signals::connection TPProto::Command\-Desc\-Cache::watch\-Command\-Description (uint32\_\-t {\em cmdtype}, const Command\-Desc\-Callback \& {\em cb})}\label{classTPProto_1_1CommandDescCache_3eafcf19a9818e70172d7465ac1aee4a} Watch a command description. \begin{Desc} \item[Parameters:] \begin{description} \item[{\em cmdtype}]The command type ID. \item[{\em cb}]The callback function for the description. \end{description} \end{Desc} \begin{Desc} \item[Returns:]The connection for the callback. \end{Desc} \index{TPProto::CommandDescCache@{TPProto::Command\-Desc\-Cache}!requestCommandTypes@{requestCommandTypes}} \index{requestCommandTypes@{requestCommandTypes}!TPProto::CommandDescCache@{TPProto::Command\-Desc\-Cache}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}void TPProto::Command\-Desc\-Cache::request\-Command\-Types (const Id\-Set\-Callback \& {\em cb})}\label{classTPProto_1_1CommandDescCache_4ce3648e59b7f68b2b11145f37b4e03b} Request a list of command type IDs. \begin{Desc} \item[Parameters:] \begin{description} \item[{\em cb}]The callback function for the sequence. \end{description} \end{Desc} \index{TPProto::CommandDescCache@{TPProto::Command\-Desc\-Cache}!watchCommandTypes@{watchCommandTypes}} \index{watchCommandTypes@{watchCommandTypes}!TPProto::CommandDescCache@{TPProto::Command\-Desc\-Cache}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}boost::signals::connection TPProto::Command\-Desc\-Cache::watch\-Command\-Types (const Id\-Set\-Callback \& {\em cb})}\label{classTPProto_1_1CommandDescCache_9e74ae39276c2404c92e8a0eca789a82} Watch the list of command type IDs. \begin{Desc} \item[Parameters:] \begin{description} \item[{\em cb}]The callback function for the sequence. \end{description} \end{Desc} \begin{Desc} \item[Returns:]The connection for the callback. \end{Desc} \index{TPProto::CommandDescCache@{TPProto::Command\-Desc\-Cache}!createGetIdSequenceFrame@{createGetIdSequenceFrame}} \index{createGetIdSequenceFrame@{createGetIdSequenceFrame}!TPProto::CommandDescCache@{TPProto::Command\-Desc\-Cache}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Get\-Id\-Sequence} $\ast$ TPProto::Command\-Desc\-Cache::create\-Get\-Id\-Sequence\-Frame ()\hspace{0.3cm}{\tt [virtual]}}\label{classTPProto_1_1CommandDescCache_d82c31248f73c3d33de9e0c95a5ce5fa} Create a Get \doxyref{Command}{p.}{classTPProto_1_1Command} Type IDs frame. \begin{Desc} \item[Returns:]The Get \doxyref{Command}{p.}{classTPProto_1_1Command} Type IDs frame. \end{Desc} Implements {\bf TPProto::Cache} \doxyref{}{p.}{classTPProto_1_1Cache_0ff2144fa5961ec02f79d5a6013a4e91}.\index{TPProto::CommandDescCache@{TPProto::Command\-Desc\-Cache}!createGetByIdFrame@{createGetByIdFrame}} \index{createGetByIdFrame@{createGetByIdFrame}!TPProto::CommandDescCache@{TPProto::Command\-Desc\-Cache}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Get\-By\-Id} $\ast$ TPProto::Command\-Desc\-Cache::create\-Get\-By\-Id\-Frame ()\hspace{0.3cm}{\tt [virtual]}}\label{classTPProto_1_1CommandDescCache_5032cd319c5a967bcf9aa4e142c5f26b} Create a Get \doxyref{Command}{p.}{classTPProto_1_1Command} Description frame. \begin{Desc} \item[Returns:]The Get \doxyref{Command}{p.}{classTPProto_1_1Command} Description frame. \end{Desc} Implements {\bf TPProto::Cache} \doxyref{}{p.}{classTPProto_1_1Cache_c7df6f07217e6b612f020c66b9a722a7}.\index{TPProto::CommandDescCache@{TPProto::Command\-Desc\-Cache}!getIdFromFrame@{getIdFromFrame}} \index{getIdFromFrame@{getIdFromFrame}!TPProto::CommandDescCache@{TPProto::Command\-Desc\-Cache}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint32\_\-t TPProto::Command\-Desc\-Cache::get\-Id\-From\-Frame ({\bf Frame} $\ast$ {\em frame})\hspace{0.3cm}{\tt [virtual]}}\label{classTPProto_1_1CommandDescCache_22d6c5ce70e25f19c5d716679189c41d} Get the command type ID from a \doxyref{Command}{p.}{classTPProto_1_1Command} Description frame. \begin{Desc} \item[Parameters:] \begin{description} \item[{\em frame}]The \doxyref{Command}{p.}{classTPProto_1_1Command} Description frame. \end{description} \end{Desc} \begin{Desc} \item[Returns:]The command type ID. \end{Desc} Implements {\bf TPProto::Cache} \doxyref{}{p.}{classTPProto_1_1Cache_75a6f039db7cb69b6019c928776c574f}.\index{TPProto::CommandDescCache@{TPProto::Command\-Desc\-Cache}!getModTimeFromFrame@{getModTimeFromFrame}} \index{getModTimeFromFrame@{getModTimeFromFrame}!TPProto::CommandDescCache@{TPProto::Command\-Desc\-Cache}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint64\_\-t TPProto::Command\-Desc\-Cache::get\-Mod\-Time\-From\-Frame ({\bf Frame} $\ast$ {\em frame})\hspace{0.3cm}{\tt [virtual]}}\label{classTPProto_1_1CommandDescCache_86d61d6b0d15307e6b71d632ea5b7162} Get the modification time from a \doxyref{Command}{p.}{classTPProto_1_1Command} Description frame. \begin{Desc} \item[Parameters:] \begin{description} \item[{\em frame}]The \doxyref{Command}{p.}{classTPProto_1_1Command} Description frame. \end{description} \end{Desc} \begin{Desc} \item[Returns:]The modification time. \end{Desc} Implements {\bf TPProto::Cache} \doxyref{}{p.}{classTPProto_1_1Cache_019bddc598295778f9b0f8f05ad23c2f}.\index{TPProto::CommandDescCache@{TPProto::Command\-Desc\-Cache}!newItem@{newItem}} \index{newItem@{newItem}!TPProto::CommandDescCache@{TPProto::Command\-Desc\-Cache}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}void TPProto::Command\-Desc\-Cache::new\-Item (boost::shared\_\-ptr$<$ {\bf Frame} $>$ {\em item})\hspace{0.3cm}{\tt [virtual]}}\label{classTPProto_1_1CommandDescCache_97b214e7a4d07a369e8aba6fe31366a5} Receive a new or updated version of an item from the \doxyref{Cache\-Method}{p.}{classTPProto_1_1CacheMethod}. \begin{Desc} \item[Parameters:] \begin{description} \item[{\em item}]The existing item in a \doxyref{Frame}{p.}{classTPProto_1_1Frame} \end{description} \end{Desc} Implements {\bf TPProto::Cache} \doxyref{}{p.}{classTPProto_1_1Cache_202281d5db63116a41517d794f98c7df}.\index{TPProto::CommandDescCache@{TPProto::Command\-Desc\-Cache}!existingItem@{existingItem}} \index{existingItem@{existingItem}!TPProto::CommandDescCache@{TPProto::Command\-Desc\-Cache}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}void TPProto::Command\-Desc\-Cache::existing\-Item (boost::shared\_\-ptr$<$ {\bf Frame} $>$ {\em item})\hspace{0.3cm}{\tt [virtual]}}\label{classTPProto_1_1CommandDescCache_b2120a73db66abda139a9cdcf89c203d} Receive an existing item from the \doxyref{Cache\-Method}{p.}{classTPProto_1_1CacheMethod}. \begin{Desc} \item[Parameters:] \begin{description} \item[{\em item}]The existing item in a \doxyref{Frame}{p.}{classTPProto_1_1Frame} \end{description} \end{Desc} Implements {\bf TPProto::Cache} \doxyref{}{p.}{classTPProto_1_1Cache_4047c19364373975e47acaaea50665da}. The documentation for this class was generated from the following files:\begin{CompactItemize} \item tpproto/{\bf commanddesccache.h}\item tpproto/commanddesccache.cpp\end{CompactItemize}