/usr/web/sources/contrib/stallion/root/sys/lib/python2.7/SocketServer.pyc

Plan 9 from Bell Labs’s /usr/web/sources/contrib/stallion/root/sys/lib/python2.7/SocketServer.pyc

�`^c@sOdZdZddlZddlZddlZddlZddlZyddlZWnek
rwddl	ZnXdddddd	d
ddd
dgZ
eed�r�e
jddddg�nd�Z
dd&d��YZdefd��YZdefd��YZdd'd��YZd
d(d��YZdeefd��YZdeefd��YZdeefd��YZd	eefd��YZeed�rdefd��YZdefd ��YZdeefd!��YZdeefd"��YZnd
d)d#��YZdefd$��YZdefd%��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 read 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	UDPServertForkingUDPServertForkingTCPServertThreadingUDPServertThreadingTCPServertBaseRequestHandlertStreamRequestHandlertDatagramRequestHandlertThreadingMixIntForkingMixIntAF_UNIXtUnixStreamServertUnixDatagramServertThreadingUnixStreamServertThreadingUnixDatagramServercGsZxStrUy||�SWqttjfk
rQ}|jdtjkrR�qRqXqWdS(s*restart a system call interrupted by EINTRiN(tTruetOSErrortselectterrortargsterrnotEINTR(tfuncRte((s"/sys/lib/python2.7/SocketServer.pyt_eintr_retry�s	t
BaseServercBs�eZdZdZd�Zd�Zdd�Zd�Zd�Z	d�Z
d�Zd	�Zd
�Z
d�Zd�Zd
�Zd�Zd�ZRS(s�Base class for server classes.

    Methods for the caller:

    - __init__(server_address, RequestHandlerClass)
    - serve_forever(poll_interval=0.5)
    - shutdown()
    - 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
    - handle_timeout()
    - verify_request(request, client_address)
    - server_close()
    - process_request(request, client_address)
    - shutdown_request(request)
    - 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:

    - timeout
    - address_family
    - socket_type
    - allow_reuse_address

    Instance variables:

    - RequestHandlerClass
    - socket

    cCs.||_||_tj�|_t|_dS(s/Constructor.  May be extended, do not override.N(tserver_addresstRequestHandlerClasst	threadingtEventt_BaseServer__is_shut_downtFalset_BaseServer__shutdown_request(tselfRR((s"/sys/lib/python2.7/SocketServer.pyt__init__�s		cCsdS(sSCalled by constructor to activate the server.

        May be overridden.

        N((R"((s"/sys/lib/python2.7/SocketServer.pytserver_activate�sg�Cs|jj�zTxM|js_ttj|ggg|�\}}}||kr|j�qqWWdt|_|jj�XdS(s�Handle one request at a time until shutdown.

        Polls for shutdown every poll_interval seconds. Ignores
        self.timeout. If you need to do periodic tasks, do them in
        another thread.
        N(RtclearR!RRt_handle_request_noblockR tset(R"t
poll_intervaltrtwR((s"/sys/lib/python2.7/SocketServer.pyt
serve_forever�s
	cCst|_|jj�dS(s�Stops the serve_forever loop.

        Blocks until the loop has finished. This must be called while
        serve_forever() is running in another thread, or it will
        deadlock.
        N(RR!Rtwait(R"((s"/sys/lib/python2.7/SocketServer.pytshutdown�s	cCs�|jj�}|dkr'|j}n$|jdk	rKt||j�}nttj|ggg|�}|ds�|j�dS|j�dS(sOHandle one request, possibly blocking.

        Respects self.timeout.
        iN(	tsockett
gettimeouttNonettimeouttminRRthandle_timeoutR&(R"R1tfd_sets((s"/sys/lib/python2.7/SocketServer.pythandle_requests

cCs�y|j�\}}Wntjk
r-dSX|j||�r~y|j||�Wq~|j||�|j|�q~XndS(s�Handle one request, without blocking.

        I assume that select.select has returned that the socket is
        readable before this function was called, so there should be
        no risk of blocking in get_request().
        N(tget_requestR.Rtverify_requesttprocess_requestthandle_errortshutdown_request(R"trequesttclient_address((s"/sys/lib/python2.7/SocketServer.pyR&scCsdS(scCalled if no new request arrives within self.timeout.

        Overridden by ForkingMixIn.
        N((R"((s"/sys/lib/python2.7/SocketServer.pyR3,scCstS(snVerify the request.  May be overridden.

        Return True if we should proceed with this request.

        (R(R"R;R<((s"/sys/lib/python2.7/SocketServer.pyR73scCs!|j||�|j|�dS(sVCall finish_request.

        Overridden by ForkingMixIn and ThreadingMixIn.

        N(tfinish_requestR:(R"R;R<((s"/sys/lib/python2.7/SocketServer.pyR8;scCsdS(sDCalled to clean-up the server.

        May be overridden.

        N((R"((s"/sys/lib/python2.7/SocketServer.pytserver_closeDscCs|j|||�dS(s8Finish one request by instantiating RequestHandlerClass.N(R(R"R;R<((s"/sys/lib/python2.7/SocketServer.pyR=LscCs|j|�dS(s3Called to shutdown and close an individual request.N(t
close_request(R"R;((s"/sys/lib/python2.7/SocketServer.pyR:PscCsdS(s)Called to clean up an individual request.N((R"R;((s"/sys/lib/python2.7/SocketServer.pyR?TscCs5ddGHdG|GHddl}|j�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(R"R;R<RA((s"/sys/lib/python2.7/SocketServer.pyR9Xs	
N(t__name__t
__module__t__doc__R0R1R#R$R+R-R5R&R3R7R8R>R=R:R?R9(((s"/sys/lib/python2.7/SocketServer.pyR�s *													cBsweZdZejZejZdZe	Z
ed�Zd�Z
d�Zd�Zd�Zd�Zd�Zd	�ZRS(
s3Base class for various socket-based server classes.

    Defaults to synchronous IP stream (i.e., TCP).

    Methods for the caller:

    - __init__(server_address, RequestHandlerClass, bind_and_activate=True)
    - serve_forever(poll_interval=0.5)
    - shutdown()
    - 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
    - handle_timeout()
    - verify_request(request, client_address)
    - process_request(request, client_address)
    - shutdown_request(request)
    - 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:

    - timeout
    - address_family
    - socket_type
    - request_queue_size (only for stream sockets)
    - allow_reuse_address

    Instance variables:

    - server_address
    - RequestHandlerClass
    - socket

    icCsOtj|||�tj|j|j�|_|rK|j�|j�ndS(s/Constructor.  May be extended, do not override.N(RR#R.taddress_familytsocket_typetserver_bindR$(R"RRtbind_and_activate((s"/sys/lib/python2.7/SocketServer.pyR#�s
cCsQ|jr(|jjtjtjd�n|jj|j�|jj�|_dS(sOCalled by constructor to bind the socket.

        May be overridden.

        iN(tallow_reuse_addressR.t
setsockoptt
SOL_SOCKETtSO_REUSEADDRtbindRtgetsockname(R"((s"/sys/lib/python2.7/SocketServer.pyRH�s	cCs|jj|j�dS(sSCalled by constructor to activate the server.

        May be overridden.

        N(R.tlistentrequest_queue_size(R"((s"/sys/lib/python2.7/SocketServer.pyR$�scCs|jj�dS(sDCalled to clean-up the server.

        May be overridden.

        N(R.tclose(R"((s"/sys/lib/python2.7/SocketServer.pyR>�scCs
|jj�S(sMReturn socket file number.

        Interface required by select().

        (R.tfileno(R"((s"/sys/lib/python2.7/SocketServer.pyRS�scCs
|jj�S(sYGet the request and client address from the socket.

        May be overridden.

        (R.taccept(R"((s"/sys/lib/python2.7/SocketServer.pyR6�scCs<y|jtj�Wntjk
r*nX|j|�dS(s3Called to shutdown and close an individual request.N(R-R.tSHUT_WRRR?(R"R;((s"/sys/lib/python2.7/SocketServer.pyR:�s
cCs|j�dS(s)Called to clean up an individual request.N(RR(R"R;((s"/sys/lib/python2.7/SocketServer.pyR?�s(RCRDRER.tAF_INETRFtSOCK_STREAMRGRQR RJRR#RHR$R>RSR6R:R?(((s"/sys/lib/python2.7/SocketServer.pyRfs-									
cBsGeZdZeZejZdZd�Z	d�Z
d�Zd�ZRS(sUDP server class.i cCs.|jj|j�\}}||jf|fS(N(R.trecvfromtmax_packet_size(R"tdatatclient_addr((s"/sys/lib/python2.7/SocketServer.pyR6�scCsdS(N((R"((s"/sys/lib/python2.7/SocketServer.pyR$�scCs|j|�dS(N(R?(R"R;((s"/sys/lib/python2.7/SocketServer.pyR:�scCsdS(N((R"R;((s"/sys/lib/python2.7/SocketServer.pyR?�s(
RCRDRER RJR.t
SOCK_DGRAMRGRYR6R$R:R?(((s"/sys/lib/python2.7/SocketServer.pyR�s				cBs;eZdZdZdZdZd�Zd�Zd�Z	RS(s5Mix-in class to handle each request in a new process.i,i(cCs4|jdkrdSx�t|j�|jkr�y,tjdd�\}}|jj|�Wqtk
r�}|jtj	kr�|jj
�q�|jtjkr�Pq�qXqWx�|jj�D]p}y/tj|tj
�\}}|jj|�Wq�tk
r+}|jtj	kr,|jj|�q,q�Xq�WdS(s7Internal routine to wait for children that have exited.Ni�i(tactive_childrenR0tlentmax_childrentostwaitpidtdiscardRRtECHILDR%RtcopytWNOHANG(R"tpidt_R((s"/sys/lib/python2.7/SocketServer.pytcollect_childrens$cCs|j�dS(snWait for zombies after self.timeout seconds of inactivity.

        May be extended, do not override.
        N(Rh(R"((s"/sys/lib/python2.7/SocketServer.pyR3$scCs�|j�tj�}|r[|jdkr:t�|_n|jj|�|j|�dSy.|j||�|j	|�tj
d�Wn9z!|j||�|j	|�Wdtj
d�XnXdS(s-Fork a new subprocess to process the request.Nii(RhR`tforkR]R0R'taddR?R=R:t_exitR9(R"R;R<Rf((s"/sys/lib/python2.7/SocketServer.pyR8+s"


