projects / OpenSPARC-T2-SAM / blame
| Commit | Line | Data |
|---|---|---|
| 920dae64 AT |
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| 2 | <html> | |
| 3 | <head> | |
| 4 | <link rel="STYLESHEET" href="lib.css" type='text/css' /> | |
| 5 | <link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" /> | |
| 6 | <link rel='start' href='../index.html' title='Python Documentation Index' /> | |
| 7 | <link rel="first" href="lib.html" title='Python Library Reference' /> | |
| 8 | <link rel='contents' href='contents.html' title="Contents" /> | |
| 9 | <link rel='index' href='genindex.html' title='Index' /> | |
| 10 | <link rel='last' href='about.html' title='About this document...' /> | |
| 11 | <link rel='help' href='about.html' title='About this document...' /> | |
| 12 | <link rel="next" href="boolean-objects.html" /> | |
| 13 | <link rel="prev" href="module-xmlrpclib.html" /> | |
| 14 | <link rel="parent" href="module-xmlrpclib.html" /> | |
| 15 | <link rel="next" href="boolean-objects.html" /> | |
| 16 | <meta name='aesop' content='information' /> | |
| 17 | <title>11.22.1 ServerProxy Objects </title> | |
| 18 | </head> | |
| 19 | <body> | |
| 20 | <DIV CLASS="navigation"> | |
| 21 | <div id='top-navigation-panel' xml:id='top-navigation-panel'> | |
| 22 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
| 23 | <tr> | |
| 24 | <td class='online-navigation'><a rel="prev" title="11.22 xmlrpclib " | |
| 25 | href="module-xmlrpclib.html"><img src='../icons/previous.png' | |
| 26 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
| 27 | <td class='online-navigation'><a rel="parent" title="11.22 xmlrpclib " | |
| 28 | href="module-xmlrpclib.html"><img src='../icons/up.png' | |
| 29 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
| 30 | <td class='online-navigation'><a rel="next" title="11.22.2 Boolean Objects" | |
| 31 | href="boolean-objects.html"><img src='../icons/next.png' | |
| 32 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
| 33 | <td align="center" width="100%">Python Library Reference</td> | |
| 34 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
| 35 | href="contents.html"><img src='../icons/contents.png' | |
| 36 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
| 37 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' | |
| 38 | border='0' height='32' alt='Module Index' width='32' /></a></td> | |
| 39 | <td class='online-navigation'><a rel="index" title="Index" | |
| 40 | href="genindex.html"><img src='../icons/index.png' | |
| 41 | border='0' height='32' alt='Index' width='32' /></A></td> | |
| 42 | </tr></table> | |
| 43 | <div class='online-navigation'> | |
| 44 | <b class="navlabel">Previous:</b> | |
| 45 | <a class="sectref" rel="prev" href="module-xmlrpclib.html">11.22 xmlrpclib </A> | |
| 46 | <b class="navlabel">Up:</b> | |
| 47 | <a class="sectref" rel="parent" href="module-xmlrpclib.html">11.22 xmlrpclib </A> | |
| 48 | <b class="navlabel">Next:</b> | |
| 49 | <a class="sectref" rel="next" href="boolean-objects.html">11.22.2 Boolean Objects</A> | |
| 50 | </div> | |
| 51 | <hr /></div> | |
| 52 | </DIV> | |
| 53 | <!--End of Navigation Panel--> | |
| 54 | ||
| 55 | <H2><A NAME="SECTION00132210000000000000000"></A><A NAME="serverproxy-objects"></A> | |
| 56 | <BR> | |
| 57 | 11.22.1 ServerProxy Objects | |
| 58 | </H2> | |
| 59 | ||
| 60 | <P> | |
| 61 | A <tt class="class">ServerProxy</tt> instance has a method corresponding to | |
| 62 | each remote procedure call accepted by the XML-RPC server. Calling | |
| 63 | the method performs an RPC, dispatched by both name and argument | |
| 64 | signature (e.g. the same method name can be overloaded with multiple | |
| 65 | argument signatures). The RPC finishes by returning a value, which | |
| 66 | may be either returned data in a conformant type or a <tt class="class">Fault</tt> or | |
| 67 | <tt class="class">ProtocolError</tt> object indicating an error. | |
| 68 | ||
| 69 | <P> | |
| 70 | Servers that support the XML introspection API support some common | |
| 71 | methods grouped under the reserved <tt class="member">system</tt> member: | |
| 72 | ||
| 73 | <P> | |
| 74 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
| 75 | <td><nobr><b><tt id='l2h-3699' xml:id='l2h-3699' class="method">system.listMethods</tt></b>(</nobr></td> | |
| 76 | <td><var></var>)</td></tr></table></dt> | |
| 77 | <dd> | |
| 78 | This method returns a list of strings, one for each (non-system) | |
| 79 | method supported by the XML-RPC server. | |
| 80 | </dl> | |
| 81 | ||
| 82 | <P> | |
| 83 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
| 84 | <td><nobr><b><tt id='l2h-3700' xml:id='l2h-3700' class="method">system.methodSignature</tt></b>(</nobr></td> | |
| 85 | <td><var>name</var>)</td></tr></table></dt> | |
| 86 | <dd> | |
| 87 | This method takes one parameter, the name of a method implemented by | |
| 88 | the XML-RPC server.It returns an array of possible signatures for this | |
| 89 | method. A signature is an array of types. The first of these types is | |
| 90 | the return type of the method, the rest are parameters. | |
| 91 | ||
| 92 | <P> | |
| 93 | Because multiple signatures (ie. overloading) is permitted, this method | |
| 94 | returns a list of signatures rather than a singleton. | |
| 95 | ||
| 96 | <P> | |
| 97 | Signatures themselves are restricted to the top level parameters | |
| 98 | expected by a method. For instance if a method expects one array of | |
| 99 | structs as a parameter, and it returns a string, its signature is | |
| 100 | simply "string, array". If it expects three integers and returns a | |
| 101 | string, its signature is "string, int, int, int". | |
| 102 | ||
| 103 | <P> | |
| 104 | If no signature is defined for the method, a non-array value is | |
| 105 | returned. In Python this means that the type of the returned | |
| 106 | value will be something other that list. | |
| 107 | </dl> | |
| 108 | ||
| 109 | <P> | |
| 110 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
| 111 | <td><nobr><b><tt id='l2h-3701' xml:id='l2h-3701' class="method">system.methodHelp</tt></b>(</nobr></td> | |
| 112 | <td><var>name</var>)</td></tr></table></dt> | |
| 113 | <dd> | |
| 114 | This method takes one parameter, the name of a method implemented by | |
| 115 | the XML-RPC server. It returns a documentation string describing the | |
| 116 | use of that method. If no such string is available, an empty string is | |
| 117 | returned. The documentation string may contain HTML markup. | |
| 118 | </dl> | |
| 119 | ||
| 120 | <P> | |
| 121 | Introspection methods are currently supported by servers written in | |
| 122 | PHP, C and Microsoft .NET. Partial introspection support is included | |
| 123 | in recent updates to UserLand Frontier. Introspection support for | |
| 124 | Perl, Python and Java is available at the XML-RPC Hacks page. | |
| 125 | ||
| 126 | <P> | |
| 127 | ||
| 128 | <DIV CLASS="navigation"> | |
| 129 | <div class='online-navigation'> | |
| 130 | <p></p><hr /> | |
| 131 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
| 132 | <tr> | |
| 133 | <td class='online-navigation'><a rel="prev" title="11.22 xmlrpclib " | |
| 134 | href="module-xmlrpclib.html"><img src='../icons/previous.png' | |
| 135 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
| 136 | <td class='online-navigation'><a rel="parent" title="11.22 xmlrpclib " | |
| 137 | href="module-xmlrpclib.html"><img src='../icons/up.png' | |
| 138 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
| 139 | <td class='online-navigation'><a rel="next" title="11.22.2 Boolean Objects" | |
| 140 | href="boolean-objects.html"><img src='../icons/next.png' | |
| 141 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
| 142 | <td align="center" width="100%">Python Library Reference</td> | |
| 143 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
| 144 | href="contents.html"><img src='../icons/contents.png' | |
| 145 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
| 146 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' | |
| 147 | border='0' height='32' alt='Module Index' width='32' /></a></td> | |
| 148 | <td class='online-navigation'><a rel="index" title="Index" | |
| 149 | href="genindex.html"><img src='../icons/index.png' | |
| 150 | border='0' height='32' alt='Index' width='32' /></A></td> | |
| 151 | </tr></table> | |
| 152 | <div class='online-navigation'> | |
| 153 | <b class="navlabel">Previous:</b> | |
| 154 | <a class="sectref" rel="prev" href="module-xmlrpclib.html">11.22 xmlrpclib </A> | |
| 155 | <b class="navlabel">Up:</b> | |
| 156 | <a class="sectref" rel="parent" href="module-xmlrpclib.html">11.22 xmlrpclib </A> | |
| 157 | <b class="navlabel">Next:</b> | |
| 158 | <a class="sectref" rel="next" href="boolean-objects.html">11.22.2 Boolean Objects</A> | |
| 159 | </div> | |
| 160 | </div> | |
| 161 | <hr /> | |
| 162 | <span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span> | |
| 163 | </DIV> | |
| 164 | <!--End of Navigation Panel--> | |
| 165 | <ADDRESS> | |
| 166 | See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. | |
| 167 | </ADDRESS> | |
| 168 | </BODY> | |
| 169 | </HTML> |