SocketServer (version 0.2)
index
/usr/lib/python1.6/SocketServer.py

Generic socket server classes.
 
This module tries to capture the various aspects of defining a server:
 
- address family:
        - AF_INET: IP (Internet Protocol) sockets (default)
        - AF_UNIX: Unix domain sockets
        - others, e.g. AF_DECNET are conceivable (see <socket.h>
- socket type:
        - SOCK_STREAM (reliable stream, e.g. TCP)
        - SOCK_DGRAM (datagrams, e.g. UDP)
- client address verification before further looking at the request
        (This is actually a hook for any processing that needs to look
         at the request before anything else, e.g. logging)
- how to handle multiple requests:
        - synchronous (one request is handled at a time)
        - forking (each request is handled by a new process)
        - threading (each request is handled by a new thread)
 
The classes in this module favor the server type that is simplest to
write: a synchronous TCP/IP server.  This is bad class design, but
save some typing.  (There's also the issue that a deep class hierarchy
slows down method lookups.)
 
There are four classes in an inheritance diagram that represent
synchronous servers of four types:
 
        +-----------+        +------------------+
        | TCPServer |------->| UnixStreamServer |
        +-----------+        +------------------+
              |
              v
        +-----------+        +--------------------+
        | UDPServer |------->| UnixDatagramServer |
        +-----------+        +--------------------+
 
Note that UnixDatagramServer derives from UDPServer, not from
UnixStreamServer -- the only difference between an IP and a Unix
stream server is the address family, which is simply repeated in both
unix server classes.
 
Forking and threading versions of each type of server can be created
using the ForkingServer and ThreadingServer mix-in classes.  For
instance, a threading UDP server class is created as follows:
 
        class ThreadingUDPServer(ThreadingMixInUDPServer): pass
 
The Mix-in class must come first, since it overrides a method defined
in UDPServer!
 
To implement a service, you must derive a class from
BaseRequestHandler and redefine its handle() method.  You can then run
various versions of the service by combining one of the server classes
with your request handler class.
 
The request handler class must be different for datagram or stream
services.  This can be hidden by using the mix-in request handler
classes StreamRequestHandler or DatagramRequestHandler.
 
Of course, you still have to use your head!
 
For instance, it makes no sense to use a forking server if the service
contains state in memory that can be modified by requests (since the
modifications in the child process would never reach the initial state
kept in the parent process and passed to each child).  In this case,
you can use a threading server, but you will probably have to use
locks to avoid two requests that come in nearly simultaneous to apply
conflicting changes to the server state.
 
On the other hand, if you are building e.g. an HTTP server, where all
data is stored externally (e.g. in the file system), a synchronous
class will essentially render the service "deaf" while one request is
being handled -- which may be for a very long time if a client is slow
to reqd all the data it has requested.  Here a threading or forking
server is appropriate.
 
In some cases, it may be appropriate to process part of a request
synchronously, but to finish processing in a forked child depending on
the request data.  This can be implemented by using a synchronous
server and doing an explicit fork in the request handler class's
handle() method.
 
Another approach to handling multiple simultaneous requests in an
environment that supports neither threads nor fork (or where these are
too expensive or inappropriate for the service) is to maintain an
explicit table of partially finished requests and to use select() to
decide which request to work on next (or whether to handle a new
incoming request).  This is particularly important for stream services
where each client can potentially be connected for a long time (if
threads or subprocesses can't be used).
 
Future work:
- Standard classes for Sun RPC (which uses either UDP or TCP)
- Standard mix-in classes to implement various authentication
  and encryption schemes
- Standard framework for select-based multiplexing
 
XXX Open problems:
- What to do with out-of-band data?

 
Modules
            
os
socket
sys

 
Classes
            
BaseRequestHandler
DatagramRequestHandler
StreamRequestHandler
ForkingMixIn
ForkingTCPServer(ForkingMixIn, TCPServer)
ForkingUDPServer(ForkingMixIn, UDPServer)
TCPServer
UDPServer
UnixDatagramServer
UnixStreamServer
ThreadingMixIn
ThreadingTCPServer(ThreadingMixIn, TCPServer)
ThreadingUDPServer(ThreadingMixIn, UDPServer)
ThreadingUnixDatagramServer(ThreadingMixIn, UnixDatagramServer)
ThreadingUnixStreamServer(ThreadingMixIn, UnixStreamServer)

 
class BaseRequestHandler
      Base class for request handler classes.
 
This class is instantiated for each request to be handled.  The
constructor sets the instance variables request, client_address
and server, and then calls the handle() method.  To implement a
specific service, all you need to do is to derive a class which
defines a handle() method.
 
The handle() method can find the request as self.request, the
client address as self.client_address, and the server (in case it
needs access to per-server information) as self.server.  Since a
separate instance is created for each request, the handle() method
can define arbitrary other instance variariables.
 
  
__del__(self)
__init__(self, request, client_address, server)
finish(self)
handle(self)
setup(self)

 
class DatagramRequestHandler(BaseRequestHandler)
      Define self.rfile and self.wfile for datagram sockets.
 
  
__del__(self) from BaseRequestHandler
__init__(self, request, client_address, server) from BaseRequestHandler
finish(self)
handle(self) from BaseRequestHandler
setup(self)

 
class ForkingMixIn
      Mix-in class to handle each request in a new process.
 
  
collect_children(self)
Internal routine to wait for died children.
process_request(self, request, client_address)
Fork a new subprocess to process the request.

 
class ForkingTCPServer(ForkingMixIn, TCPServer)
       
  
__init__(self, server_address, RequestHandlerClass) from TCPServer
collect_children(self) from ForkingMixIn
fileno(self) from TCPServer
finish_request(self, request, client_address) from TCPServer
get_request(self) from TCPServer
handle_error(self, request, client_address) from TCPServer
handle_request(self) from TCPServer
process_request(self, request, client_address) from ForkingMixIn
serve_forever(self) from TCPServer
server_activate(self) from TCPServer
server_bind(self) from TCPServer
verify_request(self, request, client_address) from TCPServer

 
class ForkingUDPServer(ForkingMixIn, UDPServer)
       
  
__init__(self, server_address, RequestHandlerClass) from TCPServer
collect_children(self) from ForkingMixIn
fileno(self) from TCPServer
finish_request(self, request, client_address) from TCPServer
get_request(self) from UDPServer
handle_error(self, request, client_address) from TCPServer
handle_request(self) from TCPServer
process_request(self, request, client_address) from ForkingMixIn
serve_forever(self) from TCPServer
server_activate(self) from UDPServer
server_bind(self) from TCPServer
verify_request(self, request, client_address) from TCPServer

 
class StreamRequestHandler(BaseRequestHandler)
      Define self.rfile and self.wfile for stream sockets.
 
  
__del__(self) from BaseRequestHandler
__init__(self, request, client_address, server) from BaseRequestHandler
finish(self)
handle(self) from BaseRequestHandler
setup(self)

 
class TCPServer
      Base class for various socket-based server classes.
 
Defaults to synchronous IP stream (i.e., TCP).
 
Methods for the caller:
 
__init__(server_address, RequestHandlerClass)
serve_forever()
handle_request()  # if you don't use serve_forever()
fileno() -> int   # for select()
 
Methods that may be overridden:
 
server_bind()
server_activate()
get_request() -> request, client_address
verify_request(request, client_address)
process_request(request, client_address)
handle_error()
 
Methods for derived classes:
 
finish_request(request, client_address)
 
Class variables that may be overridden by derived classes or
instances:
 
- address_family
- socket_type
- request_queue_size (only for stream sockets)
- reuse_address
 
Instance variables:
 
- server_address
- RequestHandlerClass
- socket
 
  
__init__(self, server_address, RequestHandlerClass)
Constructor.  May be extended, do not override.
fileno(self)
Return socket file number.
 
Interface required by select().
finish_request(self, request, client_address)
Finish one request by instantiating RequestHandlerClass.
get_request(self)
Get the request and client address from the socket.
 
May be overridden.
handle_error(self, request, client_address)
Handle an error gracefully.  May be overridden.
 
The default is to print a traceback and continue.
handle_request(self)
Handle one request, possibly blocking.
process_request(self, request, client_address)
Call finish_request.
 
Overridden by ForkingMixIn and ThreadingMixIn.
serve_forever(self)
Handle one request at a time until doomsday.
server_activate(self)
Called by constructor to activate the server.
 
May be overridden.
server_bind(self)
Called by constructor to bind the socket.
 
May be overridden.
verify_request(self, request, client_address)
Verify the request.  May be overridden.
 
Return true if we should proceed with this request.

 
class ThreadingMixIn
      Mix-in class to handle each request in a new thread.
 
  
process_request(self, request, client_address)
Start a new thread to process the request.

 
class ThreadingTCPServer(ThreadingMixIn, TCPServer)
       
  
__init__(self, server_address, RequestHandlerClass) from TCPServer
fileno(self) from TCPServer
finish_request(self, request, client_address) from TCPServer
get_request(self) from TCPServer
handle_error(self, request, client_address) from TCPServer
handle_request(self) from TCPServer
process_request(self, request, client_address) from ThreadingMixIn
serve_forever(self) from TCPServer
server_activate(self) from TCPServer
server_bind(self) from TCPServer
verify_request(self, request, client_address) from TCPServer

 
class ThreadingUDPServer(ThreadingMixIn, UDPServer)
       
  
__init__(self, server_address, RequestHandlerClass) from TCPServer
fileno(self) from TCPServer
finish_request(self, request, client_address) from TCPServer
get_request(self) from UDPServer
handle_error(self, request, client_address) from TCPServer
handle_request(self) from TCPServer
process_request(self, request, client_address) from ThreadingMixIn
serve_forever(self) from TCPServer
server_activate(self) from UDPServer
server_bind(self) from TCPServer
verify_request(self, request, client_address) from TCPServer

 
class ThreadingUnixDatagramServer(ThreadingMixIn, UnixDatagramServer)
       
  
__init__(self, server_address, RequestHandlerClass) from TCPServer
fileno(self) from TCPServer
finish_request(self, request, client_address) from TCPServer
get_request(self) from UDPServer
handle_error(self, request, client_address) from TCPServer
handle_request(self) from TCPServer
process_request(self, request, client_address) from ThreadingMixIn
serve_forever(self) from TCPServer
server_activate(self) from UDPServer
server_bind(self) from TCPServer
verify_request(self, request, client_address) from TCPServer

 
class ThreadingUnixStreamServer(ThreadingMixIn, UnixStreamServer)
       
  
__init__(self, server_address, RequestHandlerClass) from TCPServer
fileno(self) from TCPServer
finish_request(self, request, client_address) from TCPServer
get_request(self) from TCPServer
handle_error(self, request, client_address) from TCPServer
handle_request(self) from TCPServer
process_request(self, request, client_address) from ThreadingMixIn
serve_forever(self) from TCPServer
server_activate(self) from TCPServer
server_bind(self) from TCPServer
verify_request(self, request, client_address) from TCPServer

 
class UDPServer(TCPServer)
      UDP server class.
 
  
__init__(self, server_address, RequestHandlerClass) from TCPServer
fileno(self) from TCPServer
finish_request(self, request, client_address) from TCPServer
get_request(self)
handle_error(self, request, client_address) from TCPServer
handle_request(self) from TCPServer
process_request(self, request, client_address) from TCPServer
serve_forever(self) from TCPServer
server_activate(self)
server_bind(self) from TCPServer
verify_request(self, request, client_address) from TCPServer

 
class UnixDatagramServer(UDPServer)
       
  
__init__(self, server_address, RequestHandlerClass) from TCPServer
fileno(self) from TCPServer
finish_request(self, request, client_address) from TCPServer
get_request(self) from UDPServer
handle_error(self, request, client_address) from TCPServer
handle_request(self) from TCPServer
process_request(self, request, client_address) from TCPServer
serve_forever(self) from TCPServer
server_activate(self) from UDPServer
server_bind(self) from TCPServer
verify_request(self, request, client_address) from TCPServer

 
class UnixStreamServer(TCPServer)
       
  
__init__(self, server_address, RequestHandlerClass) from TCPServer
fileno(self) from TCPServer
finish_request(self, request, client_address) from TCPServer
get_request(self) from TCPServer
handle_error(self, request, client_address) from TCPServer
handle_request(self) from TCPServer
process_request(self, request, client_address) from TCPServer
serve_forever(self) from TCPServer
server_activate(self) from TCPServer
server_bind(self) from TCPServer
verify_request(self, request, client_address) from TCPServer

 
Data
             __file__ = '/usr/lib/python1.6/SocketServer.pyc'
__name__ = 'SocketServer'
__version__ = '0.2'