libsocksvr.tex 8.19 KB
Newer Older
Fred Drake's avatar
Fred Drake committed
1
\section{\module{SocketServer} ---
2
         A framework for network servers}
3

4
\declaremodule{standard}{SocketServer}
5 6
\modulesynopsis{A framework for network servers.}

7

Fred Drake's avatar
Fred Drake committed
8
The \module{SocketServer} module simplifies the task of writing network
9
servers.
10

Fred Drake's avatar
Fred Drake committed
11
There are four basic server classes: \class{TCPServer} uses the
12
Internet TCP protocol, which provides for continuous streams of data
Fred Drake's avatar
Fred Drake committed
13
between the client and server.  \class{UDPServer} uses datagrams, which
14 15
are discrete packets of information that may arrive out of order or be
lost while in transit.  The more infrequently used
Fred Drake's avatar
Fred Drake committed
16
\class{UnixStreamServer} and \class{UnixDatagramServer} classes are
17 18
similar, but use \UNIX{} domain sockets; they're not available on
non-\UNIX{} platforms.  For more details on network programming, consult
19 20
a book such as W. Richard Steven's \citetitle{UNIX Network Programming}
or Ralph Davis's \citetitle{Win32 Network Programming}.
21 22 23 24 25 26 27

These four classes process requests \dfn{synchronously}; each request
must be completed before the next request can be started.  This isn't
suitable if each request takes a long time to complete, because it
requires a lot of computation, or because it returns a lot of data
which the client is slow to process.  The solution is to create a
separate process or thread to handle each request; the
Fred Drake's avatar
Fred Drake committed
28
\class{ForkingMixIn} and \class{ThreadingMixIn} mix-in classes can be
29 30 31
used to support asynchronous behaviour.

Creating a server requires several steps.  First, you must create a
Fred Drake's avatar
Fred Drake committed
32 33
request handler class by subclassing the \class{BaseRequestHandler}
class and overriding its \method{handle()} method; this method will
34 35
process incoming requests.  Second, you must instantiate one of the
server classes, passing it the server's address and the request
Fred Drake's avatar
Fred Drake committed
36 37
handler class.  Finally, call the \method{handle_request()} or
\method{serve_forever()} method of the server object to process one or
38 39 40 41 42
many requests.

Server classes have the same external methods and attributes, no
matter what network protocol they use:

43
\setindexsubitem{(SocketServer protocol)}
44

45 46 47 48 49 50 51
%XXX should data and methods be intermingled, or separate?
% how should the distinction between class and instance variables be
% drawn?

\begin{funcdesc}{fileno}{}
Return an integer file descriptor for the socket on which the server
is listening.  This function is most commonly passed to
Fred Drake's avatar
Fred Drake committed
52
\function{select.select()}, to allow monitoring multiple servers in the
53 54 55 56 57
same process.
\end{funcdesc}

\begin{funcdesc}{handle_request}{}
Process a single request.  This function calls the following methods
Fred Drake's avatar
Fred Drake committed
58 59 60 61
in order: \method{get_request()}, \method{verify_request()}, and
\method{process_request()}.  If the user-provided \method{handle()}
method of the handler class raises an exception, the server's
\method{handle_error()} method will be called.
62 63 64 65
\end{funcdesc}

\begin{funcdesc}{serve_forever}{}
Handle an infinite number of requests.  This simply calls
Fred Drake's avatar
Fred Drake committed
66
\method{handle_request()} inside an infinite loop.
67 68 69 70
\end{funcdesc}

\begin{datadesc}{address_family}
The family of protocols to which the server's socket belongs.
Fred Drake's avatar
Fred Drake committed
71 72
\constant{socket.AF_INET} and \constant{socket.AF_UNIX} are two
possible values.
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
\end{datadesc}

\begin{datadesc}{RequestHandlerClass}
The user-provided request handler class; an instance of this class is
created for each request.
\end{datadesc}

\begin{datadesc}{server_address}
The address on which the server is listening.  The format of addresses
varies depending on the protocol family; see the documentation for the
socket module for details.  For Internet protocols, this is a tuple
containing a string giving the address, and an integer port number:
\code{('127.0.0.1', 80)}, for example.
\end{datadesc}

\begin{datadesc}{socket}
The socket object on which the server will listen for incoming requests.
\end{datadesc}

% XXX should class variables be covered before instance variables, or
% vice versa?

The server classes support the following class variables:

97 98 99 100 101
\begin{datadesc}{allow_reuse_address}
Whether the server will allow the reuse of an address. This defaults
to true, and can be set in subclasses to change the policy.
\end{datadesc}

