[OpenSPARC-T2-SAM] / sam-t2 / devtools / v9 / html / python / lib / module-DocXMLRPCServer.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="module-asyncore.html" />
<link rel="prev" href="module-SimpleXMLRPCServer.html" />
<link rel="parent" href="internet.html" />
<link rel="next" href="doc-xmlrpc-servers.html" />
<meta name='aesop' content='information' />
<title>11.24 DocXMLRPCServer -- Self-documenting XML-RPC server</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.23.2 CGIXMLRPCRequestHandler"
  href="node564.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. Internet Protocols and"
  href="internet.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.1 DocXMLRPCServer Objects"
  href="doc-xmlrpc-servers.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="node564.html">11.23.2 CGIXMLRPCRequestHandler</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="internet.html">11. Internet Protocols and</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="doc-xmlrpc-servers.html">11.24.1 DocXMLRPCServer Objects</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H1><A NAME="SECTION00132400000000000000000">
11.24 <tt class="module">DocXMLRPCServer</tt> --
         Self-documenting XML-RPC server</A>
</H1>

<P>
<A NAME="module-DocXMLRPCServer"></A>

<P>

<span class="versionnote">New in version 2.3.</span>

<P>
The <tt class="module">DocXMLRPCServer</tt> module extends the classes found in
<tt class="module">SimpleXMLRPCServer</tt> to serve HTML documentation in response to
HTTP GET requests. Servers can either be free standing, using
<tt class="class">DocXMLRPCServer</tt>, or embedded in a CGI environment, using
<tt class="class">DocCGIXMLRPCRequestHandler</tt>.

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><span class="typelabel">class</span>&nbsp;<tt id='l2h-3733' xml:id='l2h-3733' class="class">DocXMLRPCServer</tt></b>(</nobr></td>
  <td><var>addr</var><big>[</big><var>, 
                                   requestHandler</var><big>[</big><var>, logRequests</var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>

<P>
Create a new server instance. All parameters have the same meaning as
for <tt class="class">SimpleXMLRPCServer.SimpleXMLRPCServer</tt>;
<var>requestHandler</var> defaults to <tt class="class">DocXMLRPCRequestHandler</tt>.

<P>
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><span class="typelabel">class</span>&nbsp;<tt id='l2h-3734' xml:id='l2h-3734' class="class">DocCGIXMLRPCRequestHandler</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>

<P>
Create a new instance to handle XML-RPC requests in a CGI environment.

<P>
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><span class="typelabel">class</span>&nbsp;<tt id='l2h-3735' xml:id='l2h-3735' class="class">DocXMLRPCRequestHandler</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>

<P>
Create a new request handler instance. This request handler supports
XML-RPC POST requests, documentation GET requests, and modifies
logging so that the <var>logRequests</var> parameter to the
<tt class="class">DocXMLRPCServer</tt> constructor parameter is honored.

<P>
</dl>

<P>

<p><br /></p><hr class='online-navigation' />
<div class='online-navigation'>
<!--Table of Child-Links-->
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></a>

<UL CLASS="ChildLinks">
<LI><A href="doc-xmlrpc-servers.html">11.24.1 DocXMLRPCServer Objects</a>
<LI><A href="node567.html">11.24.2 DocCGIXMLRPCRequestHandler</a>
</ul>
<!--End of Table of Child-Links-->
</div>

<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.23.2 CGIXMLRPCRequestHandler"
  href="node564.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. Internet Protocols and"
  href="internet.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.1 DocXMLRPCServer Objects"
  href="doc-xmlrpc-servers.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="node564.html">11.23.2 CGIXMLRPCRequestHandler</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="internet.html">11. Internet Protocols and</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="doc-xmlrpc-servers.html">11.24.1 DocXMLRPCServer Objects</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="module-asyncore.html" />
	13	<link rel="prev" href="module-SimpleXMLRPCServer.html" />
	14	<link rel="parent" href="internet.html" />
	15	<link rel="next" href="doc-xmlrpc-servers.html" />
	16	<meta name='aesop' content='information' />
	17	<title>11.24 DocXMLRPCServer -- Self-documenting XML-RPC server</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.23.2 CGIXMLRPCRequestHandler"
	25	href="node564.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. Internet Protocols and"
	28	href="internet.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.1 DocXMLRPCServer Objects"
	31	href="doc-xmlrpc-servers.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="node564.html">11.23.2 CGIXMLRPCRequestHandler</A>
	46	<b class="navlabel">Up:</b>
	47	<a class="sectref" rel="parent" href="internet.html">11. Internet Protocols and</A>
	48	<b class="navlabel">Next:</b>
	49	<a class="sectref" rel="next" href="doc-xmlrpc-servers.html">11.24.1 DocXMLRPCServer Objects</A>
	50	</div>
	51	<hr /></div>
	52	</DIV>
	53	<!--End of Navigation Panel-->
	54
	55	<H1><A NAME="SECTION00132400000000000000000">
	56	11.24 <tt class="module">DocXMLRPCServer</tt> --
	57	Self-documenting XML-RPC server</A>
	58	</H1>
	59
	60	<P>
	61	<A NAME="module-DocXMLRPCServer"></A>
	62
	63	<P>
	64
65	<span class="versionnote">New in version 2.3.</span>
66
67	<P>
68	The <tt class="module">DocXMLRPCServer</tt> module extends the classes found in
69	<tt class="module">SimpleXMLRPCServer</tt> to serve HTML documentation in response to
70	HTTP GET requests. Servers can either be free standing, using
71	<tt class="class">DocXMLRPCServer</tt>, or embedded in a CGI environment, using
72	<tt class="class">DocCGIXMLRPCRequestHandler</tt>.
73
74	<P>
75	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
76	<td><nobr><b><span class="typelabel">class</span> <tt id='l2h-3733' xml:id='l2h-3733' class="class">DocXMLRPCServer</tt></b>(</nobr></td>
77	<td><var>addr</var><big>[</big><var>,
78	requestHandler</var><big>[</big><var>, logRequests</var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt>
79	<dd>
80
81	<P>
82	Create a new server instance. All parameters have the same meaning as
83	for <tt class="class">SimpleXMLRPCServer.SimpleXMLRPCServer</tt>;
84	<var>requestHandler</var> defaults to <tt class="class">DocXMLRPCRequestHandler</tt>.
85
86	<P>
87	</dl>
88
89	<P>
90	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
91	<td><nobr><b><span class="typelabel">class</span> <tt id='l2h-3734' xml:id='l2h-3734' class="class">DocCGIXMLRPCRequestHandler</tt></b>(</nobr></td>
92	<td><var></var>)</td></tr></table></dt>
93	<dd>
94
95	<P>
96	Create a new instance to handle XML-RPC requests in a CGI environment.
97
98	<P>
99	</dl>
100
101	<P>
102	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
103	<td><nobr><b><span class="typelabel">class</span> <tt id='l2h-3735' xml:id='l2h-3735' class="class">DocXMLRPCRequestHandler</tt></b>(</nobr></td>
104	<td><var></var>)</td></tr></table></dt>
105	<dd>
106
107	<P>
108	Create a new request handler instance. This request handler supports
109	XML-RPC POST requests, documentation GET requests, and modifies
110	logging so that the <var>logRequests</var> parameter to the
111	<tt class="class">DocXMLRPCServer</tt> constructor parameter is honored.
112
113	<P>
114	</dl>
115
116	<P>
117
118	<p><br /></p><hr class='online-navigation' />
119	<div class='online-navigation'>
120	<!--Table of Child-Links-->
121	<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></a>
122
123	<UL CLASS="ChildLinks">
124	<LI><A href="doc-xmlrpc-servers.html">11.24.1 DocXMLRPCServer Objects</a>
125	<LI><A href="node567.html">11.24.2 DocCGIXMLRPCRequestHandler</a>
126	</ul>
127	<!--End of Table of Child-Links-->
128	</div>
129
130	<DIV CLASS="navigation">
131	<div class='online-navigation'>
132	<p></p><hr />
133	<table align="center" width="100%" cellpadding="0" cellspacing="2">
134	<tr>
135	<td class='online-navigation'><a rel="prev" title="11.23.2 CGIXMLRPCRequestHandler"
136	href="node564.html"><img src='../icons/previous.png'
137	border='0' height='32' alt='Previous Page' width='32' /></A></td>
138	<td class='online-navigation'><a rel="parent" title="11. Internet Protocols and"
139	href="internet.html"><img src='../icons/up.png'
140	border='0' height='32' alt='Up One Level' width='32' /></A></td>
141	<td class='online-navigation'><a rel="next" title="11.24.1 DocXMLRPCServer Objects"
142	href="doc-xmlrpc-servers.html"><img src='../icons/next.png'
143	border='0' height='32' alt='Next Page' width='32' /></A></td>
144	<td align="center" width="100%">Python Library Reference</td>
145	<td class='online-navigation'><a rel="contents" title="Table of Contents"
146	href="contents.html"><img src='../icons/contents.png'
147	border='0' height='32' alt='Contents' width='32' /></A></td>
148	<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
149	border='0' height='32' alt='Module Index' width='32' /></a></td>
150	<td class='online-navigation'><a rel="index" title="Index"
151	href="genindex.html"><img src='../icons/index.png'
152	border='0' height='32' alt='Index' width='32' /></A></td>
153	</tr></table>
154	<div class='online-navigation'>
155	<b class="navlabel">Previous:</b>
156	<a class="sectref" rel="prev" href="node564.html">11.23.2 CGIXMLRPCRequestHandler</A>
157	<b class="navlabel">Up:</b>
158	<a class="sectref" rel="parent" href="internet.html">11. Internet Protocols and</A>
159	<b class="navlabel">Next:</b>
160	<a class="sectref" rel="next" href="doc-xmlrpc-servers.html">11.24.1 DocXMLRPCServer Objects</A>
161	</div>
162	</div>
163	<hr />
164	<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
165	</DIV>
166	<!--End of Navigation Panel-->
167	<ADDRESS>
168	See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
169	</ADDRESS>
170	</BODY>
171	</HTML>