\section{ost::XMLRPC Class Reference}
\label{classost_1_1_x_m_l_r_p_c}\index{ost::XMLRPC@{ost::XMLRPC}}
This class impliments a core {\bf XMLRPC}{\rm (p.\,\pageref{classost_1_1_x_m_l_r_p_c})} service without the underlying transports.XML-RPC service building class.
{\tt \#include $<$xml.h$>$}
Inheritance diagram for ost::XMLRPC::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2cm]{classost_1_1_x_m_l_r_p_c}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf XMLRPC} (size\_\-t buffer\-Size=512)
\begin{CompactList}\small\item\em Construct {\bf XMLRPC}{\rm (p.\,\pageref{classost_1_1_x_m_l_r_p_c})} workspace. \item\end{CompactList}\item
virtual {\bf $\sim$XMLRPC} ()
\begin{CompactList}\small\item\em Destroy {\bf XMLRPC}{\rm (p.\,\pageref{classost_1_1_x_m_l_r_p_c})} object. \item\end{CompactList}\item
void {\bf beg\-Array} (void)
\begin{CompactList}\small\item\em Create an array. \item\end{CompactList}\item
void {\bf end\-Array} (void)
\begin{CompactList}\small\item\em end an array. \item\end{CompactList}\item
void {\bf invoke} (const char $\ast$method)
\begin{CompactList}\small\item\em Create {\bf XMLRPC}{\rm (p.\,\pageref{classost_1_1_x_m_l_r_p_c})} \char`\"{}method\char`\"{} call in buffer. \item\end{CompactList}\item
void {\bf response} (bool fault)
\begin{CompactList}\small\item\em Create {\bf XMLRPC}{\rm (p.\,\pageref{classost_1_1_x_m_l_r_p_c})} \char`\"{}reply\char`\"{} to a method call. \item\end{CompactList}\item
void {\bf add\-Param} (bool value)
\begin{CompactList}\small\item\em Add bool param to {\bf XMLRPC}{\rm (p.\,\pageref{classost_1_1_x_m_l_r_p_c})} request. \item\end{CompactList}\item
void {\bf add\-Member} (const char $\ast$name, bool value)
\begin{CompactList}\small\item\em Add bool member to a {\bf XMLRPC}{\rm (p.\,\pageref{classost_1_1_x_m_l_r_p_c})} struct. \item\end{CompactList}\item
void {\bf add\-Param} (long value)
\begin{CompactList}\small\item\em Add an integer paramater to {\bf XMLRPC}{\rm (p.\,\pageref{classost_1_1_x_m_l_r_p_c})} request. \item\end{CompactList}\item
void {\bf add\-Member} (const char $\ast$name, long value)
\begin{CompactList}\small\item\em Add an integer member to {\bf XMLRPC}{\rm (p.\,\pageref{classost_1_1_x_m_l_r_p_c})} struct. \item\end{CompactList}\item
void {\bf add\-Param} (const char $\ast$string)
\begin{CompactList}\small\item\em Add a string paramater to {\bf XMLRPC}{\rm (p.\,\pageref{classost_1_1_x_m_l_r_p_c})} request. \item\end{CompactList}\item
void {\bf add\-Member} (const char $\ast$name, const char $\ast$value)
\begin{CompactList}\small\item\em Add a string member to {\bf XMLRPC}{\rm (p.\,\pageref{classost_1_1_x_m_l_r_p_c})} struct. \item\end{CompactList}\item
void {\bf end\-Struct} (void)
\begin{CompactList}\small\item\em Clear a struct. \item\end{CompactList}\item
bool {\bf send} (const char $\ast$resource)
\begin{CompactList}\small\item\em Complete buffer and send well formed {\bf XMLRPC}{\rm (p.\,\pageref{classost_1_1_x_m_l_r_p_c})} request thru post. \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item
virtual bool {\bf post} (const char $\ast$resource, const char $\ast$msg)=0
\begin{CompactList}\small\item\em Used in a derived transport class to deliver the {\bf XMLRPC}{\rm (p.\,\pageref{classost_1_1_x_m_l_r_p_c})} encoded request and return true if successful. \item\end{CompactList}\item
void {\bf beg\-Struct} (void)
\begin{CompactList}\small\item\em Start member struct. \item\end{CompactList}\end{CompactItemize}
\subsection{Detailed Description}
This class impliments a core {\bf XMLRPC}{\rm (p.\,\pageref{classost_1_1_x_m_l_r_p_c})} service without the underlying transports.XML-RPC service building class.
It is meant to create and parse {\bf XMLRPC}{\rm (p.\,\pageref{classost_1_1_x_m_l_r_p_c})} messages. To use for a fit purpose, one might combine it with {\bf URLStream}{\rm (p.\,\pageref{classost_1_1_u_r_l_stream})}, although this implimentation makes no requirement for http based transport.
\begin{Desc}
\item[Author:]David Sugar $<${\tt dyfet@ostel.com}$>$ \end{Desc}
\subsection{Constructor \& Destructor Documentation}
\index{ost::XMLRPC@{ost::XMLRPC}!XMLRPC@{XMLRPC}}
\index{XMLRPC@{XMLRPC}!ost::XMLRPC@{ost::XMLRPC}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}ost::XMLRPC::XMLRPC (size\_\-t {\em buffer\-Size} = {\tt 512})}\label{classost_1_1_x_m_l_r_p_c_6830a51697e5a5df621265f7cccfb754}
Construct {\bf XMLRPC}{\rm (p.\,\pageref{classost_1_1_x_m_l_r_p_c})} workspace.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em buffer\-Size}]size of buffer when using old C++ strstreams. When the newer stringstream ($<$sstream$>$) is available, this parameter is silently ignored. \end{description}
\end{Desc}
\index{ost::XMLRPC@{ost::XMLRPC}!~XMLRPC@{$\sim$XMLRPC}}
\index{~XMLRPC@{$\sim$XMLRPC}!ost::XMLRPC@{ost::XMLRPC}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual ost::XMLRPC::$\sim$XMLRPC ()\hspace{0.3cm}{\tt [virtual]}}\label{classost_1_1_x_m_l_r_p_c_ab6118fff1a7946744881abffc7c2fff}
Destroy {\bf XMLRPC}{\rm (p.\,\pageref{classost_1_1_x_m_l_r_p_c})} object.
\subsection{Member Function Documentation}
\index{ost::XMLRPC@{ost::XMLRPC}!addMember@{addMember}}
\index{addMember@{addMember}!ost::XMLRPC@{ost::XMLRPC}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::XMLRPC::add\-Member (const char $\ast$ {\em name}, const char $\ast$ {\em value})}\label{classost_1_1_x_m_l_r_p_c_e08400240723ffc870ee14660798f078}
Add a string member to {\bf XMLRPC}{\rm (p.\,\pageref{classost_1_1_x_m_l_r_p_c})} struct.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em name}]of member. \item[{\em value}]of member. \end{description}
\end{Desc}
\index{ost::XMLRPC@{ost::XMLRPC}!addMember@{addMember}}
\index{addMember@{addMember}!ost::XMLRPC@{ost::XMLRPC}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::XMLRPC::add\-Member (const char $\ast$ {\em name}, long {\em value})}\label{classost_1_1_x_m_l_r_p_c_e66d1d04ce9f734d62a18db3952875e4}
Add an integer member to {\bf XMLRPC}{\rm (p.\,\pageref{classost_1_1_x_m_l_r_p_c})} struct.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em name}]of member. \item[{\em value}]of member. \end{description}
\end{Desc}
\index{ost::XMLRPC@{ost::XMLRPC}!addMember@{addMember}}
\index{addMember@{addMember}!ost::XMLRPC@{ost::XMLRPC}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::XMLRPC::add\-Member (const char $\ast$ {\em name}, bool {\em value})}\label{classost_1_1_x_m_l_r_p_c_4e72e67b5f9e8e917483c99271eca04a}
Add bool member to a {\bf XMLRPC}{\rm (p.\,\pageref{classost_1_1_x_m_l_r_p_c})} struct.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em name}]of member. \item[{\em value}]of member. \end{description}
\end{Desc}
\index{ost::XMLRPC@{ost::XMLRPC}!addParam@{addParam}}
\index{addParam@{addParam}!ost::XMLRPC@{ost::XMLRPC}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::XMLRPC::add\-Param (const char $\ast$ {\em string})}\label{classost_1_1_x_m_l_r_p_c_cc6757da0dcbc971a8c35949e63214ab}
Add a string paramater to {\bf XMLRPC}{\rm (p.\,\pageref{classost_1_1_x_m_l_r_p_c})} request.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em string}]to add. \end{description}
\end{Desc}
\index{ost::XMLRPC@{ost::XMLRPC}!addParam@{addParam}}
\index{addParam@{addParam}!ost::XMLRPC@{ost::XMLRPC}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::XMLRPC::add\-Param (long {\em value})}\label{classost_1_1_x_m_l_r_p_c_4448549f196cb12219ad9e4bbbf0938e}
Add an integer paramater to {\bf XMLRPC}{\rm (p.\,\pageref{classost_1_1_x_m_l_r_p_c})} request.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em value}]to add. \end{description}
\end{Desc}
\index{ost::XMLRPC@{ost::XMLRPC}!addParam@{addParam}}
\index{addParam@{addParam}!ost::XMLRPC@{ost::XMLRPC}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::XMLRPC::add\-Param (bool {\em value})}\label{classost_1_1_x_m_l_r_p_c_533a7982a925f20944c2a2a8c441cd2d}
Add bool param to {\bf XMLRPC}{\rm (p.\,\pageref{classost_1_1_x_m_l_r_p_c})} request.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em value}]to add. \end{description}
\end{Desc}
\index{ost::XMLRPC@{ost::XMLRPC}!begArray@{begArray}}
\index{begArray@{begArray}!ost::XMLRPC@{ost::XMLRPC}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::XMLRPC::beg\-Array (void)}\label{classost_1_1_x_m_l_r_p_c_6199c4ecf97fedf5f9531abe23e6bd34}
Create an array.
\index{ost::XMLRPC@{ost::XMLRPC}!begStruct@{begStruct}}
\index{begStruct@{begStruct}!ost::XMLRPC@{ost::XMLRPC}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::XMLRPC::beg\-Struct (void)\hspace{0.3cm}{\tt [protected]}}\label{classost_1_1_x_m_l_r_p_c_e253058605694e3c48cff705d47d2c4f}
Start member struct.
\index{ost::XMLRPC@{ost::XMLRPC}!endArray@{endArray}}
\index{endArray@{endArray}!ost::XMLRPC@{ost::XMLRPC}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::XMLRPC::end\-Array (void)}\label{classost_1_1_x_m_l_r_p_c_df716a9e3f2de5a6d5a3c96bf75b138a}
end an array.
\index{ost::XMLRPC@{ost::XMLRPC}!endStruct@{endStruct}}
\index{endStruct@{endStruct}!ost::XMLRPC@{ost::XMLRPC}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::XMLRPC::end\-Struct (void)}\label{classost_1_1_x_m_l_r_p_c_871b6875bef68d9ddd21c65226191ff6}
Clear a struct.
\index{ost::XMLRPC@{ost::XMLRPC}!invoke@{invoke}}
\index{invoke@{invoke}!ost::XMLRPC@{ost::XMLRPC}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::XMLRPC::invoke (const char $\ast$ {\em method})}\label{classost_1_1_x_m_l_r_p_c_ba87ca40d9620a6c6844b011ac3ec185}
Create {\bf XMLRPC}{\rm (p.\,\pageref{classost_1_1_x_m_l_r_p_c})} \char`\"{}method\char`\"{} call in buffer.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em method}]name of method being called. \end{description}
\end{Desc}
\index{ost::XMLRPC@{ost::XMLRPC}!post@{post}}
\index{post@{post}!ost::XMLRPC@{ost::XMLRPC}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual bool ost::XMLRPC::post (const char $\ast$ {\em resource}, const char $\ast$ {\em msg})\hspace{0.3cm}{\tt [protected, pure virtual]}}\label{classost_1_1_x_m_l_r_p_c_83b4344ed06f641f9a672a39315afe5b}
Used in a derived transport class to deliver the {\bf XMLRPC}{\rm (p.\,\pageref{classost_1_1_x_m_l_r_p_c})} encoded request and return true if successful.
The Parse method can then be used to decode the reply.
\begin{Desc}
\item[Returns:]true if successful. \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em resource}]to send to (such as url). \item[{\em msg}]well formed {\bf XMLRPC}{\rm (p.\,\pageref{classost_1_1_x_m_l_r_p_c})} request message. \end{description}
\end{Desc}
\index{ost::XMLRPC@{ost::XMLRPC}!response@{response}}
\index{response@{response}!ost::XMLRPC@{ost::XMLRPC}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::XMLRPC::response (bool {\em fault})}\label{classost_1_1_x_m_l_r_p_c_e5a717f8626bede946f65fc3dbbba7fd}
Create {\bf XMLRPC}{\rm (p.\,\pageref{classost_1_1_x_m_l_r_p_c})} \char`\"{}reply\char`\"{} to a method call.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em fault}]set true for fault message. \end{description}
\end{Desc}
\index{ost::XMLRPC@{ost::XMLRPC}!send@{send}}
\index{send@{send}!ost::XMLRPC@{ost::XMLRPC}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool ost::XMLRPC::send (const char $\ast$ {\em resource})}\label{classost_1_1_x_m_l_r_p_c_4ed6459838f79f980bfb48f85ca9b60b}
Complete buffer and send well formed {\bf XMLRPC}{\rm (p.\,\pageref{classost_1_1_x_m_l_r_p_c})} request thru post.
\begin{Desc}
\item[Returns:]true if successful. \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em resource}]to send to. \end{description}
\end{Desc}
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
{\bf xml.h}\end{CompactItemize}