102 103 104
\begin{datadesc}{request_queue_size}
The size of the request queue.  If it takes a long time to process a
single request, any requests that arrive while the server is busy are
Fred Drake's avatar
Fred Drake committed
105
placed into a queue, up to \member{request_queue_size} requests.  Once
106 107 108 109 110 111
the queue is full, further requests from clients will get a
``Connection denied'' error.  The default value is usually 5, but this
can be overridden by subclasses.
\end{datadesc}

\begin{datadesc}{socket_type}
Fred Drake's avatar
Fred Drake committed
112 113
The type of socket used by the server; \constant{socket.SOCK_STREAM}
and \constant{socket.SOCK_DGRAM} are two possible values.
114 115 116
\end{datadesc}

There are various server methods that can be overridden by subclasses
Fred Drake's avatar
Fred Drake committed
117
of base server classes like \class{TCPServer}; these methods aren't
118 119 120 121 122 123 124
useful to external users of the server object.

% should the default implementations of these be documented, or should
% it be assumed that the user will look at SocketServer.py?

\begin{funcdesc}{finish_request}{}
Actually processes the request by instantiating
Fred Drake's avatar
Fred Drake committed
125
\member{RequestHandlerClass} and calling its \method{handle()} method.
126 127 128 129 130 131 132 133
\end{funcdesc}

\begin{funcdesc}{get_request}{}
Must accept a request from the socket, and return a 2-tuple containing
the \emph{new} socket object to be used to communicate with the
client, and the client's address.
\end{funcdesc}

134
\begin{funcdesc}{handle_error}{request, client_address}
Fred Drake's avatar
Fred Drake committed
135 136 137 138
This function is called if the \member{RequestHandlerClass}'s
\method{handle()} method raises an exception.  The default action is
to print the traceback to standard output and continue handling
further requests.
139 140
\end{funcdesc}

141
\begin{funcdesc}{process_request}{request, client_address}
Fred Drake's avatar
Fred Drake committed
142 143 144 145
Calls \method{finish_request()} to create an instance of the
\member{RequestHandlerClass}.  If desired, this function can create a
new process or thread to handle the request; the \class{ForkingMixIn}
and \class{ThreadingMixIn} classes do this.
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
\end{funcdesc}

% Is there any point in documenting the following two functions?
% What would the purpose of overriding them be: initializing server
% instance variables, adding new network families?

\begin{funcdesc}{server_activate}{}
Called by the server's constructor to activate the server.
May be overridden.
\end{funcdesc}

\begin{funcdesc}{server_bind}{}
Called by the server's constructor to bind the socket to the desired
address.  May be overridden.
\end{funcdesc}

162
\begin{funcdesc}{verify_request}{request, client_address}
163 164 165 166 167 168
Must return a Boolean value; if the value is true, the request will be
processed, and if it's false, the request will be denied.
This function can be overridden to implement access controls for a server.
The default implementation always return true.
\end{funcdesc}

Fred Drake's avatar
Fred Drake committed
169 170 171
The request handler class must define a new \method{handle()} method,
and can override any of the following methods.  A new instance is
created for each request.
172 173

\begin{funcdesc}{finish}{}
Fred Drake's avatar
Fred Drake committed
174 175 176 177
Called after the \method{handle()} method to perform any clean-up
actions required.  The default implementation does nothing.  If
\method{setup()} or \method{handle()} raise an exception, this
function will not be called.
178 179 180 181 182
\end{funcdesc}

\begin{funcdesc}{handle}{}
This function must do all the work required to service a request.
Several instance attributes are available to it; the request is
Fred Drake's avatar
Fred Drake committed
183
available as \member{self.request}; the client address as
184
\member{self.client_address}; and the server instance as
Fred Drake's avatar
Fred Drake committed
185 186 187 188 189 190
\member{self.server}, in case it needs access to per-server
information.

The type of \member{self.request} is different for datagram or stream
services.  For stream services, \member{self.request} is a socket
object; for datagram services, \member{self.request} is a string.
191 192
However, this can be hidden by using the mix-in request handler
classes
Fred Drake's avatar
Fred Drake committed
193 194 195 196 197
\class{StreamRequestHandler} or \class{DatagramRequestHandler}, which
override the \method{setup()} and \method{finish()} methods, and
provides \member{self.rfile} and \member{self.wfile} attributes.
\member{self.rfile} and \member{self.wfile} can be read or written,
respectively, to get the request data or return data to the client.
198 199 200
\end{funcdesc}

\begin{funcdesc}{setup}{}
Fred Drake's avatar
Fred Drake committed
201 202 203
Called before the \method{handle()} method to perform any
initialization actions required.  The default implementation does
nothing.
204
\end{funcdesc}