[OpenSPARC-T2-SAM] / sam-t2 / devtools / amd64 / html / python / lib / doc-xmlrpc-servers.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="lib.html" title='Python Library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="node567.html" />
<link rel="prev" href="module-DocXMLRPCServer.html" />
<link rel="parent" href="module-DocXMLRPCServer.html" />
<link rel="next" href="node567.html" />
<meta name='aesop' content='information' />
<title>11.24.1 DocXMLRPCServer Objects </title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="11.24 DocXMLRPCServer  "
  href="module-DocXMLRPCServer.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="11.24 DocXMLRPCServer  "
  href="module-DocXMLRPCServer.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="11.24.2 DocCGIXMLRPCRequestHandler"
  href="node567.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-DocXMLRPCServer.html">11.24 DocXMLRPCServer  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-DocXMLRPCServer.html">11.24 DocXMLRPCServer  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="node567.html">11.24.2 DocCGIXMLRPCRequestHandler</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION00132410000000000000000"></A><A NAME="doc-xmlrpc-servers"></A>
<BR>
11.24.1 DocXMLRPCServer Objects 
</H2>

<P>
The <tt class="class">DocXMLRPCServer</tt> class is derived from
<tt class="class">SimpleXMLRPCServer.SimpleXMLRPCServer</tt> and provides a means of
creating self-documenting, stand alone XML-RPC servers. HTTP POST
requests are handled as XML-RPC method calls. HTTP GET requests are
handled by generating pydoc-style HTML documentation. This allows a
server to provide its own web-based documentation.

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3736' xml:id='l2h-3736' class="method">set_server_title</tt></b>(</nobr></td>
  <td><var>server_title</var>)</td></tr></table></dt>
<dd>

<P>
Set the title used in the generated HTML documentation. This title
will be used inside the HTML "title" element.

<P>
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3737' xml:id='l2h-3737' class="method">set_server_name</tt></b>(</nobr></td>
  <td><var>server_name</var>)</td></tr></table></dt>
<dd>

<P>
Set the name used in the generated HTML documentation. This name will
appear at the top of the generated documentation inside a "h1"
element.

<P>
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3738' xml:id='l2h-3738' class="method">set_server_documentation</tt></b>(</nobr></td>
  <td><var>server_documentation</var>)</td></tr></table></dt>
<dd>

<P>
Set the description used in the generated HTML documentation. This
description will appear as a paragraph, below the server name, in the
documentation.

<P>
</dl>

<P>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="11.24 DocXMLRPCServer  "
  href="module-DocXMLRPCServer.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="11.24 DocXMLRPCServer  "
  href="module-DocXMLRPCServer.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="11.24.2 DocCGIXMLRPCRequestHandler"
  href="node567.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-DocXMLRPCServer.html">11.24 DocXMLRPCServer  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-DocXMLRPCServer.html">11.24 DocXMLRPCServer  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="node567.html">11.24.2 DocCGIXMLRPCRequestHandler</A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>
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="node567.html" />
	13	<link rel="prev" href="module-DocXMLRPCServer.html" />
	14	<link rel="parent" href="module-DocXMLRPCServer.html" />
	15	<link rel="next" href="node567.html" />
	16	<meta name='aesop' content='information' />
	17	<title>11.24.1 DocXMLRPCServer 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.24 DocXMLRPCServer "
	25	href="module-DocXMLRPCServer.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.24 DocXMLRPCServer "
	28	href="module-DocXMLRPCServer.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.24.2 DocCGIXMLRPCRequestHandler"
	31	href="node567.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-DocXMLRPCServer.html">11.24 DocXMLRPCServer </A>
	46	<b class="navlabel">Up:</b>
	47	<a class="sectref" rel="parent" href="module-DocXMLRPCServer.html">11.24 DocXMLRPCServer </A>
	48	<b class="navlabel">Next:</b>
	49	<a class="sectref" rel="next" href="node567.html">11.24.2 DocCGIXMLRPCRequestHandler</A>
	50	</div>
	51	<hr /></div>
	52	</DIV>
	53	<!--End of Navigation Panel-->
	54
	55	<H2><A NAME="SECTION00132410000000000000000"></A><A NAME="doc-xmlrpc-servers"></A>
	56	<BR>
	57	11.24.1 DocXMLRPCServer Objects
	58	</H2>
	59
	60	<P>
	61	The <tt class="class">DocXMLRPCServer</tt> class is derived from
	62	<tt class="class">SimpleXMLRPCServer.SimpleXMLRPCServer</tt> and provides a means of
	63	creating self-documenting, stand alone XML-RPC servers. HTTP POST
	64	requests are handled as XML-RPC method calls. HTTP GET requests are
