Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 1 | """Generic socket server classes. |
| 2 | |
| 3 | This module tries to capture the various aspects of defining a server: |
| 4 | |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 5 | For socket-based servers: |
| 6 | |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 7 | - address family: |
Martin v. Löwis | a43c2f8 | 2001-07-24 20:34:08 +0000 | [diff] [blame] | 8 | - AF_INET{,6}: IP (Internet Protocol) sockets (default) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 9 | - AF_UNIX: Unix domain sockets |
| 10 | - others, e.g. AF_DECNET are conceivable (see <socket.h> |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 11 | - socket type: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 12 | - SOCK_STREAM (reliable stream, e.g. TCP) |
| 13 | - SOCK_DGRAM (datagrams, e.g. UDP) |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 14 | |
| 15 | For request-based servers (including socket-based): |
| 16 | |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 17 | - client address verification before further looking at the request |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 18 | (This is actually a hook for any processing that needs to look |
| 19 | at the request before anything else, e.g. logging) |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 20 | - how to handle multiple requests: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 21 | - synchronous (one request is handled at a time) |
| 22 | - forking (each request is handled by a new process) |
| 23 | - threading (each request is handled by a new thread) |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 24 | |
| 25 | The classes in this module favor the server type that is simplest to |
| 26 | write: a synchronous TCP/IP server. This is bad class design, but |
| 27 | save some typing. (There's also the issue that a deep class hierarchy |
| 28 | slows down method lookups.) |
| 29 | |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 30 | There are five classes in an inheritance diagram, four of which represent |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 31 | synchronous servers of four types: |
| 32 | |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 33 | +------------+ |
| 34 | | BaseServer | |
| 35 | +------------+ |
| 36 | | |
| 37 | v |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 38 | +-----------+ +------------------+ |
| 39 | | TCPServer |------->| UnixStreamServer | |
| 40 | +-----------+ +------------------+ |
| 41 | | |
| 42 | v |
| 43 | +-----------+ +--------------------+ |
| 44 | | UDPServer |------->| UnixDatagramServer | |
| 45 | +-----------+ +--------------------+ |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 46 | |
Guido van Rossum | db2b70c | 1997-07-16 16:21:38 +0000 | [diff] [blame] | 47 | Note that UnixDatagramServer derives from UDPServer, not from |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 48 | UnixStreamServer -- the only difference between an IP and a Unix |
| 49 | stream server is the address family, which is simply repeated in both |
Guido van Rossum | db2b70c | 1997-07-16 16:21:38 +0000 | [diff] [blame] | 50 | unix server classes. |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 51 | |
| 52 | Forking and threading versions of each type of server can be created |
Guido van Rossum | ebbffd4 | 2005-04-30 00:20:35 +0000 | [diff] [blame] | 53 | using the ForkingMixIn and ThreadingMixIn mix-in classes. For |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 54 | instance, a threading UDP server class is created as follows: |
| 55 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 56 | class ThreadingUDPServer(ThreadingMixIn, UDPServer): pass |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 57 | |
Guido van Rossum | db2b70c | 1997-07-16 16:21:38 +0000 | [diff] [blame] | 58 | The Mix-in class must come first, since it overrides a method defined |
Martin v. Löwis | f86e8ef | 2002-11-22 08:08:44 +0000 | [diff] [blame] | 59 | in UDPServer! Setting the various member variables also changes |
| 60 | the behavior of the underlying server mechanism. |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 61 | |
| 62 | To implement a service, you must derive a class from |
| 63 | BaseRequestHandler and redefine its handle() method. You can then run |
| 64 | various versions of the service by combining one of the server classes |
| 65 | with your request handler class. |
| 66 | |
| 67 | The request handler class must be different for datagram or stream |
Georg Brandl | ca5feab | 2005-07-18 07:38:44 +0000 | [diff] [blame] | 68 | services. This can be hidden by using the request handler |
| 69 | subclasses StreamRequestHandler or DatagramRequestHandler. |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 70 | |
| 71 | Of course, you still have to use your head! |
| 72 | |
| 73 | For instance, it makes no sense to use a forking server if the service |
| 74 | contains state in memory that can be modified by requests (since the |
| 75 | modifications in the child process would never reach the initial state |
| 76 | kept in the parent process and passed to each child). In this case, |
| 77 | you can use a threading server, but you will probably have to use |
| 78 | locks to avoid two requests that come in nearly simultaneous to apply |
| 79 | conflicting changes to the server state. |
| 80 | |
| 81 | On the other hand, if you are building e.g. an HTTP server, where all |
| 82 | data is stored externally (e.g. in the file system), a synchronous |
| 83 | class will essentially render the service "deaf" while one request is |
| 84 | being handled -- which may be for a very long time if a client is slow |
Ezio Melotti | f78869e | 2011-10-29 10:41:51 +0300 | [diff] [blame] | 85 | to read all the data it has requested. Here a threading or forking |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 86 | server is appropriate. |
| 87 | |
| 88 | In some cases, it may be appropriate to process part of a request |
| 89 | synchronously, but to finish processing in a forked child depending on |
| 90 | the request data. This can be implemented by using a synchronous |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 91 | server and doing an explicit fork in the request handler class |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 92 | handle() method. |
| 93 | |
| 94 | Another approach to handling multiple simultaneous requests in an |
| 95 | environment that supports neither threads nor fork (or where these are |
| 96 | too expensive or inappropriate for the service) is to maintain an |
Charles-François Natali | 1d29cc5 | 2014-03-24 22:25:39 +0000 | [diff] [blame] | 97 | explicit table of partially finished requests and to use a selector to |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 98 | decide which request to work on next (or whether to handle a new |
| 99 | incoming request). This is particularly important for stream services |
| 100 | where each client can potentially be connected for a long time (if |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 101 | threads or subprocesses cannot be used). |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 102 | |
| 103 | Future work: |
| 104 | - Standard classes for Sun RPC (which uses either UDP or TCP) |
| 105 | - Standard mix-in classes to implement various authentication |
| 106 | and encryption schemes |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 107 | |
| 108 | XXX Open problems: |
| 109 | - What to do with out-of-band data? |
| 110 | |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 111 | BaseServer: |
| 112 | - split generic "request" functionality out into BaseServer class. |
| 113 | Copyright (C) 2000 Luke Kenneth Casson Leighton <lkcl@samba.org> |
| 114 | |
| 115 | example: read entries from a SQL database (requires overriding |
| 116 | get_request() to return a table entry from the database). |
| 117 | entry is processed by a RequestHandlerClass. |
| 118 | |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 119 | """ |
| 120 | |
Guido van Rossum | 10b0418 | 2001-01-19 16:45:46 +0000 | [diff] [blame] | 121 | # Author of the BaseServer patch: Luke Kenneth Casson Leighton |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 122 | |
Guido van Rossum | 7de4d64 | 2001-07-10 11:50:09 +0000 | [diff] [blame] | 123 | # XXX Warning! |
| 124 | # There is a test suite for this module, but it cannot be run by the |
| 125 | # standard regression test. |
| 126 | # To run it manually, run Lib/test/test_socketserver.py. |
| 127 | |
| 128 | __version__ = "0.4" |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 129 | |
| 130 | |
| 131 | import socket |
Charles-François Natali | 1d29cc5 | 2014-03-24 22:25:39 +0000 | [diff] [blame] | 132 | import selectors |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 133 | import os |
Antoine Pitrou | b0a9c66 | 2012-04-09 00:47:24 +0200 | [diff] [blame] | 134 | import errno |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 135 | try: |
| 136 | import threading |
Brett Cannon | cd171c8 | 2013-07-04 17:43:24 -0400 | [diff] [blame] | 137 | except ImportError: |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 138 | import dummy_threading as threading |
Victor Stinner | ae58649 | 2014-09-02 23:18:25 +0200 | [diff] [blame] | 139 | from time import monotonic as time |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 140 | |
Berker Peksag | 3265344 | 2015-02-03 11:55:09 +0200 | [diff] [blame] | 141 | __all__ = ["BaseServer", "TCPServer", "UDPServer", "ForkingUDPServer", |
| 142 | "ForkingTCPServer", "ThreadingUDPServer", "ThreadingTCPServer", |
| 143 | "BaseRequestHandler", "StreamRequestHandler", |
| 144 | "DatagramRequestHandler", "ThreadingMixIn", "ForkingMixIn"] |
Skip Montanaro | e99d5ea | 2001-01-20 19:54:20 +0000 | [diff] [blame] | 145 | if hasattr(socket, "AF_UNIX"): |
| 146 | __all__.extend(["UnixStreamServer","UnixDatagramServer", |
| 147 | "ThreadingUnixStreamServer", |
| 148 | "ThreadingUnixDatagramServer"]) |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 149 | |
Charles-François Natali | 1d29cc5 | 2014-03-24 22:25:39 +0000 | [diff] [blame] | 150 | # poll/select have the advantage of not requiring any extra file descriptor, |
| 151 | # contrarily to epoll/kqueue (also, they require a single syscall). |
| 152 | if hasattr(selectors, 'PollSelector'): |
| 153 | _ServerSelector = selectors.PollSelector |
| 154 | else: |
| 155 | _ServerSelector = selectors.SelectSelector |
| 156 | |
Antoine Pitrou | b0a9c66 | 2012-04-09 00:47:24 +0200 | [diff] [blame] | 157 | |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 158 | class BaseServer: |
| 159 | |
| 160 | """Base class for server classes. |
| 161 | |
| 162 | Methods for the caller: |
| 163 | |
| 164 | - __init__(server_address, RequestHandlerClass) |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 165 | - serve_forever(poll_interval=0.5) |
| 166 | - shutdown() |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 167 | - handle_request() # if you do not use serve_forever() |
Charles-François Natali | 1d29cc5 | 2014-03-24 22:25:39 +0000 | [diff] [blame] | 168 | - fileno() -> int # for selector |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 169 | |
| 170 | Methods that may be overridden: |
| 171 | |
| 172 | - server_bind() |
| 173 | - server_activate() |
| 174 | - get_request() -> request, client_address |
Georg Brandl | fceab5a | 2008-01-19 20:08:23 +0000 | [diff] [blame] | 175 | - handle_timeout() |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 176 | - verify_request(request, client_address) |
| 177 | - server_close() |
| 178 | - process_request(request, client_address) |
Kristján Valur Jónsson | a5b47ce | 2009-07-07 09:09:10 +0000 | [diff] [blame] | 179 | - shutdown_request(request) |
Ka-Ping Yee | 285a7e5 | 2001-04-11 04:02:05 +0000 | [diff] [blame] | 180 | - close_request(request) |
Senthil Kumaran | 5e826e8 | 2011-05-26 00:22:59 +0800 | [diff] [blame] | 181 | - service_actions() |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 182 | - handle_error() |
| 183 | |
| 184 | Methods for derived classes: |
| 185 | |
| 186 | - finish_request(request, client_address) |
| 187 | |
| 188 | Class variables that may be overridden by derived classes or |
| 189 | instances: |
| 190 | |
Georg Brandl | fceab5a | 2008-01-19 20:08:23 +0000 | [diff] [blame] | 191 | - timeout |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 192 | - address_family |
| 193 | - socket_type |
Barry Warsaw | b97f0b7 | 2003-10-09 23:48:52 +0000 | [diff] [blame] | 194 | - allow_reuse_address |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 195 | |
| 196 | Instance variables: |
| 197 | |
| 198 | - RequestHandlerClass |
| 199 | - socket |
| 200 | |
| 201 | """ |
| 202 | |
Georg Brandl | fceab5a | 2008-01-19 20:08:23 +0000 | [diff] [blame] | 203 | timeout = None |
| 204 | |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 205 | def __init__(self, server_address, RequestHandlerClass): |
| 206 | """Constructor. May be extended, do not override.""" |
| 207 | self.server_address = server_address |
| 208 | self.RequestHandlerClass = RequestHandlerClass |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 209 | self.__is_shut_down = threading.Event() |
Antoine Pitrou | 3bcba8e | 2010-04-25 22:01:43 +0000 | [diff] [blame] | 210 | self.__shutdown_request = False |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 211 | |
| 212 | def server_activate(self): |
| 213 | """Called by constructor to activate the server. |
| 214 | |
| 215 | May be overridden. |
| 216 | |
| 217 | """ |
| 218 | pass |
| 219 | |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 220 | def serve_forever(self, poll_interval=0.5): |
| 221 | """Handle one request at a time until shutdown. |
| 222 | |
| 223 | Polls for shutdown every poll_interval seconds. Ignores |
| 224 | self.timeout. If you need to do periodic tasks, do them in |
| 225 | another thread. |
| 226 | """ |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 227 | self.__is_shut_down.clear() |
Antoine Pitrou | 3bcba8e | 2010-04-25 22:01:43 +0000 | [diff] [blame] | 228 | try: |
Charles-François Natali | 1d29cc5 | 2014-03-24 22:25:39 +0000 | [diff] [blame] | 229 | # XXX: Consider using another file descriptor or connecting to the |
| 230 | # socket to wake this up instead of polling. Polling reduces our |
| 231 | # responsiveness to a shutdown request and wastes cpu at all other |
| 232 | # times. |
| 233 | with _ServerSelector() as selector: |
| 234 | selector.register(self, selectors.EVENT_READ) |
Senthil Kumaran | 5e826e8 | 2011-05-26 00:22:59 +0800 | [diff] [blame] | 235 | |
Charles-François Natali | 1d29cc5 | 2014-03-24 22:25:39 +0000 | [diff] [blame] | 236 | while not self.__shutdown_request: |
| 237 | ready = selector.select(poll_interval) |
| 238 | if ready: |
| 239 | self._handle_request_noblock() |
| 240 | |
| 241 | self.service_actions() |
Antoine Pitrou | 3bcba8e | 2010-04-25 22:01:43 +0000 | [diff] [blame] | 242 | finally: |
| 243 | self.__shutdown_request = False |
| 244 | self.__is_shut_down.set() |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 245 | |
| 246 | def shutdown(self): |
| 247 | """Stops the serve_forever loop. |
| 248 | |
| 249 | Blocks until the loop has finished. This must be called while |
| 250 | serve_forever() is running in another thread, or it will |
| 251 | deadlock. |
| 252 | """ |
Antoine Pitrou | 3bcba8e | 2010-04-25 22:01:43 +0000 | [diff] [blame] | 253 | self.__shutdown_request = True |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 254 | self.__is_shut_down.wait() |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 255 | |
Senthil Kumaran | 5e826e8 | 2011-05-26 00:22:59 +0800 | [diff] [blame] | 256 | def service_actions(self): |
| 257 | """Called by the serve_forever() loop. |
| 258 | |
| 259 | May be overridden by a subclass / Mixin to implement any code that |
| 260 | needs to be run during the loop. |
| 261 | """ |
| 262 | pass |
| 263 | |
Charles-François Natali | 1d29cc5 | 2014-03-24 22:25:39 +0000 | [diff] [blame] | 264 | # The distinction between handling, getting, processing and finishing a |
| 265 | # request is fairly arbitrary. Remember: |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 266 | # |
Charles-François Natali | 1d29cc5 | 2014-03-24 22:25:39 +0000 | [diff] [blame] | 267 | # - handle_request() is the top-level call. It calls selector.select(), |
| 268 | # get_request(), verify_request() and process_request() |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 269 | # - get_request() is different for stream or datagram sockets |
Charles-François Natali | 1d29cc5 | 2014-03-24 22:25:39 +0000 | [diff] [blame] | 270 | # - process_request() is the place that may fork a new process or create a |
| 271 | # new thread to finish the request |
| 272 | # - finish_request() instantiates the request handler class; this |
| 273 | # constructor will handle the request all by itself |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 274 | |
| 275 | def handle_request(self): |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 276 | """Handle one request, possibly blocking. |
| 277 | |
| 278 | Respects self.timeout. |
| 279 | """ |
| 280 | # Support people who used socket.settimeout() to escape |
| 281 | # handle_request before self.timeout was available. |
| 282 | timeout = self.socket.gettimeout() |
| 283 | if timeout is None: |
| 284 | timeout = self.timeout |
| 285 | elif self.timeout is not None: |
| 286 | timeout = min(timeout, self.timeout) |
Charles-François Natali | 1d29cc5 | 2014-03-24 22:25:39 +0000 | [diff] [blame] | 287 | if timeout is not None: |
| 288 | deadline = time() + timeout |
| 289 | |
| 290 | # Wait until a request arrives or the timeout expires - the loop is |
Berker Peksag | 1ed2e69 | 2014-10-19 18:07:05 +0300 | [diff] [blame] | 291 | # necessary to accommodate early wakeups due to EINTR. |
Charles-François Natali | 1d29cc5 | 2014-03-24 22:25:39 +0000 | [diff] [blame] | 292 | with _ServerSelector() as selector: |
| 293 | selector.register(self, selectors.EVENT_READ) |
| 294 | |
| 295 | while True: |
| 296 | ready = selector.select(timeout) |
| 297 | if ready: |
| 298 | return self._handle_request_noblock() |
| 299 | else: |
| 300 | if timeout is not None: |
| 301 | timeout = deadline - time() |
| 302 | if timeout < 0: |
| 303 | return self.handle_timeout() |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 304 | |
| 305 | def _handle_request_noblock(self): |
| 306 | """Handle one request, without blocking. |
| 307 | |
Charles-François Natali | 1d29cc5 | 2014-03-24 22:25:39 +0000 | [diff] [blame] | 308 | I assume that selector.select() has returned that the socket is |
| 309 | readable before this function was called, so there should be no risk of |
| 310 | blocking in get_request(). |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 311 | """ |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 312 | try: |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 313 | request, client_address = self.get_request() |
Andrew Svetlov | 0832af6 | 2012-12-18 23:10:48 +0200 | [diff] [blame] | 314 | except OSError: |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 315 | return |
| 316 | if self.verify_request(request, client_address): |
| 317 | try: |
| 318 | self.process_request(request, client_address) |
| 319 | except: |
| 320 | self.handle_error(request, client_address) |
Kristján Valur Jónsson | a5b47ce | 2009-07-07 09:09:10 +0000 | [diff] [blame] | 321 | self.shutdown_request(request) |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 322 | |
Georg Brandl | fceab5a | 2008-01-19 20:08:23 +0000 | [diff] [blame] | 323 | def handle_timeout(self): |
| 324 | """Called if no new request arrives within self.timeout. |
| 325 | |
| 326 | Overridden by ForkingMixIn. |
| 327 | """ |
| 328 | pass |
| 329 | |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 330 | def verify_request(self, request, client_address): |
| 331 | """Verify the request. May be overridden. |
| 332 | |
Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 333 | Return True if we should proceed with this request. |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 334 | |
| 335 | """ |
Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 336 | return True |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 337 | |
| 338 | def process_request(self, request, client_address): |
| 339 | """Call finish_request. |
| 340 | |
| 341 | Overridden by ForkingMixIn and ThreadingMixIn. |
| 342 | |
| 343 | """ |
| 344 | self.finish_request(request, client_address) |
Kristján Valur Jónsson | a5b47ce | 2009-07-07 09:09:10 +0000 | [diff] [blame] | 345 | self.shutdown_request(request) |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 346 | |
| 347 | def server_close(self): |
| 348 | """Called to clean-up the server. |
| 349 | |
| 350 | May be overridden. |
| 351 | |
| 352 | """ |
| 353 | pass |
| 354 | |
| 355 | def finish_request(self, request, client_address): |
| 356 | """Finish one request by instantiating RequestHandlerClass.""" |
| 357 | self.RequestHandlerClass(request, client_address, self) |
| 358 | |
Kristján Valur Jónsson | a5b47ce | 2009-07-07 09:09:10 +0000 | [diff] [blame] | 359 | def shutdown_request(self, request): |
| 360 | """Called to shutdown and close an individual request.""" |
| 361 | self.close_request(request) |
| 362 | |
Ka-Ping Yee | 285a7e5 | 2001-04-11 04:02:05 +0000 | [diff] [blame] | 363 | def close_request(self, request): |
| 364 | """Called to clean up an individual request.""" |
| 365 | pass |
| 366 | |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 367 | def handle_error(self, request, client_address): |
| 368 | """Handle an error gracefully. May be overridden. |
| 369 | |
| 370 | The default is to print a traceback and continue. |
| 371 | |
| 372 | """ |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 373 | print('-'*40) |
| 374 | print('Exception happened during processing of request from', end=' ') |
| 375 | print(client_address) |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 376 | import traceback |
| 377 | traceback.print_exc() # XXX But this goes to stderr! |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 378 | print('-'*40) |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 379 | |
| 380 | |
| 381 | class TCPServer(BaseServer): |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 382 | |
| 383 | """Base class for various socket-based server classes. |
| 384 | |
| 385 | Defaults to synchronous IP stream (i.e., TCP). |
| 386 | |
| 387 | Methods for the caller: |
| 388 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 389 | - __init__(server_address, RequestHandlerClass, bind_and_activate=True) |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 390 | - serve_forever(poll_interval=0.5) |
| 391 | - shutdown() |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 392 | - handle_request() # if you don't use serve_forever() |
Charles-François Natali | 1d29cc5 | 2014-03-24 22:25:39 +0000 | [diff] [blame] | 393 | - fileno() -> int # for selector |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 394 | |
| 395 | Methods that may be overridden: |
| 396 | |
| 397 | - server_bind() |
| 398 | - server_activate() |
| 399 | - get_request() -> request, client_address |
Georg Brandl | fceab5a | 2008-01-19 20:08:23 +0000 | [diff] [blame] | 400 | - handle_timeout() |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 401 | - verify_request(request, client_address) |
| 402 | - process_request(request, client_address) |
Kristján Valur Jónsson | a5b47ce | 2009-07-07 09:09:10 +0000 | [diff] [blame] | 403 | - shutdown_request(request) |
Ka-Ping Yee | 285a7e5 | 2001-04-11 04:02:05 +0000 | [diff] [blame] | 404 | - close_request(request) |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 405 | - handle_error() |
| 406 | |
| 407 | Methods for derived classes: |
| 408 | |
| 409 | - finish_request(request, client_address) |
| 410 | |
| 411 | Class variables that may be overridden by derived classes or |
| 412 | instances: |
| 413 | |
Georg Brandl | fceab5a | 2008-01-19 20:08:23 +0000 | [diff] [blame] | 414 | - timeout |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 415 | - address_family |
| 416 | - socket_type |
| 417 | - request_queue_size (only for stream sockets) |
Barry Warsaw | 3aaad50 | 2003-10-09 22:44:05 +0000 | [diff] [blame] | 418 | - allow_reuse_address |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 419 | |
| 420 | Instance variables: |
| 421 | |
| 422 | - server_address |
| 423 | - RequestHandlerClass |
| 424 | - socket |
| 425 | |
| 426 | """ |
| 427 | |
| 428 | address_family = socket.AF_INET |
| 429 | |
| 430 | socket_type = socket.SOCK_STREAM |
| 431 | |
| 432 | request_queue_size = 5 |
| 433 | |
Raymond Hettinger | c8f8034 | 2002-08-25 16:36:49 +0000 | [diff] [blame] | 434 | allow_reuse_address = False |
Guido van Rossum | e3c7a5f | 2000-05-09 14:53:29 +0000 | [diff] [blame] | 435 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 436 | def __init__(self, server_address, RequestHandlerClass, bind_and_activate=True): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 437 | """Constructor. May be extended, do not override.""" |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 438 | BaseServer.__init__(self, server_address, RequestHandlerClass) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 439 | self.socket = socket.socket(self.address_family, |
| 440 | self.socket_type) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 441 | if bind_and_activate: |
Charles-François Natali | 0f4f048 | 2014-10-13 19:19:26 +0100 | [diff] [blame] | 442 | try: |
| 443 | self.server_bind() |
| 444 | self.server_activate() |
| 445 | except: |
| 446 | self.server_close() |
| 447 | raise |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 448 | |
| 449 | def server_bind(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 450 | """Called by constructor to bind the socket. |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 451 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 452 | May be overridden. |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 453 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 454 | """ |
Guido van Rossum | e3c7a5f | 2000-05-09 14:53:29 +0000 | [diff] [blame] | 455 | if self.allow_reuse_address: |
| 456 | self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 457 | self.socket.bind(self.server_address) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 458 | self.server_address = self.socket.getsockname() |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 459 | |
| 460 | def server_activate(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 461 | """Called by constructor to activate the server. |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 462 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 463 | May be overridden. |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 464 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 465 | """ |
| 466 | self.socket.listen(self.request_queue_size) |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 467 | |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 468 | def server_close(self): |
| 469 | """Called to clean-up the server. |
| 470 | |
| 471 | May be overridden. |
| 472 | |
| 473 | """ |
| 474 | self.socket.close() |
| 475 | |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 476 | def fileno(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 477 | """Return socket file number. |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 478 | |
Charles-François Natali | 1d29cc5 | 2014-03-24 22:25:39 +0000 | [diff] [blame] | 479 | Interface required by selector. |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 480 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 481 | """ |
| 482 | return self.socket.fileno() |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 483 | |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 484 | def get_request(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 485 | """Get the request and client address from the socket. |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 486 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 487 | May be overridden. |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 488 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 489 | """ |
| 490 | return self.socket.accept() |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 491 | |
Kristján Valur Jónsson | a5b47ce | 2009-07-07 09:09:10 +0000 | [diff] [blame] | 492 | def shutdown_request(self, request): |
| 493 | """Called to shutdown and close an individual request.""" |
Kristján Valur Jónsson | 200cfd0 | 2009-07-04 15:18:00 +0000 | [diff] [blame] | 494 | try: |
| 495 | #explicitly shutdown. socket.close() merely releases |
| 496 | #the socket and waits for GC to perform the actual close. |
| 497 | request.shutdown(socket.SHUT_WR) |
Andrew Svetlov | 0832af6 | 2012-12-18 23:10:48 +0200 | [diff] [blame] | 498 | except OSError: |
Kristján Valur Jónsson | 200cfd0 | 2009-07-04 15:18:00 +0000 | [diff] [blame] | 499 | pass #some platforms may raise ENOTCONN here |
Kristján Valur Jónsson | a5b47ce | 2009-07-07 09:09:10 +0000 | [diff] [blame] | 500 | self.close_request(request) |
| 501 | |
| 502 | def close_request(self, request): |
| 503 | """Called to clean up an individual request.""" |
Ka-Ping Yee | 285a7e5 | 2001-04-11 04:02:05 +0000 | [diff] [blame] | 504 | request.close() |
| 505 | |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 506 | |
| 507 | class UDPServer(TCPServer): |
| 508 | |
| 509 | """UDP server class.""" |
| 510 | |
Raymond Hettinger | c8f8034 | 2002-08-25 16:36:49 +0000 | [diff] [blame] | 511 | allow_reuse_address = False |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 512 | |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 513 | socket_type = socket.SOCK_DGRAM |
| 514 | |
| 515 | max_packet_size = 8192 |
| 516 | |
| 517 | def get_request(self): |
Guido van Rossum | 3249082 | 1998-06-16 02:27:33 +0000 | [diff] [blame] | 518 | data, client_addr = self.socket.recvfrom(self.max_packet_size) |
| 519 | return (data, self.socket), client_addr |
| 520 | |
| 521 | def server_activate(self): |
| 522 | # No need to call listen() for UDP. |
| 523 | pass |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 524 | |
Kristján Valur Jónsson | a5b47ce | 2009-07-07 09:09:10 +0000 | [diff] [blame] | 525 | def shutdown_request(self, request): |
| 526 | # No need to shutdown anything. |
| 527 | self.close_request(request) |
| 528 | |
Ka-Ping Yee | 285a7e5 | 2001-04-11 04:02:05 +0000 | [diff] [blame] | 529 | def close_request(self, request): |
| 530 | # No need to close anything. |
| 531 | pass |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 532 | |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 533 | class ForkingMixIn: |
| 534 | |
| 535 | """Mix-in class to handle each request in a new process.""" |
| 536 | |
Georg Brandl | fceab5a | 2008-01-19 20:08:23 +0000 | [diff] [blame] | 537 | timeout = 300 |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 538 | active_children = None |
Guido van Rossum | 2ab455a | 1999-07-28 21:39:28 +0000 | [diff] [blame] | 539 | max_children = 40 |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 540 | |
| 541 | def collect_children(self): |
Georg Brandl | fceab5a | 2008-01-19 20:08:23 +0000 | [diff] [blame] | 542 | """Internal routine to wait for children that have exited.""" |
Charles-François Natali | af4db37 | 2014-06-20 22:49:26 +0100 | [diff] [blame] | 543 | if self.active_children is None: |
| 544 | return |
Christian Heimes | 70e7ea2 | 2008-02-28 20:02:27 +0000 | [diff] [blame] | 545 | |
Charles-François Natali | af4db37 | 2014-06-20 22:49:26 +0100 | [diff] [blame] | 546 | # If we're above the max number of children, wait and reap them until |
| 547 | # we go back below threshold. Note that we use waitpid(-1) below to be |
| 548 | # able to collect children in size(<defunct children>) syscalls instead |
| 549 | # of size(<children>): the downside is that this might reap children |
| 550 | # which we didn't spawn, which is why we only resort to this when we're |
| 551 | # above max_children. |
| 552 | while len(self.active_children) >= self.max_children: |
Christian Heimes | 70e7ea2 | 2008-02-28 20:02:27 +0000 | [diff] [blame] | 553 | try: |
Charles-François Natali | af4db37 | 2014-06-20 22:49:26 +0100 | [diff] [blame] | 554 | pid, _ = os.waitpid(-1, 0) |
| 555 | self.active_children.discard(pid) |
Charles-François Natali | af4db37 | 2014-06-20 22:49:26 +0100 | [diff] [blame] | 556 | except ChildProcessError: |
| 557 | # we don't have any children, we're done |
| 558 | self.active_children.clear() |
Andrew Svetlov | ad28c7f | 2012-12-18 22:02:39 +0200 | [diff] [blame] | 559 | except OSError: |
Charles-François Natali | af4db37 | 2014-06-20 22:49:26 +0100 | [diff] [blame] | 560 | break |
| 561 | |
| 562 | # Now reap all defunct children. |
| 563 | for pid in self.active_children.copy(): |
Christian Heimes | a156e09 | 2008-02-16 07:38:31 +0000 | [diff] [blame] | 564 | try: |
Charles-François Natali | af4db37 | 2014-06-20 22:49:26 +0100 | [diff] [blame] | 565 | pid, _ = os.waitpid(pid, os.WNOHANG) |
| 566 | # if the child hasn't exited yet, pid will be 0 and ignored by |
| 567 | # discard() below |
| 568 | self.active_children.discard(pid) |
| 569 | except ChildProcessError: |
| 570 | # someone else reaped it |
| 571 | self.active_children.discard(pid) |
| 572 | except OSError: |
| 573 | pass |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 574 | |
Georg Brandl | fceab5a | 2008-01-19 20:08:23 +0000 | [diff] [blame] | 575 | def handle_timeout(self): |
| 576 | """Wait for zombies after self.timeout seconds of inactivity. |
| 577 | |
| 578 | May be extended, do not override. |
| 579 | """ |
| 580 | self.collect_children() |
| 581 | |
Senthil Kumaran | 5e826e8 | 2011-05-26 00:22:59 +0800 | [diff] [blame] | 582 | def service_actions(self): |
R David Murray | 258fabe | 2012-10-01 21:43:46 -0400 | [diff] [blame] | 583 | """Collect the zombie child processes regularly in the ForkingMixIn. |
Senthil Kumaran | 5e826e8 | 2011-05-26 00:22:59 +0800 | [diff] [blame] | 584 | |
| 585 | service_actions is called in the BaseServer's serve_forver loop. |
| 586 | """ |
| 587 | self.collect_children() |
| 588 | |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 589 | def process_request(self, request, client_address): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 590 | """Fork a new subprocess to process the request.""" |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 591 | pid = os.fork() |
| 592 | if pid: |
| 593 | # Parent process |
| 594 | if self.active_children is None: |
Charles-François Natali | af4db37 | 2014-06-20 22:49:26 +0100 | [diff] [blame] | 595 | self.active_children = set() |
| 596 | self.active_children.add(pid) |
Guido van Rossum | 7de4d64 | 2001-07-10 11:50:09 +0000 | [diff] [blame] | 597 | self.close_request(request) |
Senthil Kumaran | 5e826e8 | 2011-05-26 00:22:59 +0800 | [diff] [blame] | 598 | return |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 599 | else: |
| 600 | # Child process. |
| 601 | # This must never return, hence os._exit()! |
| 602 | try: |
| 603 | self.finish_request(request, client_address) |
Kristján Valur Jónsson | a5b47ce | 2009-07-07 09:09:10 +0000 | [diff] [blame] | 604 | self.shutdown_request(request) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 605 | os._exit(0) |
| 606 | except: |
| 607 | try: |
Guido van Rossum | 7de4d64 | 2001-07-10 11:50:09 +0000 | [diff] [blame] | 608 | self.handle_error(request, client_address) |
Kristján Valur Jónsson | a5b47ce | 2009-07-07 09:09:10 +0000 | [diff] [blame] | 609 | self.shutdown_request(request) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 610 | finally: |
| 611 | os._exit(1) |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 612 | |
| 613 | |
| 614 | class ThreadingMixIn: |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 615 | """Mix-in class to handle each request in a new thread.""" |
| 616 | |
Martin v. Löwis | f86e8ef | 2002-11-22 08:08:44 +0000 | [diff] [blame] | 617 | # Decides how threads will act upon termination of the |
| 618 | # main process |
Fred Drake | 132e0e8 | 2002-11-22 14:22:49 +0000 | [diff] [blame] | 619 | daemon_threads = False |
Martin v. Löwis | f86e8ef | 2002-11-22 08:08:44 +0000 | [diff] [blame] | 620 | |
Guido van Rossum | a5343cc | 2001-10-18 18:02:07 +0000 | [diff] [blame] | 621 | def process_request_thread(self, request, client_address): |
Guido van Rossum | 83c3281 | 2001-10-23 21:42:45 +0000 | [diff] [blame] | 622 | """Same as in BaseServer but as a thread. |
| 623 | |
| 624 | In addition, exception handling is done here. |
| 625 | |
| 626 | """ |
| 627 | try: |
| 628 | self.finish_request(request, client_address) |
Kristján Valur Jónsson | a5b47ce | 2009-07-07 09:09:10 +0000 | [diff] [blame] | 629 | self.shutdown_request(request) |
Guido van Rossum | 83c3281 | 2001-10-23 21:42:45 +0000 | [diff] [blame] | 630 | except: |
| 631 | self.handle_error(request, client_address) |
Kristján Valur Jónsson | a5b47ce | 2009-07-07 09:09:10 +0000 | [diff] [blame] | 632 | self.shutdown_request(request) |
Guido van Rossum | a5343cc | 2001-10-18 18:02:07 +0000 | [diff] [blame] | 633 | |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 634 | def process_request(self, request, client_address): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 635 | """Start a new thread to process the request.""" |
Guido van Rossum | a5343cc | 2001-10-18 18:02:07 +0000 | [diff] [blame] | 636 | t = threading.Thread(target = self.process_request_thread, |
Jeremy Hylton | 7526027 | 1999-10-12 16:20:13 +0000 | [diff] [blame] | 637 | args = (request, client_address)) |
Florent Xicluna | 12b66b5 | 2011-11-04 10:16:28 +0100 | [diff] [blame] | 638 | t.daemon = self.daemon_threads |
Jeremy Hylton | 7526027 | 1999-10-12 16:20:13 +0000 | [diff] [blame] | 639 | t.start() |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 640 | |
| 641 | |
| 642 | class ForkingUDPServer(ForkingMixIn, UDPServer): pass |
| 643 | class ForkingTCPServer(ForkingMixIn, TCPServer): pass |
| 644 | |
| 645 | class ThreadingUDPServer(ThreadingMixIn, UDPServer): pass |
| 646 | class ThreadingTCPServer(ThreadingMixIn, TCPServer): pass |
| 647 | |
Guido van Rossum | 67a40e8 | 1998-11-30 15:07:01 +0000 | [diff] [blame] | 648 | if hasattr(socket, 'AF_UNIX'): |
| 649 | |
| 650 | class UnixStreamServer(TCPServer): |
| 651 | address_family = socket.AF_UNIX |
| 652 | |
| 653 | class UnixDatagramServer(UDPServer): |
| 654 | address_family = socket.AF_UNIX |
| 655 | |
| 656 | class ThreadingUnixStreamServer(ThreadingMixIn, UnixStreamServer): pass |
| 657 | |
| 658 | class ThreadingUnixDatagramServer(ThreadingMixIn, UnixDatagramServer): pass |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 659 | |
| 660 | class BaseRequestHandler: |
| 661 | |
| 662 | """Base class for request handler classes. |
| 663 | |
| 664 | This class is instantiated for each request to be handled. The |
| 665 | constructor sets the instance variables request, client_address |
| 666 | and server, and then calls the handle() method. To implement a |
| 667 | specific service, all you need to do is to derive a class which |
| 668 | defines a handle() method. |
| 669 | |
| 670 | The handle() method can find the request as self.request, the |
Guido van Rossum | fdb3d1a | 1998-11-16 19:06:30 +0000 | [diff] [blame] | 671 | client address as self.client_address, and the server (in case it |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 672 | needs access to per-server information) as self.server. Since a |
| 673 | separate instance is created for each request, the handle() method |
| 674 | can define arbitrary other instance variariables. |
| 675 | |
| 676 | """ |
| 677 | |
| 678 | def __init__(self, request, client_address, server): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 679 | self.request = request |
| 680 | self.client_address = client_address |
| 681 | self.server = server |
Guido van Rossum | e7ba495 | 2007-06-06 23:52:48 +0000 | [diff] [blame] | 682 | self.setup() |
Kristján Valur Jónsson | 985fc6a | 2009-07-01 10:01:31 +0000 | [diff] [blame] | 683 | try: |
| 684 | self.handle() |
| 685 | finally: |
| 686 | self.finish() |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 687 | |
| 688 | def setup(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 689 | pass |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 690 | |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 691 | def handle(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 692 | pass |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 693 | |
| 694 | def finish(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 695 | pass |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 696 | |
| 697 | |
| 698 | # The following two classes make it possible to use the same service |
| 699 | # class for stream or datagram servers. |
| 700 | # Each class sets up these instance variables: |
| 701 | # - rfile: a file object from which receives the request is read |
| 702 | # - wfile: a file object to which the reply is written |
| 703 | # When the handle() method returns, wfile is flushed properly |
| 704 | |
| 705 | |
| 706 | class StreamRequestHandler(BaseRequestHandler): |
| 707 | |
| 708 | """Define self.rfile and self.wfile for stream sockets.""" |
| 709 | |
Guido van Rossum | 01fed4d | 2000-09-01 03:25:14 +0000 | [diff] [blame] | 710 | # Default buffer sizes for rfile, wfile. |
| 711 | # We default rfile to buffered because otherwise it could be |
| 712 | # really slow for large data (a getc() call per byte); we make |
| 713 | # wfile unbuffered because (a) often after a write() we want to |
| 714 | # read and we need to flush the line; (b) big writes to unbuffered |
| 715 | # files are typically optimized by stdio even when big reads |
| 716 | # aren't. |
| 717 | rbufsize = -1 |
| 718 | wbufsize = 0 |
| 719 | |
Kristján Valur Jónsson | 985fc6a | 2009-07-01 10:01:31 +0000 | [diff] [blame] | 720 | # A timeout to apply to the request socket, if not None. |
| 721 | timeout = None |
| 722 | |
Ezio Melotti | 4969f70 | 2011-03-15 05:59:46 +0200 | [diff] [blame] | 723 | # Disable nagle algorithm for this socket, if True. |
Kristján Valur Jónsson | 41a5750 | 2009-06-28 21:34:22 +0000 | [diff] [blame] | 724 | # Use only when wbufsize != 0, to avoid small packets. |
| 725 | disable_nagle_algorithm = False |
| 726 | |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 727 | def setup(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 728 | self.connection = self.request |
Kristján Valur Jónsson | 985fc6a | 2009-07-01 10:01:31 +0000 | [diff] [blame] | 729 | if self.timeout is not None: |
| 730 | self.connection.settimeout(self.timeout) |
Kristján Valur Jónsson | 41a5750 | 2009-06-28 21:34:22 +0000 | [diff] [blame] | 731 | if self.disable_nagle_algorithm: |
| 732 | self.connection.setsockopt(socket.IPPROTO_TCP, |
| 733 | socket.TCP_NODELAY, True) |
Guido van Rossum | 01fed4d | 2000-09-01 03:25:14 +0000 | [diff] [blame] | 734 | self.rfile = self.connection.makefile('rb', self.rbufsize) |
| 735 | self.wfile = self.connection.makefile('wb', self.wbufsize) |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 736 | |
| 737 | def finish(self): |
Anthony Baxter | 4cedc1e | 2003-01-02 03:07:48 +0000 | [diff] [blame] | 738 | if not self.wfile.closed: |
Kristján Valur Jónsson | 36852b7 | 2012-12-25 22:46:32 +0000 | [diff] [blame] | 739 | try: |
| 740 | self.wfile.flush() |
| 741 | except socket.error: |
| 742 | # An final socket error may have occurred here, such as |
| 743 | # the local error ECONNABORTED. |
| 744 | pass |
Guido van Rossum | 1d5102c | 1998-04-03 16:49:52 +0000 | [diff] [blame] | 745 | self.wfile.close() |
| 746 | self.rfile.close() |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 747 | |
| 748 | |
| 749 | class DatagramRequestHandler(BaseRequestHandler): |
| 750 | |
Guido van Rossum | 7de4d64 | 2001-07-10 11:50:09 +0000 | [diff] [blame] | 751 | # XXX Regrettably, I cannot get this working on Linux; |
| 752 | # s.recvfrom() doesn't return a meaningful client address. |
| 753 | |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 754 | """Define self.rfile and self.wfile for datagram sockets.""" |
| 755 | |
| 756 | def setup(self): |
Guido van Rossum | 15863ea | 2007-08-03 19:03:39 +0000 | [diff] [blame] | 757 | from io import BytesIO |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 758 | self.packet, self.socket = self.request |
Guido van Rossum | 15863ea | 2007-08-03 19:03:39 +0000 | [diff] [blame] | 759 | self.rfile = BytesIO(self.packet) |
| 760 | self.wfile = BytesIO() |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 761 | |
| 762 | def finish(self): |
Guido van Rossum | 3249082 | 1998-06-16 02:27:33 +0000 | [diff] [blame] | 763 | self.socket.sendto(self.wfile.getvalue(), self.client_address) |