Mercurial > cpython-lru_cache-weakref

annotate Lib/socketserver.py @ 70817:dd775b1561ba

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix markup.
author Georg Brandl <georg@python.org>
date Tue, 14 Jun 2011 21:09:55 +0200
parents e2363b1c4bca
children 4411a59dc23c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
1 """Generic socket server classes.
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
2
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
3 This module tries to capture the various aspects of defining a server:
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
4
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
5 For socket-based servers:
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
6
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
7 - address family:
18825
40900620293e Patch #401196: Use getaddrinfo and AF_INET6 in TCP servers and clients.
Martin v. Löwis <martin@v.loewis.de>
parents: 18471
diff changeset
8 - AF_INET{,6}: IP (Internet Protocol) sockets (default)
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
9 - AF_UNIX: Unix domain sockets
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
10 - others, e.g. AF_DECNET are conceivable (see <socket.h>
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
11 - socket type:
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
12 - SOCK_STREAM (reliable stream, e.g. TCP)
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
13 - SOCK_DGRAM (datagrams, e.g. UDP)
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
14
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
15 For request-based servers (including socket-based):
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
16
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
17 - client address verification before further looking at the request
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
18 (This is actually a hook for any processing that needs to look
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
19 at the request before anything else, e.g. logging)
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
20 - how to handle multiple requests:
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
21 - synchronous (one request is handled at a time)
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
22 - forking (each request is handled by a new process)
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
23 - threading (each request is handled by a new thread)
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
24
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
25 The classes in this module favor the server type that is simplest to
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
26 write: a synchronous TCP/IP server. This is bad class design, but
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
27 save some typing. (There's also the issue that a deep class hierarchy
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
28 slows down method lookups.)
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
29
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
30 There are five classes in an inheritance diagram, four of which represent
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
31 synchronous servers of four types:
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
32
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
33 +------------+
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
34 | BaseServer |
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
35 +------------+
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
36 |
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
37 v
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
38 +-----------+ +------------------+
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
39 | TCPServer |------->| UnixStreamServer |
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
40 +-----------+ +------------------+
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
41 |
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
42 v
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
43 +-----------+ +--------------------+
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
44 | UDPServer |------->| UnixDatagramServer |
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
45 +-----------+ +--------------------+
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
46
5803
b56d527a433f Fix bug found by kjpylint; change doc string to avoid "(" in column 1.
Guido van Rossum <guido@python.org>
parents: 4459
diff changeset
47 Note that UnixDatagramServer derives from UDPServer, not from
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
48 UnixStreamServer -- the only difference between an IP and a Unix
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
49 stream server is the address family, which is simply repeated in both
5803
b56d527a433f Fix bug found by kjpylint; change doc string to avoid "(" in column 1.
Guido van Rossum <guido@python.org>
parents: 4459
diff changeset
50 unix server classes.
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
51
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
52 Forking and threading versions of each type of server can be created
34939
a1293ee6e1db Fixed a typo in docstring I happened upon.
Guido van Rossum <guido@python.org>
parents: 34293
diff changeset
53 using the ForkingMixIn and ThreadingMixIn mix-in classes. For
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
54 instance, a threading UDP server class is created as follows:
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
55
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
56 class ThreadingUDPServer(ThreadingMixIn, UDPServer): pass
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
57
5803
b56d527a433f Fix bug found by kjpylint; change doc string to avoid "(" in column 1.
Guido van Rossum <guido@python.org>
parents: 4459
diff changeset
58 The Mix-in class must come first, since it overrides a method defined
26337
733e4b9d592e Patch #550765: Add daemon_threads flag.
Martin v. Löwis <martin@v.loewis.de>
parents: 25023
diff changeset
59 in UDPServer! Setting the various member variables also changes
733e4b9d592e Patch #550765: Add daemon_threads flag.
Martin v. Löwis <martin@v.loewis.de>
parents: 25023
diff changeset
60 the behavior of the underlying server mechanism.
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
61
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
62 To implement a service, you must derive a class from
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
63 BaseRequestHandler and redefine its handle() method. You can then run
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
64 various versions of the service by combining one of the server classes
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
65 with your request handler class.
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
66
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
67 The request handler class must be different for datagram or stream
35256
92b37c71f935 bug [ 957505 ] SocketServer module documentation misleading
Georg Brandl <georg@python.org>
parents: 34939
diff changeset
68 services. This can be hidden by using the request handler
92b37c71f935 bug [ 957505 ] SocketServer module documentation misleading
Georg Brandl <georg@python.org>
parents: 34939
diff changeset
69 subclasses StreamRequestHandler or DatagramRequestHandler.
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
70
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
71 Of course, you still have to use your head!
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
72
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
73 For instance, it makes no sense to use a forking server if the service
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
74 contains state in memory that can be modified by requests (since the
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
75 modifications in the child process would never reach the initial state
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
76 kept in the parent process and passed to each child). In this case,
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
77 you can use a threading server, but you will probably have to use
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
78 locks to avoid two requests that come in nearly simultaneous to apply
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
79 conflicting changes to the server state.
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
80
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
81 On the other hand, if you are building e.g. an HTTP server, where all
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
82 data is stored externally (e.g. in the file system), a synchronous
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
83 class will essentially render the service "deaf" while one request is
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
84 being handled -- which may be for a very long time if a client is slow
70377
e2363b1c4bca Fix closes issue #11109 - socketserver.ForkingMixIn leaves zombies, also fails to reap all zombies in one pass.
Senthil Kumaran <senthil@uthcode.com>
parents: 70344
diff changeset
85 to recv all the data it has requested. Here a threading or forking
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
86 server is appropriate.
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
87
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
88 In some cases, it may be appropriate to process part of a request
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
89 synchronously, but to finish processing in a forked child depending on
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
90 the request data. This can be implemented by using a synchronous
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
91 server and doing an explicit fork in the request handler class
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
92 handle() method.
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
93
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
94 Another approach to handling multiple simultaneous requests in an
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
95 environment that supports neither threads nor fork (or where these are
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
96 too expensive or inappropriate for the service) is to maintain an
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
97 explicit table of partially finished requests and to use select() to
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
98 decide which request to work on next (or whether to handle a new
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
99 incoming request). This is particularly important for stream services
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
100 where each client can potentially be connected for a long time (if
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
101 threads or subprocesses cannot be used).
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
102
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
103 Future work:
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
104 - Standard classes for Sun RPC (which uses either UDP or TCP)
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
105 - Standard mix-in classes to implement various authentication
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
106 and encryption schemes
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
107 - Standard framework for select-based multiplexing
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
108
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
109 XXX Open problems:
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
110 - What to do with out-of-band data?
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
111
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
112 BaseServer:
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
113 - split generic "request" functionality out into BaseServer class.
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
114 Copyright (C) 2000 Luke Kenneth Casson Leighton <lkcl@samba.org>
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
115
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
116 example: read entries from a SQL database (requires overriding
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
117 get_request() to return a table entry from the database).
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
118 entry is processed by a RequestHandlerClass.
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
119
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
120 """
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
121
16037
ba295e2c73ea Bump __version__; add authorship note for the BaseServer patch.
Guido van Rossum <guido@python.org>
parents: 16010
diff changeset
122 # Author of the BaseServer patch: Luke Kenneth Casson Leighton
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
123
18471
99ad6fd279e9 Backport of Guido's checkin 1.25:
Thomas Wouters <thomas@python.org>
parents: 17400
diff changeset
124 # XXX Warning!
99ad6fd279e9 Backport of Guido's checkin 1.25:
Thomas Wouters <thomas@python.org>
parents: 17400
diff changeset
125 # There is a test suite for this module, but it cannot be run by the
99ad6fd279e9 Backport of Guido's checkin 1.25:
Thomas Wouters <thomas@python.org>
parents: 17400
diff changeset
126 # standard regression test.
99ad6fd279e9 Backport of Guido's checkin 1.25:
Thomas Wouters <thomas@python.org>
parents: 17400
diff changeset
127 # To run it manually, run Lib/test/test_socketserver.py.
99ad6fd279e9 Backport of Guido's checkin 1.25:
Thomas Wouters <thomas@python.org>
parents: 17400
diff changeset
128
99ad6fd279e9 Backport of Guido's checkin 1.25:
Thomas Wouters <thomas@python.org>
parents: 17400
diff changeset
129 __version__ = "0.4"
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
130
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
131
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
132 import socket
45773
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
133 import select
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
134 import sys
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
135 import os
45773
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
136 try:
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
137 import threading
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
138 except ImportError:
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
139 import dummy_threading as threading
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
140
16070
b5345e99596b added __all__ lists to a number of Python modules
Skip Montanaro <skip@pobox.com>
parents: 16037
diff changeset
141 __all__ = ["TCPServer","UDPServer","ForkingUDPServer","ForkingTCPServer",
b5345e99596b added __all__ lists to a number of Python modules
Skip Montanaro <skip@pobox.com>
parents: 16037
diff changeset
142 "ThreadingUDPServer","ThreadingTCPServer","BaseRequestHandler",
18471
99ad6fd279e9 Backport of Guido's checkin 1.25:
Thomas Wouters <thomas@python.org>
parents: 17400
diff changeset
143 "StreamRequestHandler","DatagramRequestHandler",
99ad6fd279e9 Backport of Guido's checkin 1.25:
Thomas Wouters <thomas@python.org>
parents: 17400
diff changeset
144 "ThreadingMixIn", "ForkingMixIn"]
16070
b5345e99596b added __all__ lists to a number of Python modules
Skip Montanaro <skip@pobox.com>
parents: 16037
diff changeset
145 if hasattr(socket, "AF_UNIX"):
b5345e99596b added __all__ lists to a number of Python modules
Skip Montanaro <skip@pobox.com>
parents: 16037
diff changeset
146 __all__.extend(["UnixStreamServer","UnixDatagramServer",
b5345e99596b added __all__ lists to a number of Python modules
Skip Montanaro <skip@pobox.com>
parents: 16037
diff changeset
147 "ThreadingUnixStreamServer",
b5345e99596b added __all__ lists to a number of Python modules
Skip Montanaro <skip@pobox.com>
parents: 16037
diff changeset
148 "ThreadingUnixDatagramServer"])
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
149
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
150 class BaseServer:
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
151
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
152 """Base class for server classes.
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
153
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
154 Methods for the caller:
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
155
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
156 - __init__(server_address, RequestHandlerClass)
45773
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
157 - serve_forever(poll_interval=0.5)
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
158 - shutdown()
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
159 - handle_request() # if you do not use serve_forever()
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
160 - fileno() -> int # for select()
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
161
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
162 Methods that may be overridden:
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
163
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
164 - server_bind()
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
165 - server_activate()
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
166 - get_request() -> request, client_address
44782
ca2683a67943 Merged revisions 60080-60089,60091-60093 via svnmerge from
Georg Brandl <georg@python.org>
parents: 42429
diff changeset
167 - handle_timeout()
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
168 - verify_request(request, client_address)
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
169 - server_close()
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
170 - process_request(request, client_address)
55140
81002c7600bd http://bugs.python.org/issue6382
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 55110
diff changeset
171 - shutdown_request(request)
17400
13857fb33017 Add a close_request method to the BaseServer so that the TCPServer class
Ka-Ping Yee <ping@zesty.ca>
parents: 16070
diff changeset
172 - close_request(request)
70377
e2363b1c4bca Fix closes issue #11109 - socketserver.ForkingMixIn leaves zombies, also fails to reap all zombies in one pass.
Senthil Kumaran <senthil@uthcode.com>
parents: 70344
diff changeset
173 - service_actions()
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
174 - handle_error()
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
175
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
176 Methods for derived classes:
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
177
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
178 - finish_request(request, client_address)
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
179
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
180 Class variables that may be overridden by derived classes or
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
181 instances:
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
182
44782
ca2683a67943 Merged revisions 60080-60089,60091-60093 via svnmerge from
Georg Brandl <georg@python.org>
parents: 42429
diff changeset
183 - timeout
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
184 - address_family
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
185 - socket_type
30664
298888e395ce TCPServer: Fixed typo in class docstring.
Barry Warsaw <barry@python.org>
parents: 30663
diff changeset
186 - allow_reuse_address
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
187
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
188 Instance variables:
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
189
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
190 - RequestHandlerClass
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
191 - socket
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
192
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
193 """
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
194
44782
ca2683a67943 Merged revisions 60080-60089,60091-60093 via svnmerge from
Georg Brandl <georg@python.org>
parents: 42429
diff changeset
195 timeout = None
ca2683a67943 Merged revisions 60080-60089,60091-60093 via svnmerge from
Georg Brandl <georg@python.org>
parents: 42429
diff changeset
196
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
197 def __init__(self, server_address, RequestHandlerClass):
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
198 """Constructor. May be extended, do not override."""
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
199 self.server_address = server_address
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
200 self.RequestHandlerClass = RequestHandlerClass
45773
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
201 self.__is_shut_down = threading.Event()
60972
9165232e6d1a Merged revisions 80487,80489 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 51869
diff changeset
202 self.__shutdown_request = False
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
203
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
204 def server_activate(self):
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
205 """Called by constructor to activate the server.
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
206
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
207 May be overridden.
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
208
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
209 """
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
210 pass
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
211
45773
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
212 def serve_forever(self, poll_interval=0.5):
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
213 """Handle one request at a time until shutdown.
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
214
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
215 Polls for shutdown every poll_interval seconds. Ignores
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
216 self.timeout. If you need to do periodic tasks, do them in
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
217 another thread.
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
218 """
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
219 self.__is_shut_down.clear()
60972
9165232e6d1a Merged revisions 80487,80489 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 51869
diff changeset
220 try:
9165232e6d1a Merged revisions 80487,80489 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 51869
diff changeset
221 while not self.__shutdown_request:
9165232e6d1a Merged revisions 80487,80489 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 51869
diff changeset
222 # XXX: Consider using another file descriptor or
9165232e6d1a Merged revisions 80487,80489 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 51869
diff changeset
223 # connecting to the socket to wake this up instead of
9165232e6d1a Merged revisions 80487,80489 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 51869
diff changeset
224 # polling. Polling reduces our responsiveness to a
9165232e6d1a Merged revisions 80487,80489 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 51869
diff changeset
225 # shutdown request and wastes cpu at all other times.
9165232e6d1a Merged revisions 80487,80489 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 51869
diff changeset
226 r, w, e = select.select([self], [], [], poll_interval)
9165232e6d1a Merged revisions 80487,80489 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 51869
diff changeset
227 if self in r:
9165232e6d1a Merged revisions 80487,80489 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 51869
diff changeset
228 self._handle_request_noblock()
70377
e2363b1c4bca Fix closes issue #11109 - socketserver.ForkingMixIn leaves zombies, also fails to reap all zombies in one pass.
Senthil Kumaran <senthil@uthcode.com>
parents: 70344
diff changeset
229
e2363b1c4bca Fix closes issue #11109 - socketserver.ForkingMixIn leaves zombies, also fails to reap all zombies in one pass.
Senthil Kumaran <senthil@uthcode.com>
parents: 70344
diff changeset
230 self.service_actions()
60972
9165232e6d1a Merged revisions 80487,80489 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 51869
diff changeset
231 finally:
9165232e6d1a Merged revisions 80487,80489 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 51869
diff changeset
232 self.__shutdown_request = False
9165232e6d1a Merged revisions 80487,80489 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 51869
diff changeset
233 self.__is_shut_down.set()
45773
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
234
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
235 def shutdown(self):
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
236 """Stops the serve_forever loop.
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
237
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
238 Blocks until the loop has finished. This must be called while
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
239 serve_forever() is running in another thread, or it will
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
240 deadlock.
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
241 """
60972
9165232e6d1a Merged revisions 80487,80489 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 51869
diff changeset
242 self.__shutdown_request = True
45773
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
243 self.__is_shut_down.wait()
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
244
70377
e2363b1c4bca Fix closes issue #11109 - socketserver.ForkingMixIn leaves zombies, also fails to reap all zombies in one pass.
Senthil Kumaran <senthil@uthcode.com>
parents: 70344
diff changeset
245 def service_actions(self):
e2363b1c4bca Fix closes issue #11109 - socketserver.ForkingMixIn leaves zombies, also fails to reap all zombies in one pass.
Senthil Kumaran <senthil@uthcode.com>
parents: 70344
diff changeset
246 """Called by the serve_forever() loop.
e2363b1c4bca Fix closes issue #11109 - socketserver.ForkingMixIn leaves zombies, also fails to reap all zombies in one pass.
Senthil Kumaran <senthil@uthcode.com>
parents: 70344
diff changeset
247
e2363b1c4bca Fix closes issue #11109 - socketserver.ForkingMixIn leaves zombies, also fails to reap all zombies in one pass.
Senthil Kumaran <senthil@uthcode.com>
parents: 70344
diff changeset
248 May be overridden by a subclass / Mixin to implement any code that
e2363b1c4bca Fix closes issue #11109 - socketserver.ForkingMixIn leaves zombies, also fails to reap all zombies in one pass.
Senthil Kumaran <senthil@uthcode.com>
parents: 70344
diff changeset
249 needs to be run during the loop.
e2363b1c4bca Fix closes issue #11109 - socketserver.ForkingMixIn leaves zombies, also fails to reap all zombies in one pass.
Senthil Kumaran <senthil@uthcode.com>
parents: 70344
diff changeset
250 """
e2363b1c4bca Fix closes issue #11109 - socketserver.ForkingMixIn leaves zombies, also fails to reap all zombies in one pass.
Senthil Kumaran <senthil@uthcode.com>
parents: 70344
diff changeset
251 pass
e2363b1c4bca Fix closes issue #11109 - socketserver.ForkingMixIn leaves zombies, also fails to reap all zombies in one pass.
Senthil Kumaran <senthil@uthcode.com>
parents: 70344
diff changeset
252
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
253 # The distinction between handling, getting, processing and
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
254 # finishing a request is fairly arbitrary. Remember:
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
255 #
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
256 # - handle_request() is the top-level call. It calls
45773
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
257 # select, get_request(), verify_request() and process_request()
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
258 # - get_request() is different for stream or datagram sockets
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
259 # - process_request() is the place that may fork a new process
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
260 # or create a new thread to finish the request
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
261 # - finish_request() instantiates the request handler class;
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
262 # this constructor will handle the request all by itself
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
263
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
264 def handle_request(self):
45773
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
265 """Handle one request, possibly blocking.
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
266
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
267 Respects self.timeout.
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
268 """
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
269 # Support people who used socket.settimeout() to escape
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
270 # handle_request before self.timeout was available.
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
271 timeout = self.socket.gettimeout()
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
272 if timeout is None:
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
273 timeout = self.timeout
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
274 elif self.timeout is not None:
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
275 timeout = min(timeout, self.timeout)
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
276 fd_sets = select.select([self], [], [], timeout)
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
277 if not fd_sets[0]:
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
278 self.handle_timeout()
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
279 return
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
280 self._handle_request_noblock()
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
281
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
282 def _handle_request_noblock(self):
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
283 """Handle one request, without blocking.
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
284
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
285 I assume that select.select has returned that the socket is
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
286 readable before this function was called, so there should be
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
287 no risk of blocking in get_request().
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
288 """
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
289 try:
45773
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
290 request, client_address = self.get_request()
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
291 except socket.error:
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
292 return
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
293 if self.verify_request(request, client_address):
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
294 try:
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
295 self.process_request(request, client_address)
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
296 except:
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
297 self.handle_error(request, client_address)
55140
81002c7600bd http://bugs.python.org/issue6382
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 55110
diff changeset
298 self.shutdown_request(request)
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
299
44782
ca2683a67943 Merged revisions 60080-60089,60091-60093 via svnmerge from
Georg Brandl <georg@python.org>
parents: 42429
diff changeset
300 def handle_timeout(self):
ca2683a67943 Merged revisions 60080-60089,60091-60093 via svnmerge from
Georg Brandl <georg@python.org>
parents: 42429
diff changeset
301 """Called if no new request arrives within self.timeout.
ca2683a67943 Merged revisions 60080-60089,60091-60093 via svnmerge from
Georg Brandl <georg@python.org>
parents: 42429
diff changeset
302
ca2683a67943 Merged revisions 60080-60089,60091-60093 via svnmerge from
Georg Brandl <georg@python.org>
parents: 42429
diff changeset
303 Overridden by ForkingMixIn.
ca2683a67943 Merged revisions 60080-60089,60091-60093 via svnmerge from
Georg Brandl <georg@python.org>
parents: 42429
diff changeset
304 """
ca2683a67943 Merged revisions 60080-60089,60091-60093 via svnmerge from
Georg Brandl <georg@python.org>
parents: 42429
diff changeset
305 pass
ca2683a67943 Merged revisions 60080-60089,60091-60093 via svnmerge from
Georg Brandl <georg@python.org>
parents: 42429
diff changeset
306
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
307 def verify_request(self, request, client_address):
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
308 """Verify the request. May be overridden.
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
309
22830
a9dd5e6d6805 Convert a pile of obvious "yes/no" functions to return bool.
Tim Peters <tim.peters@gmail.com>
parents: 20636
diff changeset
310 Return True if we should proceed with this request.
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
311
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
312 """
22830
a9dd5e6d6805 Convert a pile of obvious "yes/no" functions to return bool.
Tim Peters <tim.peters@gmail.com>
parents: 20636
diff changeset
313 return True
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
314
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
315 def process_request(self, request, client_address):
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
316 """Call finish_request.
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
317
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
318 Overridden by ForkingMixIn and ThreadingMixIn.
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
319
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
320 """
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
321 self.finish_request(request, client_address)
55140
81002c7600bd http://bugs.python.org/issue6382
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 55110
diff changeset
322 self.shutdown_request(request)
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
323
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
324 def server_close(self):
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
325 """Called to clean-up the server.
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
326
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
327 May be overridden.
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
328
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
329 """
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
330 pass
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
331
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
332 def finish_request(self, request, client_address):
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
333 """Finish one request by instantiating RequestHandlerClass."""
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
334 self.RequestHandlerClass(request, client_address, self)
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
335
55140
81002c7600bd http://bugs.python.org/issue6382
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 55110
diff changeset
336 def shutdown_request(self, request):
81002c7600bd http://bugs.python.org/issue6382
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 55110
diff changeset
337 """Called to shutdown and close an individual request."""
81002c7600bd http://bugs.python.org/issue6382
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 55110
diff changeset
338 self.close_request(request)
81002c7600bd http://bugs.python.org/issue6382
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 55110
diff changeset
339
17400
13857fb33017 Add a close_request method to the BaseServer so that the TCPServer class
Ka-Ping Yee <ping@zesty.ca>
parents: 16070
diff changeset
340 def close_request(self, request):
13857fb33017 Add a close_request method to the BaseServer so that the TCPServer class
Ka-Ping Yee <ping@zesty.ca>
parents: 16070
diff changeset
341 """Called to clean up an individual request."""
13857fb33017 Add a close_request method to the BaseServer so that the TCPServer class
Ka-Ping Yee <ping@zesty.ca>
parents: 16070
diff changeset
342 pass
13857fb33017 Add a close_request method to the BaseServer so that the TCPServer class
Ka-Ping Yee <ping@zesty.ca>
parents: 16070
diff changeset
343
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
344 def handle_error(self, request, client_address):
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
345 """Handle an error gracefully. May be overridden.
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
346
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
347 The default is to print a traceback and continue.
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
348
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
349 """
40775
4cdf21a0dbbc Fix most trivially-findable print statements.
Guido van Rossum <guido@python.org>
parents: 35256
diff changeset
350 print('-'*40)
4cdf21a0dbbc Fix most trivially-findable print statements.
Guido van Rossum <guido@python.org>
parents: 35256
diff changeset
351 print('Exception happened during processing of request from', end=' ')
4cdf21a0dbbc Fix most trivially-findable print statements.
Guido van Rossum <guido@python.org>
parents: 35256
diff changeset
352 print(client_address)
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
353 import traceback
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
354 traceback.print_exc() # XXX But this goes to stderr!
40775
4cdf21a0dbbc Fix most trivially-findable print statements.
Guido van Rossum <guido@python.org>
parents: 35256
diff changeset
355 print('-'*40)
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
356
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
357
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
358 class TCPServer(BaseServer):
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
359
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
360 """Base class for various socket-based server classes.
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
361
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
362 Defaults to synchronous IP stream (i.e., TCP).
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
363
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
364 Methods for the caller:
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
365
41554
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40775
diff changeset
366 - __init__(server_address, RequestHandlerClass, bind_and_activate=True)
45773
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
367 - serve_forever(poll_interval=0.5)
832c820e9d14 Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45555
diff changeset
368 - shutdown()
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
369 - handle_request() # if you don't use serve_forever()
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
370 - fileno() -> int # for select()
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
371
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
372 Methods that may be overridden:
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
373
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
374 - server_bind()
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
375 - server_activate()
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
376 - get_request() -> request, client_address
44782
ca2683a67943 Merged revisions 60080-60089,60091-60093 via svnmerge from
Georg Brandl <georg@python.org>
parents: 42429
diff changeset
377 - handle_timeout()
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
378 - verify_request(request, client_address)
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
379 - process_request(request, client_address)
55140
81002c7600bd http://bugs.python.org/issue6382
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 55110
diff changeset
380 - shutdown_request(request)
17400
13857fb33017 Add a close_request method to the BaseServer so that the TCPServer class
Ka-Ping Yee <ping@zesty.ca>
parents: 16070
diff changeset
381 - close_request(request)
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
382 - handle_error()
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
383
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
384 Methods for derived classes:
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
385
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
386 - finish_request(request, client_address)
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
387
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
388 Class variables that may be overridden by derived classes or
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
389 instances:
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
390
44782
ca2683a67943 Merged revisions 60080-60089,60091-60093 via svnmerge from
Georg Brandl <georg@python.org>
parents: 42429
diff changeset
391 - timeout
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
392 - address_family
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
393 - socket_type
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
394 - request_queue_size (only for stream sockets)
30663
5c0174e2e14f TCPServer: Fixed typo in class docstring.
Barry Warsaw <barry@python.org>
parents: 27010
diff changeset
395 - allow_reuse_address
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
396
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
397 Instance variables:
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
398
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
399 - server_address
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
400 - RequestHandlerClass
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
401 - socket
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
402
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
403 """
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
404
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
405 address_family = socket.AF_INET
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
406
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
407 socket_type = socket.SOCK_STREAM
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
408
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
409 request_queue_size = 5
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
410
25023
a6de50c0d457 Replace 0 with False to match working in documentation. SF 599681.
Raymond Hettinger <python@rcn.com>
parents: 23035
diff changeset
411 allow_reuse_address = False
12633
a56707b07b81 Add class variable allow_reuse_address in TCPServer -- if nonzero, the
Guido van Rossum <guido@python.org>
parents: 11382
diff changeset
412
41554
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40775
diff changeset
413 def __init__(self, server_address, RequestHandlerClass, bind_and_activate=True):
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
414 """Constructor. May be extended, do not override."""
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
415 BaseServer.__init__(self, server_address, RequestHandlerClass)
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
416 self.socket = socket.socket(self.address_family,
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
417 self.socket_type)
41554
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40775
diff changeset
418 if bind_and_activate:
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40775
diff changeset
419 self.server_bind()
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40775
diff changeset
420 self.server_activate()
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
421
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
422 def server_bind(self):
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
423 """Called by constructor to bind the socket.
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
424
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
425 May be overridden.
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
426
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
427 """
12633
a56707b07b81 Add class variable allow_reuse_address in TCPServer -- if nonzero, the
Guido van Rossum <guido@python.org>
parents: 11382
diff changeset
428 if self.allow_reuse_address:
a56707b07b81 Add class variable allow_reuse_address in TCPServer -- if nonzero, the
Guido van Rossum <guido@python.org>
parents: 11382
diff changeset
429 self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
430 self.socket.bind(self.server_address)
41554
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40775
diff changeset
431 self.server_address = self.socket.getsockname()
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
432
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
433 def server_activate(self):
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
434 """Called by constructor to activate the server.
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
435
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
436 May be overridden.
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
437
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
438 """
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
439 self.socket.listen(self.request_queue_size)
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
440
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
441 def server_close(self):
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
442 """Called to clean-up the server.
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
443
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
444 May be overridden.
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
445
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
446 """
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
447 self.socket.close()
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
448
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
449 def fileno(self):
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
450 """Return socket file number.
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
451
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
452 Interface required by select().
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
453
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
454 """
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
455 return self.socket.fileno()
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
456
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
457 def get_request(self):
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
458 """Get the request and client address from the socket.
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
459
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
460 May be overridden.
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
461
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
462 """
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
463 return self.socket.accept()
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
464
55140
81002c7600bd http://bugs.python.org/issue6382
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 55110
diff changeset
465 def shutdown_request(self, request):
81002c7600bd http://bugs.python.org/issue6382
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 55110
diff changeset
466 """Called to shutdown and close an individual request."""
55110
c233615b34aa http://bugs.python.org/issue6381
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 55109
diff changeset
467 try:
c233615b34aa http://bugs.python.org/issue6381
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 55109
diff changeset
468 #explicitly shutdown. socket.close() merely releases
c233615b34aa http://bugs.python.org/issue6381
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 55109
diff changeset
469 #the socket and waits for GC to perform the actual close.
c233615b34aa http://bugs.python.org/issue6381
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 55109
diff changeset
470 request.shutdown(socket.SHUT_WR)
c233615b34aa http://bugs.python.org/issue6381
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 55109
diff changeset
471 except socket.error:
c233615b34aa http://bugs.python.org/issue6381
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 55109
diff changeset
472 pass #some platforms may raise ENOTCONN here
55140
81002c7600bd http://bugs.python.org/issue6382
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 55110
diff changeset
473 self.close_request(request)
81002c7600bd http://bugs.python.org/issue6382
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 55110
diff changeset
474
17400
13857fb33017 Add a close_request method to the BaseServer so that the TCPServer class
Ka-Ping Yee <ping@zesty.ca>
parents: 16070
diff changeset
475 def close_request(self, request):
13857fb33017 Add a close_request method to the BaseServer so that the TCPServer class
Ka-Ping Yee <ping@zesty.ca>
parents: 16070
diff changeset
476 """Called to clean up an individual request."""
13857fb33017 Add a close_request method to the BaseServer so that the TCPServer class
Ka-Ping Yee <ping@zesty.ca>
parents: 16070
diff changeset
477 request.close()
13857fb33017 Add a close_request method to the BaseServer so that the TCPServer class
Ka-Ping Yee <ping@zesty.ca>
parents: 16070
diff changeset
478
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
479
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
480 class UDPServer(TCPServer):
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
481
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
482 """UDP server class."""
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
483
25023
a6de50c0d457 Replace 0 with False to match working in documentation. SF 599681.
Raymond Hettinger <python@rcn.com>
parents: 23035
diff changeset
484 allow_reuse_address = False
16010
33f5ee6a0ebe SF Patch #102980, by Luke Kenneth Casson Leighton: BaseServer class
Guido van Rossum <guido@python.org>
parents: 15556
diff changeset
485
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
486 socket_type = socket.SOCK_DGRAM
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
487
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
488 max_packet_size = 8192
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
489
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
490 def get_request(self):
8510
de0f0c3ed424 Fixed the UDP server -- this never worked. Ray Loyzaga deserves
Guido van Rossum <guido@python.org>
parents: 7840
diff changeset
491 data, client_addr = self.socket.recvfrom(self.max_packet_size)
de0f0c3ed424 Fixed the UDP server -- this never worked. Ray Loyzaga deserves
Guido van Rossum <guido@python.org>
parents: 7840
diff changeset
492 return (data, self.socket), client_addr
de0f0c3ed424 Fixed the UDP server -- this never worked. Ray Loyzaga deserves
Guido van Rossum <guido@python.org>
parents: 7840
diff changeset
493
de0f0c3ed424 Fixed the UDP server -- this never worked. Ray Loyzaga deserves
Guido van Rossum <guido@python.org>
parents: 7840
diff changeset
494 def server_activate(self):
de0f0c3ed424 Fixed the UDP server -- this never worked. Ray Loyzaga deserves
Guido van Rossum <guido@python.org>
parents: 7840
diff changeset
495 # No need to call listen() for UDP.
de0f0c3ed424 Fixed the UDP server -- this never worked. Ray Loyzaga deserves
Guido van Rossum <guido@python.org>
parents: 7840
diff changeset
496 pass
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
497
55140
81002c7600bd http://bugs.python.org/issue6382
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 55110
diff changeset
498 def shutdown_request(self, request):
81002c7600bd http://bugs.python.org/issue6382
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 55110
diff changeset
499 # No need to shutdown anything.
81002c7600bd http://bugs.python.org/issue6382
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 55110
diff changeset
500 self.close_request(request)
81002c7600bd http://bugs.python.org/issue6382
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 55110
diff changeset
501
17400
13857fb33017 Add a close_request method to the BaseServer so that the TCPServer class
Ka-Ping Yee <ping@zesty.ca>
parents: 16070
diff changeset
502 def close_request(self, request):
13857fb33017 Add a close_request method to the BaseServer so that the TCPServer class
Ka-Ping Yee <ping@zesty.ca>
parents: 16070
diff changeset
503 # No need to close anything.
13857fb33017 Add a close_request method to the BaseServer so that the TCPServer class
Ka-Ping Yee <ping@zesty.ca>
parents: 16070
diff changeset
504 pass
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
505
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
506 class ForkingMixIn:
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
507
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
508 """Mix-in class to handle each request in a new process."""
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
509
44782
ca2683a67943 Merged revisions 60080-60089,60091-60093 via svnmerge from
Georg Brandl <georg@python.org>
parents: 42429
diff changeset
510 timeout = 300
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
511 active_children = None
11145
d997e27e3312 Another patch from Andy Dustman:
Guido van Rossum <guido@python.org>
parents: 11001
diff changeset
512 max_children = 40
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
513
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
514 def collect_children(self):
44782
ca2683a67943 Merged revisions 60080-60089,60091-60093 via svnmerge from
Georg Brandl <georg@python.org>
parents: 42429
diff changeset
515 """Internal routine to wait for children that have exited."""
45555
0cb481956452 Merged revisions 61038,61042-61045,61047,61050,61053,61055-61056,61061-61062,61066,61068,61070,61083,61085,61092-61097,61103-61108 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45371
diff changeset
516 if self.active_children is None: return
0cb481956452 Merged revisions 61038,61042-61045,61047,61050,61053,61055-61056,61061-61062,61066,61068,61070,61083,61085,61092-61097,61103-61108 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45371
diff changeset
517 while len(self.active_children) >= self.max_children:
0cb481956452 Merged revisions 61038,61042-61045,61047,61050,61053,61055-61056,61061-61062,61066,61068,61070,61083,61085,61092-61097,61103-61108 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45371
diff changeset
518 # XXX: This will wait for any child process, not just ones
0cb481956452 Merged revisions 61038,61042-61045,61047,61050,61053,61055-61056,61061-61062,61066,61068,61070,61083,61085,61092-61097,61103-61108 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45371
diff changeset
519 # spawned by this library. This could confuse other
0cb481956452 Merged revisions 61038,61042-61045,61047,61050,61053,61055-61056,61061-61062,61066,61068,61070,61083,61085,61092-61097,61103-61108 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45371
diff changeset
520 # libraries that expect to be able to wait for their own
0cb481956452 Merged revisions 61038,61042-61045,61047,61050,61053,61055-61056,61061-61062,61066,61068,61070,61083,61085,61092-61097,61103-61108 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45371
diff changeset
521 # children.
11001
926cb5a5ee30 In collect_children(), put a try-except around os.waitpid() because it
Guido van Rossum <guido@python.org>
parents: 10992
diff changeset
522 try:
51869
323a5a8d10fc Merged revisions 69990 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49239
diff changeset
523 pid, status = os.waitpid(0, 0)
11001
926cb5a5ee30 In collect_children(), put a try-except around os.waitpid() because it
Guido van Rossum <guido@python.org>
parents: 10992
diff changeset
524 except os.error:
926cb5a5ee30 In collect_children(), put a try-except around os.waitpid() because it
Guido van Rossum <guido@python.org>
parents: 10992
diff changeset
525 pid = None
45555
0cb481956452 Merged revisions 61038,61042-61045,61047,61050,61053,61055-61056,61061-61062,61066,61068,61070,61083,61085,61092-61097,61103-61108 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45371
diff changeset
526 if pid not in self.active_children: continue
0cb481956452 Merged revisions 61038,61042-61045,61047,61050,61053,61055-61056,61061-61062,61066,61068,61070,61083,61085,61092-61097,61103-61108 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45371
diff changeset
527 self.active_children.remove(pid)
0cb481956452 Merged revisions 61038,61042-61045,61047,61050,61053,61055-61056,61061-61062,61066,61068,61070,61083,61085,61092-61097,61103-61108 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45371
diff changeset
528
0cb481956452 Merged revisions 61038,61042-61045,61047,61050,61053,61055-61056,61061-61062,61066,61068,61070,61083,61085,61092-61097,61103-61108 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45371
diff changeset
529 # XXX: This loop runs more system calls than it ought
0cb481956452 Merged revisions 61038,61042-61045,61047,61050,61053,61055-61056,61061-61062,61066,61068,61070,61083,61085,61092-61097,61103-61108 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45371
diff changeset
530 # to. There should be a way to put the active_children into a
0cb481956452 Merged revisions 61038,61042-61045,61047,61050,61053,61055-61056,61061-61062,61066,61068,61070,61083,61085,61092-61097,61103-61108 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45371
diff changeset
531 # process group and then use os.waitpid(-pgid) to wait for any
0cb481956452 Merged revisions 61038,61042-61045,61047,61050,61053,61055-61056,61061-61062,61066,61068,61070,61083,61085,61092-61097,61103-61108 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45371
diff changeset
532 # of that set, but I couldn't find a way to allocate pgids
0cb481956452 Merged revisions 61038,61042-61045,61047,61050,61053,61055-61056,61061-61062,61066,61068,61070,61083,61085,61092-61097,61103-61108 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45371
diff changeset
533 # that couldn't collide.
0cb481956452 Merged revisions 61038,61042-61045,61047,61050,61053,61055-61056,61061-61062,61066,61068,61070,61083,61085,61092-61097,61103-61108 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45371
diff changeset
534 for child in self.active_children:
0cb481956452 Merged revisions 61038,61042-61045,61047,61050,61053,61055-61056,61061-61062,61066,61068,61070,61083,61085,61092-61097,61103-61108 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45371
diff changeset
535 try:
0cb481956452 Merged revisions 61038,61042-61045,61047,61050,61053,61055-61056,61061-61062,61066,61068,61070,61083,61085,61092-61097,61103-61108 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45371
diff changeset
536 pid, status = os.waitpid(child, os.WNOHANG)
0cb481956452 Merged revisions 61038,61042-61045,61047,61050,61053,61055-61056,61061-61062,61066,61068,61070,61083,61085,61092-61097,61103-61108 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45371
diff changeset
537 except os.error:
0cb481956452 Merged revisions 61038,61042-61045,61047,61050,61053,61055-61056,61061-61062,61066,61068,61070,61083,61085,61092-61097,61103-61108 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45371
diff changeset
538 pid = None
0cb481956452 Merged revisions 61038,61042-61045,61047,61050,61053,61055-61056,61061-61062,61066,61068,61070,61083,61085,61092-61097,61103-61108 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45371
diff changeset
539 if not pid: continue
45371
7c4c46342137 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678,60680-60683,60685-60686,60688,60690,60692-60694,60697-60700,60705-60706,60708,60711,60714,60720,60724-60730,60732,60736,60742,60744,60746,60748,60750-60751,60753,60756-60757,60759-60761,60763-60764,60766,60769-60770,60774-60784,60787-60845 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44782
diff changeset
540 try:
7c4c46342137 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678,60680-60683,60685-60686,60688,60690,60692-60694,60697-60700,60705-60706,60708,60711,60714,60720,60724-60730,60732,60736,60742,60744,60746,60748,60750-60751,60753,60756-60757,60759-60761,60763-60764,60766,60769-60770,60774-60784,60787-60845 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44782
diff changeset
541 self.active_children.remove(pid)
7c4c46342137 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678,60680-60683,60685-60686,60688,60690,60692-60694,60697-60700,60705-60706,60708,60711,60714,60720,60724-60730,60732,60736,60742,60744,60746,60748,60750-60751,60753,60756-60757,60759-60761,60763-60764,60766,60769-60770,60774-60784,60787-60845 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44782
diff changeset
542 except ValueError as e:
7c4c46342137 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678,60680-60683,60685-60686,60688,60690,60692-60694,60697-60700,60705-60706,60708,60711,60714,60720,60724-60730,60732,60736,60742,60744,60746,60748,60750-60751,60753,60756-60757,60759-60761,60763-60764,60766,60769-60770,60774-60784,60787-60845 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44782
diff changeset
543 raise ValueError('%s. x=%d and list=%r' % (e.message, pid,
7c4c46342137 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678,60680-60683,60685-60686,60688,60690,60692-60694,60697-60700,60705-60706,60708,60711,60714,60720,60724-60730,60732,60736,60742,60744,60746,60748,60750-60751,60753,60756-60757,60759-60761,60763-60764,60766,60769-60770,60774-60784,60787-60845 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44782
diff changeset
544 self.active_children))
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
545
44782
ca2683a67943 Merged revisions 60080-60089,60091-60093 via svnmerge from
Georg Brandl <georg@python.org>
parents: 42429
diff changeset
546 def handle_timeout(self):
ca2683a67943 Merged revisions 60080-60089,60091-60093 via svnmerge from
Georg Brandl <georg@python.org>
parents: 42429
diff changeset
547 """Wait for zombies after self.timeout seconds of inactivity.
ca2683a67943 Merged revisions 60080-60089,60091-60093 via svnmerge from
Georg Brandl <georg@python.org>
parents: 42429
diff changeset
548
ca2683a67943 Merged revisions 60080-60089,60091-60093 via svnmerge from
Georg Brandl <georg@python.org>
parents: 42429
diff changeset
549 May be extended, do not override.
ca2683a67943 Merged revisions 60080-60089,60091-60093 via svnmerge from
Georg Brandl <georg@python.org>
parents: 42429
diff changeset
550 """
ca2683a67943 Merged revisions 60080-60089,60091-60093 via svnmerge from
Georg Brandl <georg@python.org>
parents: 42429
diff changeset
551 self.collect_children()
ca2683a67943 Merged revisions 60080-60089,60091-60093 via svnmerge from
Georg Brandl <georg@python.org>
parents: 42429
diff changeset
552
70377
e2363b1c4bca Fix closes issue #11109 - socketserver.ForkingMixIn leaves zombies, also fails to reap all zombies in one pass.
Senthil Kumaran <senthil@uthcode.com>
parents: 70344
diff changeset
553 def service_actions(self):
e2363b1c4bca Fix closes issue #11109 - socketserver.ForkingMixIn leaves zombies, also fails to reap all zombies in one pass.
Senthil Kumaran <senthil@uthcode.com>
parents: 70344
diff changeset
554 """Collect the zombie child processes regularly in the ForkingMixin.
e2363b1c4bca Fix closes issue #11109 - socketserver.ForkingMixIn leaves zombies, also fails to reap all zombies in one pass.
Senthil Kumaran <senthil@uthcode.com>
parents: 70344
diff changeset
555
e2363b1c4bca Fix closes issue #11109 - socketserver.ForkingMixIn leaves zombies, also fails to reap all zombies in one pass.
Senthil Kumaran <senthil@uthcode.com>
parents: 70344
diff changeset
556 service_actions is called in the BaseServer's serve_forver loop.
e2363b1c4bca Fix closes issue #11109 - socketserver.ForkingMixIn leaves zombies, also fails to reap all zombies in one pass.
Senthil Kumaran <senthil@uthcode.com>
parents: 70344
diff changeset
557 """
e2363b1c4bca Fix closes issue #11109 - socketserver.ForkingMixIn leaves zombies, also fails to reap all zombies in one pass.
Senthil Kumaran <senthil@uthcode.com>
parents: 70344
diff changeset
558 self.collect_children()
e2363b1c4bca Fix closes issue #11109 - socketserver.ForkingMixIn leaves zombies, also fails to reap all zombies in one pass.
Senthil Kumaran <senthil@uthcode.com>
parents: 70344
diff changeset
559
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
560 def process_request(self, request, client_address):
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
561 """Fork a new subprocess to process the request."""
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
562 pid = os.fork()
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
563 if pid:
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
564 # Parent process
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
565 if self.active_children is None:
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
566 self.active_children = []
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
567 self.active_children.append(pid)
18471
99ad6fd279e9 Backport of Guido's checkin 1.25:
Thomas Wouters <thomas@python.org>
parents: 17400
diff changeset
568 self.close_request(request)
70377
e2363b1c4bca Fix closes issue #11109 - socketserver.ForkingMixIn leaves zombies, also fails to reap all zombies in one pass.
Senthil Kumaran <senthil@uthcode.com>
parents: 70344
diff changeset
569 return
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
570 else:
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
571 # Child process.
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
572 # This must never return, hence os._exit()!
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
573 try:
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
574 self.finish_request(request, client_address)
55140
81002c7600bd http://bugs.python.org/issue6382
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 55110
diff changeset
575 self.shutdown_request(request)
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
576 os._exit(0)
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
577 except:
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
578 try:
18471
99ad6fd279e9 Backport of Guido's checkin 1.25:
Thomas Wouters <thomas@python.org>
parents: 17400
diff changeset
579 self.handle_error(request, client_address)
55140
81002c7600bd http://bugs.python.org/issue6382
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 55110
diff changeset
580 self.shutdown_request(request)
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
581 finally:
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
582 os._exit(1)
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
583
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
584
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
585 class ThreadingMixIn:
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
586 """Mix-in class to handle each request in a new thread."""
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
587
26337
733e4b9d592e Patch #550765: Add daemon_threads flag.
Martin v. Löwis <martin@v.loewis.de>
parents: 25023
diff changeset
588 # Decides how threads will act upon termination of the
733e4b9d592e Patch #550765: Add daemon_threads flag.
Martin v. Löwis <martin@v.loewis.de>
parents: 25023
diff changeset
589 # main process
26347
3e02ead8de05 Use False instead of 0.
Fred Drake <fdrake@acm.org>
parents: 26337
diff changeset
590 daemon_threads = False
26337
733e4b9d592e Patch #550765: Add daemon_threads flag.
Martin v. Löwis <martin@v.loewis.de>
parents: 25023
diff changeset
591
20520
bc3c8419874c SF bug #471720: ThreadingMixIn/TCPServer forgets close
Guido van Rossum <guido@python.org>
parents: 20230
diff changeset
592 def process_request_thread(self, request, client_address):
20636
3f80c91b5c3c Apply the first chunk of the second patch from SF bug #471720:
Guido van Rossum <guido@python.org>
parents: 20520
diff changeset
593 """Same as in BaseServer but as a thread.
3f80c91b5c3c Apply the first chunk of the second patch from SF bug #471720:
Guido van Rossum <guido@python.org>
parents: 20520
diff changeset
594
3f80c91b5c3c Apply the first chunk of the second patch from SF bug #471720:
Guido van Rossum <guido@python.org>
parents: 20520
diff changeset
595 In addition, exception handling is done here.
3f80c91b5c3c Apply the first chunk of the second patch from SF bug #471720:
Guido van Rossum <guido@python.org>
parents: 20520
diff changeset
596
3f80c91b5c3c Apply the first chunk of the second patch from SF bug #471720:
Guido van Rossum <guido@python.org>
parents: 20520
diff changeset
597 """
3f80c91b5c3c Apply the first chunk of the second patch from SF bug #471720:
Guido van Rossum <guido@python.org>
parents: 20520
diff changeset
598 try:
3f80c91b5c3c Apply the first chunk of the second patch from SF bug #471720:
Guido van Rossum <guido@python.org>
parents: 20520
diff changeset
599 self.finish_request(request, client_address)
55140
81002c7600bd http://bugs.python.org/issue6382
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 55110
diff changeset
600 self.shutdown_request(request)
20636
3f80c91b5c3c Apply the first chunk of the second patch from SF bug #471720:
Guido van Rossum <guido@python.org>
parents: 20520
diff changeset
601 except:
3f80c91b5c3c Apply the first chunk of the second patch from SF bug #471720:
Guido van Rossum <guido@python.org>
parents: 20520
diff changeset
602 self.handle_error(request, client_address)
55140
81002c7600bd http://bugs.python.org/issue6382
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 55110
diff changeset
603 self.shutdown_request(request)
20520
bc3c8419874c SF bug #471720: ThreadingMixIn/TCPServer forgets close
Guido van Rossum <guido@python.org>
parents: 20230
diff changeset
604
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
605 def process_request(self, request, client_address):
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
606 """Start a new thread to process the request."""
20520
bc3c8419874c SF bug #471720: ThreadingMixIn/TCPServer forgets close
Guido van Rossum <guido@python.org>
parents: 20230
diff changeset
607 t = threading.Thread(target = self.process_request_thread,
11382
1ef1807377bf update to use threading module instead of thread.
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 11145
diff changeset
608 args = (request, client_address))
26337
733e4b9d592e Patch #550765: Add daemon_threads flag.
Martin v. Löwis <martin@v.loewis.de>
parents: 25023
diff changeset
609 if self.daemon_threads:
49239
b6a803188454 kill another set_daemon instance
Benjamin Peterson <benjamin@python.org>
parents: 47669
diff changeset
610 t.daemon = True
11382
1ef1807377bf update to use threading module instead of thread.
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 11145
diff changeset
611 t.start()
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
612
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
613
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
614 class ForkingUDPServer(ForkingMixIn, UDPServer): pass
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
615 class ForkingTCPServer(ForkingMixIn, TCPServer): pass
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
616
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
617 class ThreadingUDPServer(ThreadingMixIn, UDPServer): pass
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
618 class ThreadingTCPServer(ThreadingMixIn, TCPServer): pass
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
619
9544
16af2582c964 Patch by Jeff Bauer: a minor change to declare two new
Guido van Rossum <guido@python.org>
parents: 9485
diff changeset
620 if hasattr(socket, 'AF_UNIX'):
16af2582c964 Patch by Jeff Bauer: a minor change to declare two new
Guido van Rossum <guido@python.org>
parents: 9485
diff changeset
621
16af2582c964 Patch by Jeff Bauer: a minor change to declare two new
Guido van Rossum <guido@python.org>
parents: 9485
diff changeset
622 class UnixStreamServer(TCPServer):
16af2582c964 Patch by Jeff Bauer: a minor change to declare two new
Guido van Rossum <guido@python.org>
parents: 9485
diff changeset
623 address_family = socket.AF_UNIX
16af2582c964 Patch by Jeff Bauer: a minor change to declare two new
Guido van Rossum <guido@python.org>
parents: 9485
diff changeset
624
16af2582c964 Patch by Jeff Bauer: a minor change to declare two new
Guido van Rossum <guido@python.org>
parents: 9485
diff changeset
625 class UnixDatagramServer(UDPServer):
16af2582c964 Patch by Jeff Bauer: a minor change to declare two new
Guido van Rossum <guido@python.org>
parents: 9485
diff changeset
626 address_family = socket.AF_UNIX
16af2582c964 Patch by Jeff Bauer: a minor change to declare two new
Guido van Rossum <guido@python.org>
parents: 9485
diff changeset
627
16af2582c964 Patch by Jeff Bauer: a minor change to declare two new
Guido van Rossum <guido@python.org>
parents: 9485
diff changeset
628 class ThreadingUnixStreamServer(ThreadingMixIn, UnixStreamServer): pass
16af2582c964 Patch by Jeff Bauer: a minor change to declare two new
Guido van Rossum <guido@python.org>
parents: 9485
diff changeset
629
16af2582c964 Patch by Jeff Bauer: a minor change to declare two new
Guido van Rossum <guido@python.org>
parents: 9485
diff changeset
630 class ThreadingUnixDatagramServer(ThreadingMixIn, UnixDatagramServer): pass
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
631
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
632 class BaseRequestHandler:
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
633
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
634 """Base class for request handler classes.
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
635
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
636 This class is instantiated for each request to be handled. The
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
637 constructor sets the instance variables request, client_address
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
638 and server, and then calls the handle() method. To implement a
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
639 specific service, all you need to do is to derive a class which
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
640 defines a handle() method.
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
641
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
642 The handle() method can find the request as self.request, the
9485
6e6be896ec46 Fix typo in docstring: client_request should be client_address.
Guido van Rossum <guido@python.org>
parents: 8510
diff changeset
643 client address as self.client_address, and the server (in case it
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
644 needs access to per-server information) as self.server. Since a
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
645 separate instance is created for each request, the handle() method
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
646 can define arbitrary other instance variariables.
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
647
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
648 """
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
649
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
650 def __init__(self, request, client_address, server):
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
651 self.request = request
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
652 self.client_address = client_address
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
653 self.server = server
41969
9d02a4adf574 Merged revisions 55631-55794 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41760
diff changeset
654 self.setup()
55028
366c8a4e5a46 http://bugs.python.org/issue6267
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 54938
diff changeset
655 try:
366c8a4e5a46 http://bugs.python.org/issue6267
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 54938
diff changeset
656 self.handle()
366c8a4e5a46 http://bugs.python.org/issue6267
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 54938
diff changeset
657 finally:
366c8a4e5a46 http://bugs.python.org/issue6267
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 54938
diff changeset
658 self.finish()
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
659
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
660 def setup(self):
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
661 pass
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
662
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
663 def handle(self):
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
664 pass
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
665
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
666 def finish(self):
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
667 pass
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
668
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
669
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
670 # The following two classes make it possible to use the same service
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
671 # class for stream or datagram servers.
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
672 # Each class sets up these instance variables:
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
673 # - rfile: a file object from which receives the request is read
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
674 # - wfile: a file object to which the reply is written
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
675 # When the handle() method returns, wfile is flushed properly
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
676
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
677
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
678 class StreamRequestHandler(BaseRequestHandler):
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
679
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
680 """Define self.rfile and self.wfile for stream sockets."""
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
681
14331
cbe423b3ba3a In class StreamRequestHandler, make the default buffering for rfile
Guido van Rossum <guido@python.org>
parents: 12633
diff changeset
682 # Default buffer sizes for rfile, wfile.
cbe423b3ba3a In class StreamRequestHandler, make the default buffering for rfile
Guido van Rossum <guido@python.org>
parents: 12633
diff changeset
683 # We default rfile to buffered because otherwise it could be
cbe423b3ba3a In class StreamRequestHandler, make the default buffering for rfile
Guido van Rossum <guido@python.org>
parents: 12633
diff changeset
684 # really slow for large data (a getc() call per byte); we make
cbe423b3ba3a In class StreamRequestHandler, make the default buffering for rfile
Guido van Rossum <guido@python.org>
parents: 12633
diff changeset
685 # wfile unbuffered because (a) often after a write() we want to
cbe423b3ba3a In class StreamRequestHandler, make the default buffering for rfile
Guido van Rossum <guido@python.org>
parents: 12633
diff changeset
686 # read and we need to flush the line; (b) big writes to unbuffered
cbe423b3ba3a In class StreamRequestHandler, make the default buffering for rfile
Guido van Rossum <guido@python.org>
parents: 12633
diff changeset
687 # files are typically optimized by stdio even when big reads
cbe423b3ba3a In class StreamRequestHandler, make the default buffering for rfile
Guido van Rossum <guido@python.org>
parents: 12633
diff changeset
688 # aren't.
cbe423b3ba3a In class StreamRequestHandler, make the default buffering for rfile
Guido van Rossum <guido@python.org>
parents: 12633
diff changeset
689 rbufsize = -1
cbe423b3ba3a In class StreamRequestHandler, make the default buffering for rfile
Guido van Rossum <guido@python.org>
parents: 12633
diff changeset
690 wbufsize = 0
cbe423b3ba3a In class StreamRequestHandler, make the default buffering for rfile
Guido van Rossum <guido@python.org>
parents: 12633
diff changeset
691
55028
366c8a4e5a46 http://bugs.python.org/issue6267
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 54938
diff changeset
692 # A timeout to apply to the request socket, if not None.
366c8a4e5a46 http://bugs.python.org/issue6267
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 54938
diff changeset
693 timeout = None
366c8a4e5a46 http://bugs.python.org/issue6267
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 54938
diff changeset
694
68489
81d7f78a633a #11515: Merge with 3.1.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 68257
diff changeset
695 # Disable nagle algorithm for this socket, if True.
54938
52840be42530 http://bugs.python.org/issue6192
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 51869
diff changeset
696 # Use only when wbufsize != 0, to avoid small packets.
52840be42530 http://bugs.python.org/issue6192
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 51869
diff changeset
697 disable_nagle_algorithm = False
52840be42530 http://bugs.python.org/issue6192
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 51869
diff changeset
698
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
699 def setup(self):
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
700 self.connection = self.request
55028
366c8a4e5a46 http://bugs.python.org/issue6267
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 54938
diff changeset
701 if self.timeout is not None:
366c8a4e5a46 http://bugs.python.org/issue6267
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 54938
diff changeset
702 self.connection.settimeout(self.timeout)
54938
52840be42530 http://bugs.python.org/issue6192
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 51869
diff changeset
703 if self.disable_nagle_algorithm:
52840be42530 http://bugs.python.org/issue6192
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 51869
diff changeset
704 self.connection.setsockopt(socket.IPPROTO_TCP,
52840be42530 http://bugs.python.org/issue6192
Kristján Valur Jónsson <kristjan@ccpgames.com>
parents: 51869
diff changeset
705 socket.TCP_NODELAY, True)
14331
cbe423b3ba3a In class StreamRequestHandler, make the default buffering for rfile
Guido van Rossum <guido@python.org>
parents: 12633
diff changeset
706 self.rfile = self.connection.makefile('rb', self.rbufsize)
cbe423b3ba3a In class StreamRequestHandler, make the default buffering for rfile
Guido van Rossum <guido@python.org>
parents: 12633
diff changeset
707 self.wfile = self.connection.makefile('wb', self.wbufsize)
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
708
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
709 def finish(self):
27010
2687a9085411 Clearing out old patch queue. Patch #558547, make SocketServer more
Anthony Baxter <anthonybaxter@gmail.com>
parents: 26347
diff changeset
710 if not self.wfile.closed:
2687a9085411 Clearing out old patch queue. Patch #558547, make SocketServer more
Anthony Baxter <anthonybaxter@gmail.com>
parents: 26347
diff changeset
711 self.wfile.flush()
7840
aaa204a05f84 Explicitly close rfile and wfile in StreamRequestHandler.finish() --
Guido van Rossum <guido@python.org>
parents: 7755
diff changeset
712 self.wfile.close()
aaa204a05f84 Explicitly close rfile and wfile in StreamRequestHandler.finish() --
Guido van Rossum <guido@python.org>
parents: 7755
diff changeset
713 self.rfile.close()
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
714
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
715
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
716 class DatagramRequestHandler(BaseRequestHandler):
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
717
18471
99ad6fd279e9 Backport of Guido's checkin 1.25:
Thomas Wouters <thomas@python.org>
parents: 17400
diff changeset
718 # XXX Regrettably, I cannot get this working on Linux;
99ad6fd279e9 Backport of Guido's checkin 1.25:
Thomas Wouters <thomas@python.org>
parents: 17400
diff changeset
719 # s.recvfrom() doesn't return a meaningful client address.
99ad6fd279e9 Backport of Guido's checkin 1.25:
Thomas Wouters <thomas@python.org>
parents: 17400
diff changeset
720
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
721 """Define self.rfile and self.wfile for datagram sockets."""
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
722
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
723 def setup(self):
42429
b1bf1bab9779 SF patch# 1764815 by Paul Colomiets.
Guido van Rossum <guido@python.org>
parents: 41969
diff changeset
724 from io import BytesIO
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6346
diff changeset
725 self.packet, self.socket = self.request
42429
b1bf1bab9779 SF patch# 1764815 by Paul Colomiets.
Guido van Rossum <guido@python.org>
parents: 41969
diff changeset
726 self.rfile = BytesIO(self.packet)
b1bf1bab9779 SF patch# 1764815 by Paul Colomiets.
Guido van Rossum <guido@python.org>
parents: 41969
diff changeset
727 self.wfile = BytesIO()
2887
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
728
ec0b42889243 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
729 def finish(self):
8510
de0f0c3ed424 Fixed the UDP server -- this never worked. Ray Loyzaga deserves
Guido van Rossum <guido@python.org>
parents: 7840
diff changeset
730 self.socket.sendto(self.wfile.getvalue(), self.client_address)