65	handled by generating pydoc-style HTML documentation. This allows a
66	server to provide its own web-based documentation.
67
68	<P>
69	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
70	<td><nobr><b><tt id='l2h-3736' xml:id='l2h-3736' class="method">set_server_title</tt></b>(</nobr></td>
71	<td><var>server_title</var>)</td></tr></table></dt>
72	<dd>
73
74	<P>
75	Set the title used in the generated HTML documentation. This title
76	will be used inside the HTML "title" element.
77
78	<P>
79	</dl>
80
81	<P>
82	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
83	<td><nobr><b><tt id='l2h-3737' xml:id='l2h-3737' class="method">set_server_name</tt></b>(</nobr></td>
84	<td><var>server_name</var>)</td></tr></table></dt>
85	<dd>
86
87	<P>
88	Set the name used in the generated HTML documentation. This name will
89	appear at the top of the generated documentation inside a "h1"
90	element.
91
92	<P>
93	</dl>
94
95	<P>
96	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
97	<td><nobr><b><tt id='l2h-3738' xml:id='l2h-3738' class="method">set_server_documentation</tt></b>(</nobr></td>
98	<td><var>server_documentation</var>)</td></tr></table></dt>
99	<dd>
100
101	<P>
102	Set the description used in the generated HTML documentation. This
103	description will appear as a paragraph, below the server name, in the
104	documentation.
105
106	<P>
107	</dl>
108
109	<P>
110
111	<DIV CLASS="navigation">
112	<div class='online-navigation'>
113	<p></p><hr />
114	<table align="center" width="100%" cellpadding="0" cellspacing="2">
115	<tr>
116	<td class='online-navigation'><a rel="prev" title="11.24 DocXMLRPCServer "
117	href="module-DocXMLRPCServer.html"><img src='../icons/previous.png'
118	border='0' height='32' alt='Previous Page' width='32' /></A></td>
119	<td class='online-navigation'><a rel="parent" title="11.24 DocXMLRPCServer "
120	href="module-DocXMLRPCServer.html"><img src='../icons/up.png'
121	border='0' height='32' alt='Up One Level' width='32' /></A></td>
122	<td class='online-navigation'><a rel="next" title="11.24.2 DocCGIXMLRPCRequestHandler"
123	href="node567.html"><img src='../icons/next.png'
124	border='0' height='32' alt='Next Page' width='32' /></A></td>
125	<td align="center" width="100%">Python Library Reference</td>
126	<td class='online-navigation'><a rel="contents" title="Table of Contents"
127	href="contents.html"><img src='../icons/contents.png'
128	border='0' height='32' alt='Contents' width='32' /></A></td>
129	<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
130	border='0' height='32' alt='Module Index' width='32' /></a></td>
131	<td class='online-navigation'><a rel="index" title="Index"
132	href="genindex.html"><img src='../icons/index.png'
133	border='0' height='32' alt='Index' width='32' /></A></td>
134	</tr></table>
135	<div class='online-navigation'>
136	<b class="navlabel">Previous:</b>
137	<a class="sectref" rel="prev" href="module-DocXMLRPCServer.html">11.24 DocXMLRPCServer </A>
138	<b class="navlabel">Up:</b>
139	<a class="sectref" rel="parent" href="module-DocXMLRPCServer.html">11.24 DocXMLRPCServer </A>
140	<b class="navlabel">Next:</b>
141	<a class="sectref" rel="next" href="node567.html">11.24.2 DocCGIXMLRPCRequestHandler</A>
142	</div>
143	</div>
144	<hr />
145	<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
146	</DIV>
147	<!--End of Navigation Panel-->
148	<ADDRESS>
149	See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
150	</ADDRESS>
151	</BODY>
152	</HTML>