vcs.maemo.org Git - xmlrpc-c/blob - tools/xmlrpc_transport/xmlrpc_transport.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
   2 <title>Xmlrpc_transport User Manual</title>
   3 <body>
   4
   5 <p><b>xmlrpc_transport</b> transports data to a server as if to make an
   6 XML-RPC remote procedure call and displays the response from the server.
   7
   8 <p>You supply the call in XML form on Standard Input and get the response
   9 in XML form on Standard Output.  <b>xmlrpc_transport</b> doesn't really know
  10 anything about XML; it sends the characters you supply and displays the
  11 characters it gets back.
  12
  13 <p><b>xmlrpc_transport</b> uses the lower levels of the XML-RPC For C/C++
  14 client libraries.
  15
  16 <p>This program is mainly useful for debugging and learning about
  17 XML-RPC servers and the XML-RPC For C/C++ client XML transports.
  18
  19
  20 <h2>Examples</h2>
  21
  22 &lt;
  23
  24 <pre>
  25 <tt>
  26      $ xmlrpc_transport http://localhost:8080/RPC2 &lt;&lt;-EOF
  27         &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  28         &lt;methodCall&gt;
  29         &lt;methodName&gt;sample.add&lt;/methodName&gt;
  30         &lt;params&gt;
  31         &lt;param&gt;&lt;value&gt;&lt;i4&gt;5&lt;/i4&gt;&lt;/value&gt;&lt;/param&gt;
  32         &lt;param&gt;&lt;value&gt;&lt;i4&gt;7&lt;/i4&gt;&lt;/value&gt;&lt;/param&gt;
  33         &lt;/params&gt;
  34         &lt;/methodCall&gt;
  35         EOF
  36      &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  37      &lt;methodResponse&gt;
  38      &lt;params&gt;
  39      &lt;param&gt;&lt;value&gt;&lt;i4&gt;12&lt;/i4&gt;&lt;/value&gt;&lt;/param&gt;
  40      &lt;/params&gt;
  41      &lt;/methodResponse&gt;
  42 </tt>
  43 </pre>
  44
  45 <h2>Overview</h2>
  46 <p>
  47 <b>xmlrpc_transport</b>
  48 <i>url</i>
  49 [<b>-transport=</b><i>transportname</i>]
  50 [<b>-username=</b><i>username</i> <b>-password=</b><i>password</i>]
  51
  52 <P>Minimum unique abbreviation of option is acceptable.  You may use double
  53 hyphens instead of single hyphen to denote options.  You may use white
  54 space in place of the equals sign to separate an option name from its value.
  55
  56
  57 <h2>Arguments</h2>
  58
  59 <dl>
  60 <dt><i>url</i>
  61
  62 <dd>This is the URL of the XML-RPC server.  As XML-RPC uses HTTP, this
  63 must be an HTTP url.  However, if you don't specify a type (&quot;http:&quot;)
  64 in the URL, <b>xmlrpc_transport</b> assumes an &quot;http://&quot; prefix and a
  65 &quot;/RPC2&quot; suffix.  <b>RPC2</b> is the conventional file name for
  66 an XML-RPC responder.
  67
  68 </dl>
  69
  70
  71 <h2>Options</h2>
  72
  73 <dl>
  74 <dt><b>-transport=</b><i>transportname</i>
  75
  76 <dd>This selects the XML transport facility (e.g. libwww) that
  77 <b>xmlrpc_transport</b> uses to perform the RPC.
  78
  79 <p>The name <i>transportname</i> is one that the Xmlrpc-c programming
  80 library recognizes.  This is typically <b>libwww</b>, <b>curl</b>, and
  81 <b>wininet</b>.
  82
  83 <p>By default, <b>xmlrpc_transport</b> lets the Xmlrpc-c library choose.
  84
  85 <dt><b>-username=</b><i>username</i>
  86 <dt><b>-password=</b><i>password</i>
  87
  88 <dd>These options, which must be used together, cause the client to
  89 authenticate itself to the server, if the server requires it, using
  90 HTTP Basic Authentication and the specified username and password.
  91
  92 </dl>
  93
  94 </body>
  95