N(
RCRDRER1R0R]R_RhR3R8(((s"/sys/lib/python2.7/SocketServer.pyR
�s	"	cBs&eZdZeZd�Zd�ZRS(s4Mix-in class to handle each request in a new thread.cCsLy!|j||�|j|�Wn$|j||�|j|�nXdS(sgSame as in BaseServer but as a thread.

        In addition, exception handling is done here.

        N(R=R:R9(R"R;R<((s"/sys/lib/python2.7/SocketServer.pytprocess_request_threadLscCs;tjd|jd||f�}|j|_|j�dS(s*Start a new thread to process the request.ttargetRN(RtThreadRltdaemon_threadstdaemontstart(R"R;R<tt((s"/sys/lib/python2.7/SocketServer.pyR8Ys(RCRDRER RoRlR8(((s"/sys/lib/python2.7/SocketServer.pyR	Es	
cBseZRS((RCRD(((s"/sys/lib/python2.7/SocketServer.pyRascBseZRS((RCRD(((s"/sys/lib/python2.7/SocketServer.pyRbscBseZRS((RCRD(((s"/sys/lib/python2.7/SocketServer.pyRdscBseZRS((RCRD(((s"/sys/lib/python2.7/SocketServer.pyRescBseZejZRS((RCRDR.RRF(((s"/sys/lib/python2.7/SocketServer.pyRiscBseZejZRS((RCRDR.RRF(((s"/sys/lib/python2.7/SocketServer.pyR
lscBseZRS((RCRD(((s"/sys/lib/python2.7/SocketServer.pyRoscBseZRS((RCRD(((s"/sys/lib/python2.7/SocketServer.pyRqscBs2eZdZd�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.

    cCsE||_||_||_|j�z|j�Wd|j�XdS(N(R;R<tservertsetupthandletfinish(R"R;R<Rs((s"/sys/lib/python2.7/SocketServer.pyR#�s			
cCsdS(N((R"((s"/sys/lib/python2.7/SocketServer.pyRt�scCsdS(N((R"((s"/sys/lib/python2.7/SocketServer.pyRu�scCsdS(N((R"((s"/sys/lib/python2.7/SocketServer.pyRv�s(RCRDRER#RtRuRv(((s"/sys/lib/python2.7/SocketServer.pyRss
	
		cBs8eZdZdZdZdZeZd�Z	d�Z
RS(s4Define self.rfile and self.wfile for stream sockets.i�icCs�|j|_|jdk	r1|jj|j�n|jrY|jjtjtj	t
�n|jjd|j�|_
|jjd|j�|_dS(Ntrbtwb(R;t
connectionR1R0t
settimeouttdisable_nagle_algorithmRKR.tIPPROTO_TCPtTCP_NODELAYRtmakefiletrbufsizetrfiletwbufsizetwfile(R"((s"/sys/lib/python2.7/SocketServer.pyRt�s	cCsU|jjs7y|jj�Wq7tjk
r3q7Xn|jj�|jj�dS(N(R�tclosedtflushR.RRRR�(R"((s"/sys/lib/python2.7/SocketServer.pyRv�s
N(RCRDRERR�R0R1R R{RtRv(((s"/sys/lib/python2.7/SocketServer.pyR�s		
cBs eZdZd�Zd�ZRS(s6Define self.rfile and self.wfile for datagram sockets.cCsoyddlm}Wn!tk
r7ddlm}nX|j\|_|_||j�|_|�|_dS(Ni�(tStringIO(t	cStringIOR�tImportErrorR;tpacketR.R�R�(R"R�((s"/sys/lib/python2.7/SocketServer.pyRt�s
cCs#|jj|jj�|j�dS(N(R.tsendtoR�tgetvalueR<(R"((s"/sys/lib/python2.7/SocketServer.pyRv�s(RCRDRERtRv(((s"/sys/lib/python2.7/SocketServer.pyR�s		(((((REt__version__R.RtsysR`RRR�tdummy_threadingt__all__thasattrtextendRRRRR
R	RRRRRR
RRRRR(((s"/sys/lib/python2.7/SocketServer.pyt<module>xsH	
	
		�zK.+
(Return to Plan 9 Home Page)