\hypertarget{classCisRpc}{}\section{Cis\+Rpc Class Reference}
\label{classCisRpc}\index{Cis\+Rpc@{Cis\+Rpc}}


C++ interface to cis\+Rpc\+\_\+t functionality.  




{\ttfamily \#include $<$Cis\+Interface.\+hpp$>$}

Inheritance diagram for Cis\+Rpc\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{classCisRpc}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classCisRpc_a91e65146ad3b4d1a3999835003b1cf37}{Cis\+Rpc}} (const char $\ast$name, const char $\ast$out\+Format, const char $\ast$in\+Format)
\begin{DoxyCompactList}\small\item\em Constructor for \mbox{\hyperlink{classCisRpc}{Cis\+Rpc}}. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classCisRpc_aca7fcde600dcb7b42ef93a5e9405358b}\label{classCisRpc_aca7fcde600dcb7b42ef93a5e9405358b}} 
\mbox{\hyperlink{classCisRpc_aca7fcde600dcb7b42ef93a5e9405358b}{Cis\+Rpc}} (cis\+Rpc\+\_\+t x)
\begin{DoxyCompactList}\small\item\em Empty constructor for inheritance. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classCisRpc_a29148e3e2924edc61aeec247ed939161}\label{classCisRpc_a29148e3e2924edc61aeec247ed939161}} 
void \mbox{\hyperlink{classCisRpc_a29148e3e2924edc61aeec247ed939161}{\+\_\+destroy\+\_\+pi}} ()
\begin{DoxyCompactList}\small\item\em Alias to allow freeing of underlying C struct at the class level. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classCisRpc_accbcccd1fd223660be6e8cf54cace2a8}\label{classCisRpc_accbcccd1fd223660be6e8cf54cace2a8}} 
\mbox{\hyperlink{classCisRpc_accbcccd1fd223660be6e8cf54cace2a8}{$\sim$\+Cis\+Rpc}} ()
\begin{DoxyCompactList}\small\item\em Destructor for \mbox{\hyperlink{classCisRpc}{Cis\+Rpc}}. See cis\+\_\+free in \mbox{\hyperlink{CisInterface_8h_source}{Cis\+Interface.\+h}} for details. \end{DoxyCompactList}\item 
cis\+Rpc\+\_\+t \mbox{\hyperlink{classCisRpc_ac58fc44e28ea378a1ef6b12684371aef}{pi}} ()
\begin{DoxyCompactList}\small\item\em Return the cis\+Rpc\+\_\+t structure. \end{DoxyCompactList}\item 
int \mbox{\hyperlink{classCisRpc_afb4143aa59acfe94df91435262cde01e}{send}} (const int nargs,...)
\begin{DoxyCompactList}\small\item\em Format and send a message to an R\+PC output queue. See rpc\+Send from \mbox{\hyperlink{CisInterface_8h_source}{Cis\+Interface.\+h}} for details. \end{DoxyCompactList}\item 
int \mbox{\hyperlink{classCisRpc_a6b1acb06791551c0c3096f678690e315}{recv}} (const int nargs,...)
\begin{DoxyCompactList}\small\item\em Receive and parse a message from an R\+PC input queue. See rpc\+Recv from \mbox{\hyperlink{CisInterface_8h_source}{Cis\+Interface.\+h}} for details. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
C++ interface to cis\+Rpc\+\_\+t functionality. 

The \mbox{\hyperlink{classCisRpc}{Cis\+Rpc}} class is a basic wrapper around the C cis\+Rpc\+\_\+t structure and associated functions from the \mbox{\hyperlink{CisInterface_8h_source}{Cis\+Interface.\+h}} header. It provides the user with C++ style access to basic R\+PC messaging via I\+PC queues. 

