Plan 9 from Bell Labs’s /usr/web/sources/contrib/bichued/root/sys/lib/python/SocketServer.pyc

Copyright © 2021 Plan 9 Foundation.
Distributed under the MIT License.
Download the Plan 9 distribution. 


�
��c@sdZdZddkZddkZddkZdddddd	d
ddd
dgZeed�oeiddddg�ndd%d��YZdefd��YZ	de	fd��YZ
dd&d��YZd
d'd��YZdee
fd��YZ
dee	fd��YZdee
fd��YZd	ee	fd��YZeed�obde	fd��YZde
fd��YZdeefd ��YZdeefd!��YZnd
d(d"��YZdefd#��YZdefd$��YZdS()s�Generic socket server classes.

This module tries to capture the various aspects of defining a server:

For socket-based servers:

- address family:
        - AF_INET{,6}: 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)

For request-based servers (including socket-based):

- 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 five classes in an inheritance diagram, four of which represent
synchronous servers of four types:

        +------------+
        | BaseServer |
        +------------+
              |
              v
        +-----------+        +------------------+
        | 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 ForkingMixIn and ThreadingMixIn mix-in classes.  For
instance, a threading UDP server class is created as follows:

        class ThreadingUDPServer(ThreadingMixIn, UDPServer): pass

The Mix-in class must come first, since it overrides a method defined
in UDPServer! Setting the various member variables also changes
the behavior of the underlying server mechanism.

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 request handler
subclasses 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
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 cannot 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?

BaseServer:
- split generic "request" functionality out into BaseServer class.
  Copyright (C) 2000  Luke Kenneth Casson Leighton <[email protected]>

  example: read entries from a SQL database (requires overriding
  get_request() to return a table entry from the database).
  entry is processed by a RequestHandlerClass.

