<!DOCTYPE html PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN">
<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=
"prev" href=
"node536.html" />
<link rel=
"parent" href=
"module-SocketServer.html" />
<link rel=
"next" href=
"module-BaseHTTPServer.html" />
<meta name='aesop' content='information'
/>
<title>11.16.3 RequestHandler Objects
</title>
<div id='top-navigation-panel' xml:id='top-navigation-panel'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"11.16.2 Server Objects"
href=
"node536.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.16 SocketServer "
href=
"module-SocketServer.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.17 BaseHTTPServer "
href=
"module-BaseHTTPServer.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>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"node536.html">11.16.2 Server Objects
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"module-SocketServer.html">11.16 SocketServer
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"module-BaseHTTPServer.html">11.17 BaseHTTPServer
</A>
<!--End of Navigation Panel-->
<H2><A NAME=
"SECTION00131630000000000000000">
11.16.3 RequestHandler Objects
</A>
The request handler class must define a new
<tt class=
"method">handle()
</tt> method,
and can override any of the following methods. A new instance is
created for each request.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3565' xml:id='l2h-
3565'
class=
"function">finish
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Called after the
<tt class=
"method">handle()
</tt> method to perform any clean-up
actions required. The default implementation does nothing. If
<tt class=
"method">setup()
</tt> or
<tt class=
"method">handle()
</tt> raise an exception, this
function will not be called.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3566' xml:id='l2h-
3566'
class=
"function">handle
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
This function must do all the work required to service a request.
The default implementation does nothing.
Several instance attributes are available to it; the request is
available as
<tt class=
"member">self.request
</tt>; the client address as
<tt class=
"member">self.client_address
</tt>; and the server instance as
<tt class=
"member">self.server
</tt>, in case it needs access to per-server
The type of
<tt class=
"member">self.request
</tt> is different for datagram or stream
services. For stream services,
<tt class=
"member">self.request
</tt> is a socket
object; for datagram services,
<tt class=
"member">self.request
</tt> is a string.
However, this can be hidden by using the request handler subclasses
<tt class=
"class">StreamRequestHandler
</tt> or
<tt class=
"class">DatagramRequestHandler
</tt>, which
override the
<tt class=
"method">setup()
</tt> and
<tt class=
"method">finish()
</tt> methods, and
provide
<tt class=
"member">self.rfile
</tt> and
<tt class=
"member">self.wfile
</tt> attributes.
<tt class=
"member">self.rfile
</tt> and
<tt class=
"member">self.wfile
</tt> can be read or written,
respectively, to get the request data or return data to the client.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3567' xml:id='l2h-
3567'
class=
"function">setup
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Called before the
<tt class=
"method">handle()
</tt> method to perform any
initialization actions required. The default implementation does
<div class='online-navigation'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"11.16.2 Server Objects"
href=
"node536.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.16 SocketServer "
href=
"module-SocketServer.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.17 BaseHTTPServer "
href=
"module-BaseHTTPServer.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>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"node536.html">11.16.2 Server Objects
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"module-SocketServer.html">11.16 SocketServer
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"module-BaseHTTPServer.html">11.17 BaseHTTPServer
</A>
<span class=
"release-info">Release
2.4.2, documentation updated on
28 September
2005.
</span>
<!--End of Navigation Panel-->
See
<i><a href=
"about.html">About this document...
</a></i> for information on suggesting changes.