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: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 8 | - AF_INET: IP (Internet Protocol) sockets (default) |
| 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 |
| 53 | using the ForkingServer and ThreadingServer mix-in classes. For |
| 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 |
| 59 | in UDPServer! |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 60 | |
| 61 | To implement a service, you must derive a class from |
| 62 | BaseRequestHandler and redefine its handle() method. You can then run |
| 63 | various versions of the service by combining one of the server classes |
| 64 | with your request handler class. |
| 65 | |
| 66 | The request handler class must be different for datagram or stream |
| 67 | services. This can be hidden by using the mix-in request handler |
| 68 | classes StreamRequestHandler or DatagramRequestHandler. |
| 69 | |
| 70 | Of course, you still have to use your head! |
| 71 | |
| 72 | For instance, it makes no sense to use a forking server if the service |
| 73 | contains state in memory that can be modified by requests (since the |
| 74 | modifications in the child process would never reach the initial state |
| 75 | kept in the parent process and passed to each child). In this case, |
| 76 | you can use a threading server, but you will probably have to use |
| 77 | locks to avoid two requests that come in nearly simultaneous to apply |
| 78 | conflicting changes to the server state. |
| 79 | |
| 80 | On the other hand, if you are building e.g. an HTTP server, where all |
| 81 | data is stored externally (e.g. in the file system), a synchronous |
| 82 | class will essentially render the service "deaf" while one request is |
| 83 | being handled -- which may be for a very long time if a client is slow |
| 84 | to reqd all the data it has requested. Here a threading or forking |
| 85 | server is appropriate. |
| 86 | |
| 87 | In some cases, it may be appropriate to process part of a request |
| 88 | synchronously, but to finish processing in a forked child depending on |
| 89 | the request data. This can be implemented by using a synchronous |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 90 | server and doing an explicit fork in the request handler class |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 91 | handle() method. |
| 92 | |
| 93 | Another approach to handling multiple simultaneous requests in an |
| 94 | environment that supports neither threads nor fork (or where these are |
| 95 | too expensive or inappropriate for the service) is to maintain an |
| 96 | explicit table of partially finished requests and to use select() to |
| 97 | decide which request to work on next (or whether to handle a new |
| 98 | incoming request). This is particularly important for stream services |
| 99 | 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] | 100 | threads or subprocesses cannot be used). |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 101 | |
| 102 | Future work: |
| 103 | - Standard classes for Sun RPC (which uses either UDP or TCP) |
| 104 | - Standard mix-in classes to implement various authentication |
| 105 | and encryption schemes |
| 106 | - Standard framework for select-based multiplexing |
| 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 | 10b0418 | 2001-01-19 16:45:46 +0000 | [diff] [blame] | 123 | __version__ = "0.3" |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 124 | |
| 125 | |
| 126 | import socket |
| 127 | import sys |
| 128 | import os |
| 129 | |
Skip Montanaro | e99d5ea | 2001-01-20 19:54:20 +0000 | [diff] [blame] | 130 | __all__ = ["TCPServer","UDPServer","ForkingUDPServer","ForkingTCPServer", |
| 131 | "ThreadingUDPServer","ThreadingTCPServer","BaseRequestHandler", |
| 132 | "StreamRequestHandler","DatagramRequestHandler"] |
| 133 | if hasattr(socket, "AF_UNIX"): |
| 134 | __all__.extend(["UnixStreamServer","UnixDatagramServer", |
| 135 | "ThreadingUnixStreamServer", |
| 136 | "ThreadingUnixDatagramServer"]) |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 137 | |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 138 | class BaseServer: |
| 139 | |
| 140 | """Base class for server classes. |
| 141 | |
| 142 | Methods for the caller: |
| 143 | |
| 144 | - __init__(server_address, RequestHandlerClass) |
| 145 | - serve_forever() |
| 146 | - handle_request() # if you do not use serve_forever() |
| 147 | - fileno() -> int # for select() |
| 148 | |
| 149 | Methods that may be overridden: |
| 150 | |
| 151 | - server_bind() |
| 152 | - server_activate() |
| 153 | - get_request() -> request, client_address |
| 154 | - verify_request(request, client_address) |
| 155 | - server_close() |
| 156 | - process_request(request, client_address) |
Ka-Ping Yee | 285a7e5 | 2001-04-11 04:02:05 +0000 | [diff] [blame] | 157 | - close_request(request) |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 158 | - handle_error() |
| 159 | |
| 160 | Methods for derived classes: |
| 161 | |
| 162 | - finish_request(request, client_address) |
| 163 | |
| 164 | Class variables that may be overridden by derived classes or |
| 165 | instances: |
| 166 | |
| 167 | - address_family |
| 168 | - socket_type |
| 169 | - reuse_address |
| 170 | |
| 171 | Instance variables: |
| 172 | |
| 173 | - RequestHandlerClass |
| 174 | - socket |
| 175 | |
| 176 | """ |
| 177 | |
| 178 | def __init__(self, server_address, RequestHandlerClass): |
| 179 | """Constructor. May be extended, do not override.""" |
| 180 | self.server_address = server_address |
| 181 | self.RequestHandlerClass = RequestHandlerClass |
| 182 | |
| 183 | def server_activate(self): |
| 184 | """Called by constructor to activate the server. |
| 185 | |
| 186 | May be overridden. |
| 187 | |
| 188 | """ |
| 189 | pass |
| 190 | |
| 191 | def serve_forever(self): |
| 192 | """Handle one request at a time until doomsday.""" |
| 193 | while 1: |
| 194 | self.handle_request() |
| 195 | |
| 196 | # The distinction between handling, getting, processing and |
| 197 | # finishing a request is fairly arbitrary. Remember: |
| 198 | # |
| 199 | # - handle_request() is the top-level call. It calls |
| 200 | # get_request(), verify_request() and process_request() |
| 201 | # - get_request() is different for stream or datagram sockets |
| 202 | # - process_request() is the place that may fork a new process |
| 203 | # or create a new thread to finish the request |
| 204 | # - finish_request() instantiates the request handler class; |
| 205 | # this constructor will handle the request all by itself |
| 206 | |
| 207 | def handle_request(self): |
| 208 | """Handle one request, possibly blocking.""" |
| 209 | try: |
| 210 | request, client_address = self.get_request() |
| 211 | except socket.error: |
| 212 | return |
| 213 | if self.verify_request(request, client_address): |
| 214 | try: |
| 215 | self.process_request(request, client_address) |
| 216 | except: |
| 217 | self.handle_error(request, client_address) |
Ka-Ping Yee | 285a7e5 | 2001-04-11 04:02:05 +0000 | [diff] [blame] | 218 | self.close_request(request) |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 219 | |
| 220 | def verify_request(self, request, client_address): |
| 221 | """Verify the request. May be overridden. |
| 222 | |
| 223 | Return true if we should proceed with this request. |
| 224 | |
| 225 | """ |
| 226 | return 1 |
| 227 | |
| 228 | def process_request(self, request, client_address): |
| 229 | """Call finish_request. |
| 230 | |
| 231 | Overridden by ForkingMixIn and ThreadingMixIn. |
| 232 | |
| 233 | """ |
| 234 | self.finish_request(request, client_address) |
| 235 | |
| 236 | def server_close(self): |
| 237 | """Called to clean-up the server. |
| 238 | |
| 239 | May be overridden. |
| 240 | |
| 241 | """ |
| 242 | pass |
| 243 | |
| 244 | def finish_request(self, request, client_address): |
| 245 | """Finish one request by instantiating RequestHandlerClass.""" |
| 246 | self.RequestHandlerClass(request, client_address, self) |
| 247 | |
Ka-Ping Yee | 285a7e5 | 2001-04-11 04:02:05 +0000 | [diff] [blame] | 248 | def close_request(self, request): |
| 249 | """Called to clean up an individual request.""" |
| 250 | pass |
| 251 | |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 252 | def handle_error(self, request, client_address): |
| 253 | """Handle an error gracefully. May be overridden. |
| 254 | |
| 255 | The default is to print a traceback and continue. |
| 256 | |
| 257 | """ |
| 258 | print '-'*40 |
| 259 | print 'Exception happened during processing of request from', |
| 260 | print client_address |
| 261 | import traceback |
| 262 | traceback.print_exc() # XXX But this goes to stderr! |
| 263 | print '-'*40 |
| 264 | |
| 265 | |
| 266 | class TCPServer(BaseServer): |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 267 | |
| 268 | """Base class for various socket-based server classes. |
| 269 | |
| 270 | Defaults to synchronous IP stream (i.e., TCP). |
| 271 | |
| 272 | Methods for the caller: |
| 273 | |
| 274 | - __init__(server_address, RequestHandlerClass) |
| 275 | - serve_forever() |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 276 | - handle_request() # if you don't use serve_forever() |
| 277 | - fileno() -> int # for select() |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 278 | |
| 279 | Methods that may be overridden: |
| 280 | |
| 281 | - server_bind() |
| 282 | - server_activate() |
| 283 | - get_request() -> request, client_address |
| 284 | - verify_request(request, client_address) |
| 285 | - process_request(request, client_address) |
Ka-Ping Yee | 285a7e5 | 2001-04-11 04:02:05 +0000 | [diff] [blame] | 286 | - close_request(request) |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 287 | - handle_error() |
| 288 | |
| 289 | Methods for derived classes: |
| 290 | |
| 291 | - finish_request(request, client_address) |
| 292 | |
| 293 | Class variables that may be overridden by derived classes or |
| 294 | instances: |
| 295 | |
| 296 | - address_family |
| 297 | - socket_type |
| 298 | - request_queue_size (only for stream sockets) |
Guido van Rossum | e3c7a5f | 2000-05-09 14:53:29 +0000 | [diff] [blame] | 299 | - reuse_address |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 300 | |
| 301 | Instance variables: |
| 302 | |
| 303 | - server_address |
| 304 | - RequestHandlerClass |
| 305 | - socket |
| 306 | |
| 307 | """ |
| 308 | |
| 309 | address_family = socket.AF_INET |
| 310 | |
| 311 | socket_type = socket.SOCK_STREAM |
| 312 | |
| 313 | request_queue_size = 5 |
| 314 | |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 315 | allow_reuse_address = 0 |
Guido van Rossum | e3c7a5f | 2000-05-09 14:53:29 +0000 | [diff] [blame] | 316 | |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 317 | def __init__(self, server_address, RequestHandlerClass): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 318 | """Constructor. May be extended, do not override.""" |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 319 | BaseServer.__init__(self, server_address, RequestHandlerClass) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 320 | self.socket = socket.socket(self.address_family, |
| 321 | self.socket_type) |
| 322 | self.server_bind() |
| 323 | self.server_activate() |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 324 | |
| 325 | def server_bind(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 326 | """Called by constructor to bind the socket. |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 327 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 328 | May be overridden. |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 329 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 330 | """ |
Guido van Rossum | e3c7a5f | 2000-05-09 14:53:29 +0000 | [diff] [blame] | 331 | if self.allow_reuse_address: |
| 332 | self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 333 | self.socket.bind(self.server_address) |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 334 | |
| 335 | def server_activate(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 336 | """Called by constructor to activate the server. |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 337 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 338 | May be overridden. |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 339 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 340 | """ |
| 341 | self.socket.listen(self.request_queue_size) |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 342 | |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 343 | def server_close(self): |
| 344 | """Called to clean-up the server. |
| 345 | |
| 346 | May be overridden. |
| 347 | |
| 348 | """ |
| 349 | self.socket.close() |
| 350 | |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 351 | def fileno(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 352 | """Return socket file number. |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 353 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 354 | Interface required by select(). |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 355 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 356 | """ |
| 357 | return self.socket.fileno() |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 358 | |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 359 | def get_request(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 360 | """Get the request and client address from the socket. |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 361 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 362 | May be overridden. |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 363 | |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 364 | """ |
| 365 | return self.socket.accept() |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 366 | |
Ka-Ping Yee | 285a7e5 | 2001-04-11 04:02:05 +0000 | [diff] [blame] | 367 | def close_request(self, request): |
| 368 | """Called to clean up an individual request.""" |
| 369 | request.close() |
| 370 | |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 371 | |
| 372 | class UDPServer(TCPServer): |
| 373 | |
| 374 | """UDP server class.""" |
| 375 | |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 376 | allow_reuse_address = 0 |
| 377 | |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 378 | socket_type = socket.SOCK_DGRAM |
| 379 | |
| 380 | max_packet_size = 8192 |
| 381 | |
| 382 | def get_request(self): |
Guido van Rossum | 3249082 | 1998-06-16 02:27:33 +0000 | [diff] [blame] | 383 | data, client_addr = self.socket.recvfrom(self.max_packet_size) |
| 384 | return (data, self.socket), client_addr |
| 385 | |
| 386 | def server_activate(self): |
| 387 | # No need to call listen() for UDP. |
| 388 | pass |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 389 | |
Ka-Ping Yee | 285a7e5 | 2001-04-11 04:02:05 +0000 | [diff] [blame] | 390 | def close_request(self, request): |
| 391 | # No need to close anything. |
| 392 | pass |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 393 | |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 394 | class ForkingMixIn: |
| 395 | |
| 396 | """Mix-in class to handle each request in a new process.""" |
| 397 | |
| 398 | active_children = None |
Guido van Rossum | 2ab455a | 1999-07-28 21:39:28 +0000 | [diff] [blame] | 399 | max_children = 40 |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 400 | |
| 401 | def collect_children(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 402 | """Internal routine to wait for died children.""" |
| 403 | while self.active_children: |
Guido van Rossum | 2ab455a | 1999-07-28 21:39:28 +0000 | [diff] [blame] | 404 | if len(self.active_children) < self.max_children: |
| 405 | options = os.WNOHANG |
| 406 | else: |
| 407 | # If the maximum number of children are already |
| 408 | # running, block while waiting for a child to exit |
| 409 | options = 0 |
Guido van Rossum | bfadac0 | 1999-06-17 15:41:33 +0000 | [diff] [blame] | 410 | try: |
Guido van Rossum | 2ab455a | 1999-07-28 21:39:28 +0000 | [diff] [blame] | 411 | pid, status = os.waitpid(0, options) |
Guido van Rossum | bfadac0 | 1999-06-17 15:41:33 +0000 | [diff] [blame] | 412 | except os.error: |
| 413 | pid = None |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 414 | if not pid: break |
| 415 | self.active_children.remove(pid) |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 416 | |
| 417 | def process_request(self, request, client_address): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 418 | """Fork a new subprocess to process the request.""" |
| 419 | self.collect_children() |
| 420 | pid = os.fork() |
| 421 | if pid: |
| 422 | # Parent process |
| 423 | if self.active_children is None: |
| 424 | self.active_children = [] |
| 425 | self.active_children.append(pid) |
| 426 | return |
| 427 | else: |
| 428 | # Child process. |
| 429 | # This must never return, hence os._exit()! |
| 430 | try: |
Guido van Rossum | 90cb906 | 2001-01-19 00:44:41 +0000 | [diff] [blame] | 431 | self.server_close() |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 432 | self.finish_request(request, client_address) |
| 433 | os._exit(0) |
| 434 | except: |
| 435 | try: |
| 436 | self.handle_error(request, |
| 437 | client_address) |
| 438 | finally: |
| 439 | os._exit(1) |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 440 | |
| 441 | |
| 442 | class ThreadingMixIn: |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 443 | """Mix-in class to handle each request in a new thread.""" |
| 444 | |
| 445 | def process_request(self, request, client_address): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 446 | """Start a new thread to process the request.""" |
Jeremy Hylton | 7526027 | 1999-10-12 16:20:13 +0000 | [diff] [blame] | 447 | import threading |
| 448 | t = threading.Thread(target = self.finish_request, |
| 449 | args = (request, client_address)) |
| 450 | t.start() |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 451 | |
| 452 | |
| 453 | class ForkingUDPServer(ForkingMixIn, UDPServer): pass |
| 454 | class ForkingTCPServer(ForkingMixIn, TCPServer): pass |
| 455 | |
| 456 | class ThreadingUDPServer(ThreadingMixIn, UDPServer): pass |
| 457 | class ThreadingTCPServer(ThreadingMixIn, TCPServer): pass |
| 458 | |
Guido van Rossum | 67a40e8 | 1998-11-30 15:07:01 +0000 | [diff] [blame] | 459 | if hasattr(socket, 'AF_UNIX'): |
| 460 | |
| 461 | class UnixStreamServer(TCPServer): |
| 462 | address_family = socket.AF_UNIX |
| 463 | |
| 464 | class UnixDatagramServer(UDPServer): |
| 465 | address_family = socket.AF_UNIX |
| 466 | |
| 467 | class ThreadingUnixStreamServer(ThreadingMixIn, UnixStreamServer): pass |
| 468 | |
| 469 | class ThreadingUnixDatagramServer(ThreadingMixIn, UnixDatagramServer): pass |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 470 | |
| 471 | class BaseRequestHandler: |
| 472 | |
| 473 | """Base class for request handler classes. |
| 474 | |
| 475 | This class is instantiated for each request to be handled. The |
| 476 | constructor sets the instance variables request, client_address |
| 477 | and server, and then calls the handle() method. To implement a |
| 478 | specific service, all you need to do is to derive a class which |
| 479 | defines a handle() method. |
| 480 | |
| 481 | The handle() method can find the request as self.request, the |
Guido van Rossum | fdb3d1a | 1998-11-16 19:06:30 +0000 | [diff] [blame] | 482 | 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] | 483 | needs access to per-server information) as self.server. Since a |
| 484 | separate instance is created for each request, the handle() method |
| 485 | can define arbitrary other instance variariables. |
| 486 | |
| 487 | """ |
| 488 | |
| 489 | def __init__(self, request, client_address, server): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 490 | self.request = request |
| 491 | self.client_address = client_address |
| 492 | self.server = server |
| 493 | try: |
| 494 | self.setup() |
| 495 | self.handle() |
| 496 | self.finish() |
| 497 | finally: |
| 498 | sys.exc_traceback = None # Help garbage collection |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 499 | |
| 500 | def setup(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 501 | pass |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 502 | |
| 503 | def __del__(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 504 | pass |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 505 | |
| 506 | def handle(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 507 | pass |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 508 | |
| 509 | def finish(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 510 | pass |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 511 | |
| 512 | |
| 513 | # The following two classes make it possible to use the same service |
| 514 | # class for stream or datagram servers. |
| 515 | # Each class sets up these instance variables: |
| 516 | # - rfile: a file object from which receives the request is read |
| 517 | # - wfile: a file object to which the reply is written |
| 518 | # When the handle() method returns, wfile is flushed properly |
| 519 | |
| 520 | |
| 521 | class StreamRequestHandler(BaseRequestHandler): |
| 522 | |
| 523 | """Define self.rfile and self.wfile for stream sockets.""" |
| 524 | |
Guido van Rossum | 01fed4d | 2000-09-01 03:25:14 +0000 | [diff] [blame] | 525 | # Default buffer sizes for rfile, wfile. |
| 526 | # We default rfile to buffered because otherwise it could be |
| 527 | # really slow for large data (a getc() call per byte); we make |
| 528 | # wfile unbuffered because (a) often after a write() we want to |
| 529 | # read and we need to flush the line; (b) big writes to unbuffered |
| 530 | # files are typically optimized by stdio even when big reads |
| 531 | # aren't. |
| 532 | rbufsize = -1 |
| 533 | wbufsize = 0 |
| 534 | |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 535 | def setup(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 536 | self.connection = self.request |
Guido van Rossum | 01fed4d | 2000-09-01 03:25:14 +0000 | [diff] [blame] | 537 | self.rfile = self.connection.makefile('rb', self.rbufsize) |
| 538 | self.wfile = self.connection.makefile('wb', self.wbufsize) |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 539 | |
| 540 | def finish(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 541 | self.wfile.flush() |
Guido van Rossum | 1d5102c | 1998-04-03 16:49:52 +0000 | [diff] [blame] | 542 | self.wfile.close() |
| 543 | self.rfile.close() |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 544 | |
| 545 | |
| 546 | class DatagramRequestHandler(BaseRequestHandler): |
| 547 | |
| 548 | """Define self.rfile and self.wfile for datagram sockets.""" |
| 549 | |
| 550 | def setup(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 551 | import StringIO |
| 552 | self.packet, self.socket = self.request |
| 553 | self.rfile = StringIO.StringIO(self.packet) |
| 554 | self.wfile = StringIO.StringIO(self.packet) |
Guido van Rossum | e7e578f | 1995-08-04 04:00:20 +0000 | [diff] [blame] | 555 | |
| 556 | def finish(self): |
Guido van Rossum | 3249082 | 1998-06-16 02:27:33 +0000 | [diff] [blame] | 557 | self.socket.sendto(self.wfile.getvalue(), self.client_address) |