1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
|
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Gnumed.proxiedpyjamas.jsonserver.SimpleJSONRPCRequestHandler</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="Gnumed-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://www.gnumed.org">GNUmed Never Sleeps</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="Gnumed-module.html">Package Gnumed</a> ::
<a href="Gnumed.proxiedpyjamas-module.html">Package proxiedpyjamas</a> ::
<a href="Gnumed.proxiedpyjamas.jsonserver-module.html">Module jsonserver</a> ::
Class SimpleJSONRPCRequestHandler
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="Gnumed.proxiedpyjamas.jsonserver.SimpleJSONRPCRequestHandler-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class SimpleJSONRPCRequestHandler</h1><p class="nomargin-top"><span class="codelink"><a href="Gnumed.proxiedpyjamas.jsonserver-pysrc.html#SimpleJSONRPCRequestHandler">source code</a></span></p>
<pre class="base-tree">
SocketServer.BaseRequestHandler --+
|
SocketServer.StreamRequestHandler --+
|
BaseHTTPServer.BaseHTTPRequestHandler --+
|
SimpleHTTPServer.SimpleHTTPRequestHandler --+
|
<strong class="uidshort">SimpleJSONRPCRequestHandler</strong>
</pre>
<hr />
<p>Simple JSONRPC request handler class and HTTP GET Server</p>
<p>Handles all HTTP POST requests and attempts to decode them as JSONRPC
requests.</p>
<p>Handles all HTTP GET requests and serves the content from the current
directory.</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Instance Methods</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="is_rpc_path_valid"></a><span class="summary-sig-name">is_rpc_path_valid</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Gnumed.proxiedpyjamas.jsonserver-pysrc.html#SimpleJSONRPCRequestHandler.is_rpc_path_valid">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Gnumed.proxiedpyjamas.jsonserver.SimpleJSONRPCRequestHandler-class.html#send_head" class="summary-sig-name">send_head</a>(<span class="summary-sig-arg">self</span>)</span><br />
Common code for GET and HEAD commands.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Gnumed.proxiedpyjamas.jsonserver-pysrc.html#SimpleJSONRPCRequestHandler.send_head">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Gnumed.proxiedpyjamas.jsonserver.SimpleJSONRPCRequestHandler-class.html#list_directory" class="summary-sig-name">list_directory</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">path</span>)</span><br />
Helper to produce a directory listing (absent index.html).</td>
<td align="right" valign="top">
<span class="codelink"><a href="Gnumed.proxiedpyjamas.jsonserver-pysrc.html#SimpleJSONRPCRequestHandler.list_directory">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Gnumed.proxiedpyjamas.jsonserver.SimpleJSONRPCRequestHandler-class.html#send_error" class="summary-sig-name">send_error</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">code</span>,
<span class="summary-sig-arg">message</span>=<span class="summary-sig-default">None</span>)</span><br />
Send and log an error reply.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Gnumed.proxiedpyjamas.jsonserver-pysrc.html#SimpleJSONRPCRequestHandler.send_error">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Gnumed.proxiedpyjamas.jsonserver.SimpleJSONRPCRequestHandler-class.html#do_POST" class="summary-sig-name">do_POST</a>(<span class="summary-sig-arg">self</span>)</span><br />
Handles the HTTP POST request.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Gnumed.proxiedpyjamas.jsonserver-pysrc.html#SimpleJSONRPCRequestHandler.do_POST">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="report_404"></a><span class="summary-sig-name">report_404</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Gnumed.proxiedpyjamas.jsonserver-pysrc.html#SimpleJSONRPCRequestHandler.report_404">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Gnumed.proxiedpyjamas.jsonserver.SimpleJSONRPCRequestHandler-class.html#log_request" class="summary-sig-name">log_request</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">code</span>=<span class="summary-sig-default">'-'</span>,
<span class="summary-sig-arg">size</span>=<span class="summary-sig-default">'-'</span>)</span><br />
Selectively log an accepted request.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Gnumed.proxiedpyjamas.jsonserver-pysrc.html#SimpleJSONRPCRequestHandler.log_request">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>SimpleHTTPServer.SimpleHTTPRequestHandler</code></b>:
<code>copyfile</code>,
<code>do_GET</code>,
<code>do_HEAD</code>,
<code>guess_type</code>,
<code>translate_path</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>BaseHTTPServer.BaseHTTPRequestHandler</code></b>:
<code>address_string</code>,
<code>date_time_string</code>,
<code>end_headers</code>,
<code>handle</code>,
<code>handle_one_request</code>,
<code>log_date_time_string</code>,
<code>log_error</code>,
<code>log_message</code>,
<code>parse_request</code>,
<code>send_header</code>,
<code>send_response</code>,
<code>version_string</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>SocketServer.StreamRequestHandler</code></b>:
<code>finish</code>,
<code>setup</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>SocketServer.BaseRequestHandler</code></b>:
<code>__init__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Class Variables</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="rpc_paths"></a><span class="summary-name">rpc_paths</span> = <code title="'/', '/JSON'">'/', '/JSON'</code>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>SimpleHTTPServer.SimpleHTTPRequestHandler</code></b>:
<code>extensions_map</code>,
<code>server_version</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>BaseHTTPServer.BaseHTTPRequestHandler</code></b>:
<code>MessageClass</code>,
<code>default_request_version</code>,
<code>error_content_type</code>,
<code>error_message_format</code>,
<code>monthname</code>,
<code>protocol_version</code>,
<code>responses</code>,
<code>sys_version</code>,
<code>weekdayname</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>SocketServer.StreamRequestHandler</code></b>:
<code>rbufsize</code>,
<code>wbufsize</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="send_head"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">send_head</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Gnumed.proxiedpyjamas.jsonserver-pysrc.html#SimpleJSONRPCRequestHandler.send_head">source code</a></span>
</td>
</tr></table>
<p>Common code for GET and HEAD commands.</p>
<p>This sends the response code and MIME headers.</p>
<p>Return value is either a file object (which has to be copied to the
outputfile by the caller unless the command was HEAD, and must be closed
by the caller under all circumstances), or None, in which case the caller
has nothing further to do.</p>
<dl class="fields">
<dt>Overrides:
SimpleHTTPServer.SimpleHTTPRequestHandler.send_head
</dt>
</dl>
</td></tr></table>
</div>
<a name="list_directory"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">list_directory</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">path</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Gnumed.proxiedpyjamas.jsonserver-pysrc.html#SimpleJSONRPCRequestHandler.list_directory">source code</a></span>
</td>
</tr></table>
<p>Helper to produce a directory listing (absent index.html).</p>
<p>Return value is either a file object, or None (indicating an error).
In either case, the headers are sent, making the interface the same as
for send_head().</p>
<dl class="fields">
<dt>Overrides:
SimpleHTTPServer.SimpleHTTPRequestHandler.list_directory
</dt>
</dl>
</td></tr></table>
</div>
<a name="send_error"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">send_error</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">code</span>,
<span class="sig-arg">message</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Gnumed.proxiedpyjamas.jsonserver-pysrc.html#SimpleJSONRPCRequestHandler.send_error">source code</a></span>
</td>
</tr></table>
<p>Send and log an error reply.</p>
<p>Arguments are the error code, and a detailed message. The detailed
message defaults to the short entry matching the response code.</p>
<p>This sends an error response (so it must be called before any output
has been generated), logs the error, and finally sends a piece of HTML
explaining the error to the user.</p>
<dl class="fields">
<dt>Overrides:
BaseHTTPServer.BaseHTTPRequestHandler.send_error
</dt>
</dl>
</td></tr></table>
</div>
<a name="do_POST"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">do_POST</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Gnumed.proxiedpyjamas.jsonserver-pysrc.html#SimpleJSONRPCRequestHandler.do_POST">source code</a></span>
</td>
</tr></table>
<p>Handles the HTTP POST request.</p>
<p>Attempts to interpret all HTTP POST requests as XML-RPC calls, which
are forwarded to the server's _dispatch method for handling.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="log_request"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">log_request</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">code</span>=<span class="sig-default">'-'</span>,
<span class="sig-arg">size</span>=<span class="sig-default">'-'</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Gnumed.proxiedpyjamas.jsonserver-pysrc.html#SimpleJSONRPCRequestHandler.log_request">source code</a></span>
</td>
</tr></table>
<p>Selectively log an accepted request.</p>
<dl class="fields">
<dt>Overrides:
BaseHTTPServer.BaseHTTPRequestHandler.log_request
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="Gnumed-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://www.gnumed.org">GNUmed Never Sleeps</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Mon Jun 25 03:58:09 2012
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|