s0.4i�Nt	TCPServert	UDPServertForkingUDPServertForkingTCPServertThreadingUDPServertThreadingTCPServertBaseRequestHandlertStreamRequestHandlertDatagramRequestHandlertThreadingMixIntForkingMixIntAF_UNIXtUnixStreamServertUnixDatagramServertThreadingUnixStreamServertThreadingUnixDatagramServert
BaseServercBsheZdZd�Zd�Zd�Zd�Zd�Zd�Zd�Z	d�Z
d	�Zd
�ZRS(s9Base class for server classes.

    Methods for the caller:

    - __init__(server_address, RequestHandlerClass)
    - serve_forever()
    - handle_request()  # if you do not 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)
    - server_close()
    - process_request(request, client_address)
    - close_request(request)
    - 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
    - allow_reuse_address

    Instance variables:

    - RequestHandlerClass
    - socket

    cCs||_||_dS(s/Constructor.  May be extended, do not override.N(tserver_addresstRequestHandlerClass(tselfRR((s/sys/lib/python/SocketServer.pyt__init__�s	cCsdS(sSCalled by constructor to activate the server.

        May be overridden.

        N((R((s/sys/lib/python/SocketServer.pytserver_activate�scCsx
|i�qdS(s,Handle one request at a time until doomsday.N(thandle_request(R((s/sys/lib/python/SocketServer.pyt
serve_forever�sc	Cs�y|i�\}}Wntij
odSnX|i||�o?y|i||�Wq�|i||�|i|�q�XndS(s&Handle one request, possibly blocking.N(tget_requesttsocketterrortverify_requesttprocess_requestthandle_errort
close_request(Rtrequesttclient_address((s/sys/lib/python/SocketServer.pyR�s	cCstS(snVerify the request.  May be overridden.

        Return True if we should proceed with this request.

        (tTrue(RRR ((s/sys/lib/python/SocketServer.pyR�scCs!|i||�|i|�dS(sVCall finish_request.

        Overridden by ForkingMixIn and ThreadingMixIn.

        N(tfinish_requestR(RRR ((s/sys/lib/python/SocketServer.pyR�scCsdS(sDCalled to clean-up the server.

        May be overridden.

        N((R((s/sys/lib/python/SocketServer.pytserver_close�scCs|i|||�dS(s8Finish one request by instantiating RequestHandlerClass.N(R(RRR ((s/sys/lib/python/SocketServer.pyR"�scCsdS(s)Called to clean up an individual request.N((RR((s/sys/lib/python/SocketServer.pyRscCs5ddGHdG|GHddk}|i�ddGHdS(stHandle an error gracefully.  May be overridden.

        The default is to print a traceback and continue.

        t-i(s4Exception happened during processing of request fromi�N(t	tracebackt	print_exc(RRR R%((s/sys/lib/python/SocketServer.pyRs	
(
t__name__t
__module__t__doc__RRRRRRR#R"RR(((s/sys/lib/python/SocketServer.pyR�s&				
						cBskeZdZeiZeiZdZe	Z
d�Zd�Zd�Z
d�Zd�Zd�Zd�ZRS(	s�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)
    - close_request(request)
    - 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)
    - allow_reuse_address

    Instance variables:

    - server_address
    - RequestHandlerClass
    - socket

    icCsFti|||�ti|i|i�|_|i�|i�dS(s/Constructor.  May be extended, do not override.N(RRRtaddress_familytsocket_typetserver_bindR(RRR((s/sys/lib/python/SocketServer.pyREs

cCsS|io |iititid�n|ii|i�|ii�|_dS(sOCalled by constructor to bind the socket.

        May be overridden.

        iN(tallow_reuse_addressRt
setsockoptt
SOL_SOCKETtSO_REUSEADDRtbindRtgetsockname(R((s/sys/lib/python/SocketServer.pyR,Ms
 cCs|ii|i�dS(sSCalled by constructor to activate the server.

        May be overridden.

        N(Rtlistentrequest_queue_size(R((s/sys/lib/python/SocketServer.pyRXscCs|ii�dS(sDCalled to clean-up the server.

        May be overridden.

        N(Rtclose(R((s/sys/lib/python/SocketServer.pyR#`scCs
|ii�S(sMReturn socket file number.

        Interface required by select().

        (Rtfileno(R((s/sys/lib/python/SocketServer.pyR6hscCs
|ii�S(sYGet the request and client address from the socket.

        May be overridden.

        (Rtaccept(R((s/sys/lib/python/SocketServer.pyRpscCs|i�dS(s)Called to clean up an individual request.N(R5(RR((s/sys/lib/python/SocketServer.pyRxs(R'R(R)RtAF_INETR*tSOCK_STREAMR+R4tFalseR-RR,RR#R6RR(((s/sys/lib/python/SocketServer.pyRs)								cBs>eZdZeZeiZdZd�Z	d�Z
d�ZRS(sUDP server class.i cCs.|ii|i�\}}||if|fS(N(Rtrecvfromtmax_packet_size(Rtdatatclient_addr((s/sys/lib/python/SocketServer.pyR�scCsdS(N((R((s/sys/lib/python/SocketServer.pyR�scCsdS(N((RR((s/sys/lib/python/SocketServer.pyR�s(R'R(R)R:R-Rt
SOCK_DGRAMR+R<RRR(((s/sys/lib/python/SocketServer.pyR}s			cBs,eZdZdZdZd�Zd�ZRS(s5Mix-in class to handle each request in a new process.i(cCs�x�|io�t|i�|ijo
ti}nd}ytid|�\}}Wntij
o
d}nX|pPn|ii|�qWdS(s+Internal routine to wait for died children.iN(	tactive_childrentlentmax_childrentostWNOHANGtwaitpidRtNonetremove(Rtoptionstpidtstatus((s/sys/lib/python/SocketServer.pytcollect_children�s

cCs�|i�ti�}|oB|idjo
g|_n|ii|�|i|�dSnQy!|i||�tid�Wn,z|i	||�Wdtid�XnXdS(s-Fork a new subprocess to process the request.Nii(
RKRCtforkR@RFtappendRR"t_exitR(RRR RI((s/sys/lib/python/SocketServer.pyR�s


N(R'R(R)RFR@RBRKR(((s/sys/lib/python/SocketServer.pyR
�s
	cBs&eZdZeZd�Zd�ZRS(s4Mix-in class to handle each request in a new thread.cCsLy!|i||�|i|�Wn$|i||�|i|�nXdS(sgSame as in BaseServer but as a thread.

        In addition, exception handling is done here.

        N(R"RR(RRR ((s/sys/lib/python/SocketServer.pytprocess_request_thread�scCsVddk}|id|id||f�}|io|id�n|i�dS(s*Start a new thread to process the request.i�Nttargettargsi(t	threadingtThreadROtdaemon_threadst	setDaemontstart(RRR RRtt((s/sys/lib/python/SocketServer.pyR�s
(R'R(R)R:RTROR(((s/sys/lib/python/SocketServer.pyR	�s	
cBseZRS((R'R((((s/sys/lib/python/SocketServer.pyR�scBseZRS((R'R((((s/sys/lib/python/SocketServer.pyR�scBseZRS((R'R((((s/sys/lib/python/SocketServer.pyR�scBseZRS((R'R((((s/sys/lib/python/SocketServer.pyR�scBseZeiZRS((R'R(RRR*(((s/sys/lib/python/SocketServer.pyR�scBseZeiZRS((R'R(RRR*(((s/sys/lib/python/SocketServer.pyR
�scBseZRS((R'R((((s/sys/lib/python/SocketServer.pyR�scBseZRS((R'R((((s/sys/lib/python/SocketServer.pyR�scBs2eZdZd�Zd�Zd�Zd�ZRS(s�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.

    cCsN||_||_||_z"|i�|i�|i�Wddt_XdS(N(	RR tservertsetupthandletfinishRFtsyst
exc_traceback(RRR RX((s/sys/lib/python/SocketServer.pyRs			

cCsdS(N((R((s/sys/lib/python/SocketServer.pyRYscCsdS(N((R((s/sys/lib/python/SocketServer.pyRZscCsdS(N((R((s/sys/lib/python/SocketServer.pyR[s(R'R(R)RRYRZR[(((s/sys/lib/python/SocketServer.pyR�s
			cBs,eZdZdZdZd�Zd�ZRS(s4Define self.rfile and self.wfile for stream sockets.i�icCsF|i|_|iid|i�|_|iid|i�|_dS(Ntrbtwb(Rt
connectiontmakefiletrbufsizetrfiletwbufsizetwfile(R((s/sys/lib/python/SocketServer.pyRY/scCs<|iip|ii�n|ii�|ii�dS(N(RetclosedtflushR5Rc(R((s/sys/lib/python/SocketServer.pyR[4s

(R'R(R)RbRdRYR[(((s/sys/lib/python/SocketServer.pyR!s
		cBs eZdZd�Zd�ZRS(s6Define self.rfile and self.wfile for datagram sockets.cCsqyddkl}Wn#tj
oddkl}nX|i\|_|_||i�|_|�|_dS(Ni�(tStringIO(t	cStringIORhtImportErrorRtpacketRRcRe(RRh((s/sys/lib/python/SocketServer.pyRYBscCs#|ii|ii�|i�dS(N(RtsendtoRetgetvalueR (R((s/sys/lib/python/SocketServer.pyR[Ks(R'R(R)RYR[(((s/sys/lib/python/SocketServer.pyR;s		(((((R)t__version__RR\RCt__all__thasattrtextendRRRR
R	RRRRRR
RRRRR(((s/sys/lib/python/SocketServer.pys<module>xs:		�k//

Bell Labs OSI certified Powered by Plan 9

(Return to Plan 9 Home Page)

Copyright © 2021 Plan 9 Foundation. All Rights Reserved.
Comments to [email protected].