<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>ost::XMLRPC class Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body bgcolor="#ffffff"> <!-- Generated by Doxygen 1.2.10 --> <center> <a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center> <hr><h1>ost::XMLRPC Class Reference</h1>This class impliments a core <a class="el" href="classost_1_1_x_m_l_r_p_c.html">XMLRPC</a> service without the underlying transports. XML-RPC service building class. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="xml_8h-source.html">xml.h</a>></code> <p> <p>Inheritance diagram for ost::XMLRPC:: <p><center><img src="classost_1_1_x_m_l_r_p_c.gif" usemap="#ost::XMLRPC_map" border="0"></center> <map name="ost::XMLRPC_map"> <area href="classost_1_1_x_m_l_stream.html" alt="ost::XMLStream" shape="rect" coords="0,0,100,24"> </map> <a href="classost_1_1_x_m_l_r_p_c-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> <tr><td colspan=2><br><h2>Public Methods</h2></td></tr> <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classost_1_1_x_m_l_r_p_c.html#a0">XMLRPC</a> (size_t bufsize)</td></tr> <tr><td> </td><td><font size=-1><em>Construct <a class="el" href="classost_1_1_x_m_l_r_p_c.html">XMLRPC</a> workspace.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classost_1_1_x_m_l_r_p_c.html#a1">~XMLRPC</a> ()</td></tr> <tr><td> </td><td><font size=-1><em>Destroy <a class="el" href="classost_1_1_x_m_l_r_p_c.html">XMLRPC</a> object.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classost_1_1_x_m_l_r_p_c.html#a2">begArray</a> (void)</td></tr> <tr><td> </td><td><font size=-1><em>Create an array.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classost_1_1_x_m_l_r_p_c.html#a3">endArray</a> (void)</td></tr> <tr><td> </td><td><font size=-1><em>end an array.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classost_1_1_x_m_l_r_p_c.html#a4">Invoke</a> (const char *method)</td></tr> <tr><td> </td><td><font size=-1><em>Create <a class="el" href="classost_1_1_x_m_l_r_p_c.html">XMLRPC</a> "method" call in buffer.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classost_1_1_x_m_l_r_p_c.html#a5">Response</a> (bool fault)</td></tr> <tr><td> </td><td><font size=-1><em>Create <a class="el" href="classost_1_1_x_m_l_r_p_c.html">XMLRPC</a> "reply" to a method call.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classost_1_1_x_m_l_r_p_c.html#a6">addParam</a> (bool value)</td></tr> <tr><td> </td><td><font size=-1><em>Add bool param to <a class="el" href="classost_1_1_x_m_l_r_p_c.html">XMLRPC</a> request.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classost_1_1_x_m_l_r_p_c.html#a7">addMember</a> (const char *name, bool value)</td></tr> <tr><td> </td><td><font size=-1><em>Add bool member to a <a class="el" href="classost_1_1_x_m_l_r_p_c.html">XMLRPC</a> struct.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classost_1_1_x_m_l_r_p_c.html#a8">addParam</a> (long value)</td></tr> <tr><td> </td><td><font size=-1><em>Add an integer paramater to <a class="el" href="classost_1_1_x_m_l_r_p_c.html">XMLRPC</a> request.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classost_1_1_x_m_l_r_p_c.html#a9">addMember</a> (const char *name, long value)</td></tr> <tr><td> </td><td><font size=-1><em>Add an integer member to <a class="el" href="classost_1_1_x_m_l_r_p_c.html">XMLRPC</a> struct.</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classost_1_1_x_m_l_r_p_c.html#a10">addParam</a> (const char *string)</td></tr> <tr><td> </td><td><font size=-1><em>Add a string paramater to <a class="el" href="classost_1_1_x_m_l_r_p_c.html">XMLRPC</a> request.</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classost_1_1_x_m_l_r_p_c.html#a11">addMember</a> (const char *name, const char *value)</td></tr> <tr><td> </td><td><font size=-1><em>Add a string member to <a class="el" href="classost_1_1_x_m_l_r_p_c.html">XMLRPC</a> struct.</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classost_1_1_x_m_l_r_p_c.html#a12">endStruct</a> (void)</td></tr> <tr><td> </td><td><font size=-1><em>Clear a struct.</em> <a href="#a12">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classost_1_1_x_m_l_r_p_c.html#a13">Send</a> (const char *resource)</td></tr> <tr><td> </td><td><font size=-1><em>Complete buffer and send well formed <a class="el" href="classost_1_1_x_m_l_r_p_c.html">XMLRPC</a> request thru post.</em> <a href="#a13">More...</a><em></em></font><br><br></td></tr> <tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> <tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classost_1_1_x_m_l_r_p_c.html#b0">Post</a> (const char *resource, const char *msg)</td></tr> <tr><td> </td><td><font size=-1><em>Used in a derived transport class to deliver the <a class="el" href="classost_1_1_x_m_l_r_p_c.html">XMLRPC</a> encoded request and return true if successful.</em> <a href="#b0">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classost_1_1_x_m_l_r_p_c.html#b1">begStruct</a> (void)</td></tr> <tr><td> </td><td><font size=-1><em>Start member struct.</em> <a href="#b1">More...</a><em></em></font><br><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> This class impliments a core <a class="el" href="classost_1_1_x_m_l_r_p_c.html">XMLRPC</a> service without the underlying transports. XML-RPC service building class. <p> It is meant to create and parse <a class="el" href="classost_1_1_x_m_l_r_p_c.html">XMLRPC</a> messages. To use for a fit purpose, one might combine it with <a class="el" href="classost_1_1_u_r_l_stream.html">URLStream</a>, although this implimentation makes no requirement for http based transport. <p> <dl compact><dt><b> Author: </b><dd> David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> </dl> <p> <hr><h2>Constructor & Destructor Documentation</h2> <a name="a0" doxytag="ost::XMLRPC::XMLRPC"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> ost::XMLRPC::XMLRPC </td> <td class="md">( </td> <td class="md">size_t</td> <td class="mdname1"> <em>bufsize</em> </td> <td class="md">) </td> <td class="md"></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Construct <a class="el" href="classost_1_1_x_m_l_r_p_c.html">XMLRPC</a> workspace. <p> <dl compact><dt><b> Parameters: </b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>size </em> </td><td> of buffer. </td></tr> </table> </dl> </td> </tr> </table> <a name="a1" doxytag="ost::XMLRPC::~XMLRPC"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual ost::XMLRPC::~XMLRPC </td> <td class="md">( </td> <td class="mdname1"> </td> <td class="md">) </td> <td class="md"><code> [virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Destroy <a class="el" href="classost_1_1_x_m_l_r_p_c.html">XMLRPC</a> object. <p> </td> </tr> </table> <hr><h2>Member Function Documentation</h2> <a name="a4" doxytag="ost::XMLRPC::Invoke"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void ost::XMLRPC::Invoke </td> <td class="md">( </td> <td class="md">const char *</td> <td class="mdname1"> <em>method</em> </td> <td class="md">) </td> <td class="md"></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Create <a class="el" href="classost_1_1_x_m_l_r_p_c.html">XMLRPC</a> "method" call in buffer. <p> <dl compact><dt><b> Parameters: </b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>name </em> </td><td> of method being called. </td></tr> </table> </dl> </td> </tr> </table> <a name="b0" doxytag="ost::XMLRPC::Post"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual bool ost::XMLRPC::Post </td> <td class="md">( </td> <td class="md">const char *</td> <td class="mdname"> <em>resource</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md">const char *</td> <td class="mdname"> <em>msg</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [protected, virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Used in a derived transport class to deliver the <a class="el" href="classost_1_1_x_m_l_r_p_c.html">XMLRPC</a> encoded request and return true if successful. <p> The Parse method can then be used to decode the reply. <p> <dl compact><dt><b> Returns: </b><dd> true if successful. </dl><dl compact><dt><b> Parameters: </b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>resource </em> </td><td> to send to (such as url). </td></tr> <tr><td valign=top><em>well </em> </td><td> formed <a class="el" href="classost_1_1_x_m_l_r_p_c.html">XMLRPC</a> request message. </td></tr> </table> </dl> </td> </tr> </table> <a name="a5" doxytag="ost::XMLRPC::Response"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void ost::XMLRPC::Response </td> <td class="md">( </td> <td class="md">bool</td> <td class="mdname1"> <em>fault</em> </td> <td class="md">) </td> <td class="md"></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Create <a class="el" href="classost_1_1_x_m_l_r_p_c.html">XMLRPC</a> "reply" to a method call. <p> <dl compact><dt><b> Parameters: </b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>set </em> </td><td> true for fault message. </td></tr> </table> </dl> </td> </tr> </table> <a name="a13" doxytag="ost::XMLRPC::Send"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> bool ost::XMLRPC::Send </td> <td class="md">( </td> <td class="md">const char *</td> <td class="mdname1"> <em>resource</em> </td> <td class="md">) </td> <td class="md"></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Complete buffer and send well formed <a class="el" href="classost_1_1_x_m_l_r_p_c.html">XMLRPC</a> request thru post. <p> <dl compact><dt><b> Returns: </b><dd> true if successful. </dl><dl compact><dt><b> Parameters: </b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>resource </em> </td><td> to send to. </td></tr> </table> </dl> </td> </tr> </table> <a name="a11" doxytag="ost::XMLRPC::addMember"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void ost::XMLRPC::addMember </td> <td class="md">( </td> <td class="md">const char *</td> <td class="mdname"> <em>name</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md">const char *</td> <td class="mdname"> <em>value</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Add a string member to <a class="el" href="classost_1_1_x_m_l_r_p_c.html">XMLRPC</a> struct. <p> <dl compact><dt><b> Parameters: </b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>name </em> </td><td> of member. </td></tr> <tr><td valign=top><em>value </em> </td><td> of member. </td></tr> </table> </dl> </td> </tr> </table> <a name="a9" doxytag="ost::XMLRPC::addMember"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void ost::XMLRPC::addMember </td> <td class="md">( </td> <td class="md">const char *</td> <td class="mdname"> <em>name</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md">long</td> <td class="mdname"> <em>value</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Add an integer member to <a class="el" href="classost_1_1_x_m_l_r_p_c.html">XMLRPC</a> struct. <p> <dl compact><dt><b> Parameters: </b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>name </em> </td><td> of member. </td></tr> <tr><td valign=top><em>value </em> </td><td> of member. </td></tr> </table> </dl> </td> </tr> </table> <a name="a7" doxytag="ost::XMLRPC::addMember"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void ost::XMLRPC::addMember </td> <td class="md">( </td> <td class="md">const char *</td> <td class="mdname"> <em>name</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md">bool</td> <td class="mdname"> <em>value</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Add bool member to a <a class="el" href="classost_1_1_x_m_l_r_p_c.html">XMLRPC</a> struct. <p> <dl compact><dt><b> Parameters: </b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>name </em> </td><td> of member. </td></tr> <tr><td valign=top><em>value </em> </td><td> of member. </td></tr> </table> </dl> </td> </tr> </table> <a name="a10" doxytag="ost::XMLRPC::addParam"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void ost::XMLRPC::addParam </td> <td class="md">( </td> <td class="md">const char *</td> <td class="mdname1"> <em>string</em> </td> <td class="md">) </td> <td class="md"></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Add a string paramater to <a class="el" href="classost_1_1_x_m_l_r_p_c.html">XMLRPC</a> request. <p> <dl compact><dt><b> Parameters: </b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>string </em> </td><td> to add. </td></tr> </table> </dl> </td> </tr> </table> <a name="a8" doxytag="ost::XMLRPC::addParam"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void ost::XMLRPC::addParam </td> <td class="md">( </td> <td class="md">long</td> <td class="mdname1"> <em>value</em> </td> <td class="md">) </td> <td class="md"></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Add an integer paramater to <a class="el" href="classost_1_1_x_m_l_r_p_c.html">XMLRPC</a> request. <p> <dl compact><dt><b> Parameters: </b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>value </em> </td><td> to add. </td></tr> </table> </dl> </td> </tr> </table> <a name="a6" doxytag="ost::XMLRPC::addParam"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void ost::XMLRPC::addParam </td> <td class="md">( </td> <td class="md">bool</td> <td class="mdname1"> <em>value</em> </td> <td class="md">) </td> <td class="md"></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Add bool param to <a class="el" href="classost_1_1_x_m_l_r_p_c.html">XMLRPC</a> request. <p> <dl compact><dt><b> Parameters: </b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>value </em> </td><td> to add. </td></tr> </table> </dl> </td> </tr> </table> <a name="a2" doxytag="ost::XMLRPC::begArray"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void ost::XMLRPC::begArray </td> <td class="md">( </td> <td class="md">void</td> <td class="mdname1"> </td> <td class="md">) </td> <td class="md"></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Create an array. <p> </td> </tr> </table> <a name="b1" doxytag="ost::XMLRPC::begStruct"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void ost::XMLRPC::begStruct </td> <td class="md">( </td> <td class="md">void</td> <td class="mdname1"> </td> <td class="md">) </td> <td class="md"><code> [protected]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Start member struct. <p> </td> </tr> </table> <a name="a3" doxytag="ost::XMLRPC::endArray"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void ost::XMLRPC::endArray </td> <td class="md">( </td> <td class="md">void</td> <td class="mdname1"> </td> <td class="md">) </td> <td class="md"></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> end an array. <p> </td> </tr> </table> <a name="a12" doxytag="ost::XMLRPC::endStruct"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void ost::XMLRPC::endStruct </td> <td class="md">( </td> <td class="md">void</td> <td class="mdname1"> </td> <td class="md">) </td> <td class="md"></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Clear a struct. <p> </td> </tr> </table> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="xml_8h-source.html">xml.h</a></ul> <hr><address><small>Generated at Fri Jan 4 18:51:52 2002 for CommonC++ by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.gif" alt="doxygen" align="middle" border=0 width=110 height=53></a>1.2.10 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, © 1997-2001</small></address> </body> </html>