\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{classCisRpc_a91e65146ad3b4d1a3999835003b1cf37}\label{classCisRpc_a91e65146ad3b4d1a3999835003b1cf37}} 
\index{Cis\+Rpc@{Cis\+Rpc}!Cis\+Rpc@{Cis\+Rpc}}
\index{Cis\+Rpc@{Cis\+Rpc}!Cis\+Rpc@{Cis\+Rpc}}
\subsubsection{\texorpdfstring{Cis\+Rpc()}{CisRpc()}}
{\footnotesize\ttfamily Cis\+Rpc\+::\+Cis\+Rpc (\begin{DoxyParamCaption}\item[{const char $\ast$}]{name,  }\item[{const char $\ast$}]{out\+Format,  }\item[{const char $\ast$}]{in\+Format }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Constructor for \mbox{\hyperlink{classCisRpc}{Cis\+Rpc}}. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em name} & constant character pointer name of the output queue. \\
\hline
\mbox{\tt in}  & {\em out\+Format} & character pointer to format that should be used for formatting output. \\
\hline
\mbox{\tt in}  & {\em in\+Format} & character pointer to format that should be used for parsing input. \\
\hline
\end{DoxyParams}


\subsection{Member Function Documentation}
\mbox{\Hypertarget{classCisRpc_ac58fc44e28ea378a1ef6b12684371aef}\label{classCisRpc_ac58fc44e28ea378a1ef6b12684371aef}} 
\index{Cis\+Rpc@{Cis\+Rpc}!pi@{pi}}
\index{pi@{pi}!Cis\+Rpc@{Cis\+Rpc}}
\subsubsection{\texorpdfstring{pi()}{pi()}}
{\footnotesize\ttfamily cis\+Rpc\+\_\+t Cis\+Rpc\+::pi (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Return the cis\+Rpc\+\_\+t structure. 

\begin{DoxyReturn}{Returns}
cis\+Rpc\+\_\+t structure underlying the class. 
\end{DoxyReturn}
\mbox{\Hypertarget{classCisRpc_a6b1acb06791551c0c3096f678690e315}\label{classCisRpc_a6b1acb06791551c0c3096f678690e315}} 
\index{Cis\+Rpc@{Cis\+Rpc}!recv@{recv}}
\index{recv@{recv}!Cis\+Rpc@{Cis\+Rpc}}
\subsubsection{\texorpdfstring{recv()}{recv()}}
{\footnotesize\ttfamily int Cis\+Rpc\+::recv (\begin{DoxyParamCaption}\item[{const int}]{nargs,  }\item[{}]{... }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Receive and parse a message from an R\+PC input queue. See rpc\+Recv from \mbox{\hyperlink{CisInterface_8h_source}{Cis\+Interface.\+h}} for details. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em nargs} & int Number of arguments being passed. \\
\hline
\mbox{\tt out}  & {\em ...} & mixed arguments that should be assigned parameters extracted using the format string. Since these will be assigned, they should be pointers to memory that has already been allocated. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
integer specifying if the receive was succesful. Values $>$= 0 indicate success. 
\end{DoxyReturn}
\mbox{\Hypertarget{classCisRpc_afb4143aa59acfe94df91435262cde01e}\label{classCisRpc_afb4143aa59acfe94df91435262cde01e}} 
\index{Cis\+Rpc@{Cis\+Rpc}!send@{send}}
\index{send@{send}!Cis\+Rpc@{Cis\+Rpc}}
\subsubsection{\texorpdfstring{send()}{send()}}
{\footnotesize\ttfamily int Cis\+Rpc\+::send (\begin{DoxyParamCaption}\item[{const int}]{nargs,  }\item[{}]{... }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Format and send a message to an R\+PC output queue. See rpc\+Send from \mbox{\hyperlink{CisInterface_8h_source}{Cis\+Interface.\+h}} for details. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em nargs} & int Number of arguments being passed. \\
\hline
\mbox{\tt in}  & {\em ...} & arguments for formatting. ~\newline
\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
integer specifying if the send was succesful. Values $>$= 0 indicate success. 
\end{DoxyReturn}


The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
/root/cis\+\_\+interface/cis\+\_\+interface/cis\+\_\+interface/interface/Cis\+Interface.\+hpp\end{DoxyCompactItemize}
