Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 1 | # -*- Mode: Python -*- |
Tim Peters | 146965a | 2001-01-14 18:09:23 +0000 | [diff] [blame] | 2 | # Id: asyncore.py,v 2.51 2000/09/07 22:29:26 rushing Exp |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 3 | # Author: Sam Rushing <rushing@nightmare.com> |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 4 | |
| 5 | # ====================================================================== |
| 6 | # Copyright 1996 by Sam Rushing |
Tim Peters | 146965a | 2001-01-14 18:09:23 +0000 | [diff] [blame] | 7 | # |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 8 | # All Rights Reserved |
Tim Peters | 146965a | 2001-01-14 18:09:23 +0000 | [diff] [blame] | 9 | # |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 10 | # Permission to use, copy, modify, and distribute this software and |
| 11 | # its documentation for any purpose and without fee is hereby |
| 12 | # granted, provided that the above copyright notice appear in all |
| 13 | # copies and that both that copyright notice and this permission |
| 14 | # notice appear in supporting documentation, and that the name of Sam |
| 15 | # Rushing not be used in advertising or publicity pertaining to |
| 16 | # distribution of the software without specific, written prior |
| 17 | # permission. |
Tim Peters | 146965a | 2001-01-14 18:09:23 +0000 | [diff] [blame] | 18 | # |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 19 | # SAM RUSHING DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, |
| 20 | # INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN |
| 21 | # NO EVENT SHALL SAM RUSHING BE LIABLE FOR ANY SPECIAL, INDIRECT OR |
| 22 | # CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS |
| 23 | # OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, |
| 24 | # NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN |
| 25 | # CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
| 26 | # ====================================================================== |
| 27 | |
Guido van Rossum | 4b8c6ea | 2000-02-04 15:39:30 +0000 | [diff] [blame] | 28 | """Basic infrastructure for asynchronous socket service clients and servers. |
| 29 | |
| 30 | There are only two ways to have a program on a single processor do "more |
Tim Peters | 146965a | 2001-01-14 18:09:23 +0000 | [diff] [blame] | 31 | than one thing at a time". Multi-threaded programming is the simplest and |
Guido van Rossum | 4b8c6ea | 2000-02-04 15:39:30 +0000 | [diff] [blame] | 32 | most popular way to do it, but there is another very different technique, |
| 33 | that lets you have nearly all the advantages of multi-threading, without |
| 34 | actually using multiple threads. it's really only practical if your program |
| 35 | is largely I/O bound. If your program is CPU bound, then pre-emptive |
| 36 | scheduled threads are probably what you really need. Network servers are |
Tim Peters | 146965a | 2001-01-14 18:09:23 +0000 | [diff] [blame] | 37 | rarely CPU-bound, however. |
Guido van Rossum | 4b8c6ea | 2000-02-04 15:39:30 +0000 | [diff] [blame] | 38 | |
Tim Peters | 146965a | 2001-01-14 18:09:23 +0000 | [diff] [blame] | 39 | If your operating system supports the select() system call in its I/O |
Guido van Rossum | 4b8c6ea | 2000-02-04 15:39:30 +0000 | [diff] [blame] | 40 | library (and nearly all do), then you can use it to juggle multiple |
| 41 | communication channels at once; doing other work while your I/O is taking |
| 42 | place in the "background." Although this strategy can seem strange and |
| 43 | complex, especially at first, it is in many ways easier to understand and |
| 44 | control than multi-threaded programming. The module documented here solves |
| 45 | many of the difficult problems for you, making the task of building |
Tim Peters | 146965a | 2001-01-14 18:09:23 +0000 | [diff] [blame] | 46 | sophisticated high-performance network servers and clients a snap. |
Guido van Rossum | 4b8c6ea | 2000-02-04 15:39:30 +0000 | [diff] [blame] | 47 | """ |
| 48 | |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 49 | import select |
| 50 | import socket |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 51 | import sys |
Thomas Heller | d8ce87a | 2002-09-24 17:30:31 +0000 | [diff] [blame] | 52 | import time |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 53 | import os |
Jeremy Hylton | a8b5f7d | 2001-08-10 14:30:35 +0000 | [diff] [blame] | 54 | from errno import EALREADY, EINPROGRESS, EWOULDBLOCK, ECONNRESET, \ |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 55 | ENOTCONN, ESHUTDOWN, EINTR, EISCONN, EBADF, ECONNABORTED, errorcode |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 56 | |
Andrew M. Kuchling | da85a27 | 2000-09-08 20:30:39 +0000 | [diff] [blame] | 57 | try: |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 58 | socket_map |
Andrew M. Kuchling | da85a27 | 2000-09-08 20:30:39 +0000 | [diff] [blame] | 59 | except NameError: |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 60 | socket_map = {} |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 61 | |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 62 | def _strerror(err): |
| 63 | res = os.strerror(err) |
| 64 | if res == 'Unknown error': |
| 65 | res = errorcode[err] |
| 66 | return res |
| 67 | |
Neal Norwitz | 4ce69a5 | 2005-09-01 00:45:28 +0000 | [diff] [blame] | 68 | class ExitNow(Exception): |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 69 | pass |
Andrew M. Kuchling | da85a27 | 2000-09-08 20:30:39 +0000 | [diff] [blame] | 70 | |
R. David Murray | 78532ba | 2009-04-12 15:35:44 +0000 | [diff] [blame] | 71 | _reraised_exceptions = (ExitNow, KeyboardInterrupt, SystemExit) |
| 72 | |
Jeremy Hylton | d750036 | 2002-09-08 00:14:54 +0000 | [diff] [blame] | 73 | def read(obj): |
| 74 | try: |
| 75 | obj.handle_read_event() |
R. David Murray | 78532ba | 2009-04-12 15:35:44 +0000 | [diff] [blame] | 76 | except _reraised_exceptions: |
Jeremy Hylton | d750036 | 2002-09-08 00:14:54 +0000 | [diff] [blame] | 77 | raise |
| 78 | except: |
| 79 | obj.handle_error() |
| 80 | |
| 81 | def write(obj): |
| 82 | try: |
| 83 | obj.handle_write_event() |
R. David Murray | 78532ba | 2009-04-12 15:35:44 +0000 | [diff] [blame] | 84 | except _reraised_exceptions: |
Jeremy Hylton | d750036 | 2002-09-08 00:14:54 +0000 | [diff] [blame] | 85 | raise |
| 86 | except: |
| 87 | obj.handle_error() |
| 88 | |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 89 | def _exception(obj): |
Andrew M. Kuchling | 0fff6c8 | 2004-07-10 17:36:11 +0000 | [diff] [blame] | 90 | try: |
| 91 | obj.handle_expt_event() |
R. David Murray | 78532ba | 2009-04-12 15:35:44 +0000 | [diff] [blame] | 92 | except _reraised_exceptions: |
Andrew M. Kuchling | 0fff6c8 | 2004-07-10 17:36:11 +0000 | [diff] [blame] | 93 | raise |
| 94 | except: |
| 95 | obj.handle_error() |
| 96 | |
Jeremy Hylton | d750036 | 2002-09-08 00:14:54 +0000 | [diff] [blame] | 97 | def readwrite(obj, flags): |
| 98 | try: |
R. David Murray | 78532ba | 2009-04-12 15:35:44 +0000 | [diff] [blame] | 99 | if flags & select.POLLIN: |
Jeremy Hylton | d750036 | 2002-09-08 00:14:54 +0000 | [diff] [blame] | 100 | obj.handle_read_event() |
| 101 | if flags & select.POLLOUT: |
| 102 | obj.handle_write_event() |
R. David Murray | 78532ba | 2009-04-12 15:35:44 +0000 | [diff] [blame] | 103 | if flags & select.POLLPRI: |
| 104 | obj.handle_expt_event() |
Josiah Carlson | 0abc64d | 2009-06-03 19:48:02 +0000 | [diff] [blame] | 105 | if flags & (select.POLLHUP | select.POLLERR | select.POLLNVAL): |
| 106 | obj.handle_close() |
| 107 | except socket.error as e: |
| 108 | if e.args[0] not in (EBADF, ECONNRESET, ENOTCONN, ESHUTDOWN, ECONNABORTED): |
| 109 | obj.handle_error() |
| 110 | else: |
| 111 | obj.handle_close() |
R. David Murray | 78532ba | 2009-04-12 15:35:44 +0000 | [diff] [blame] | 112 | except _reraised_exceptions: |
Jeremy Hylton | d750036 | 2002-09-08 00:14:54 +0000 | [diff] [blame] | 113 | raise |
| 114 | except: |
| 115 | obj.handle_error() |
Andrew M. Kuchling | da85a27 | 2000-09-08 20:30:39 +0000 | [diff] [blame] | 116 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 117 | def poll(timeout=0.0, map=None): |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 118 | if map is None: |
| 119 | map = socket_map |
| 120 | if map: |
| 121 | r = []; w = []; e = [] |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 122 | for fd, obj in list(map.items()): |
Andrew M. Kuchling | e47c381 | 2004-09-01 14:04:51 +0000 | [diff] [blame] | 123 | is_r = obj.readable() |
| 124 | is_w = obj.writable() |
| 125 | if is_r: |
Jeremy Hylton | d750036 | 2002-09-08 00:14:54 +0000 | [diff] [blame] | 126 | r.append(fd) |
Andrew M. Kuchling | e47c381 | 2004-09-01 14:04:51 +0000 | [diff] [blame] | 127 | if is_w: |
Jeremy Hylton | d750036 | 2002-09-08 00:14:54 +0000 | [diff] [blame] | 128 | w.append(fd) |
Andrew M. Kuchling | e47c381 | 2004-09-01 14:04:51 +0000 | [diff] [blame] | 129 | if is_r or is_w: |
| 130 | e.append(fd) |
Thomas Heller | d8ce87a | 2002-09-24 17:30:31 +0000 | [diff] [blame] | 131 | if [] == r == w == e: |
| 132 | time.sleep(timeout) |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 133 | return |
| 134 | |
| 135 | try: |
| 136 | r, w, e = select.select(r, w, e, timeout) |
| 137 | except select.error as err: |
Georg Brandl | f112369 | 2008-07-20 07:31:30 +0000 | [diff] [blame] | 138 | if err.args[0] != EINTR: |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 139 | raise |
| 140 | else: |
| 141 | return |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 142 | |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 143 | for fd in r: |
Jeremy Hylton | d750036 | 2002-09-08 00:14:54 +0000 | [diff] [blame] | 144 | obj = map.get(fd) |
| 145 | if obj is None: |
Martin v. Löwis | 6ec9a36 | 2001-10-09 10:10:33 +0000 | [diff] [blame] | 146 | continue |
Jeremy Hylton | d750036 | 2002-09-08 00:14:54 +0000 | [diff] [blame] | 147 | read(obj) |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 148 | |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 149 | for fd in w: |
Jeremy Hylton | d750036 | 2002-09-08 00:14:54 +0000 | [diff] [blame] | 150 | obj = map.get(fd) |
| 151 | if obj is None: |
Martin v. Löwis | 6ec9a36 | 2001-10-09 10:10:33 +0000 | [diff] [blame] | 152 | continue |
Jeremy Hylton | d750036 | 2002-09-08 00:14:54 +0000 | [diff] [blame] | 153 | write(obj) |
Andrew M. Kuchling | da85a27 | 2000-09-08 20:30:39 +0000 | [diff] [blame] | 154 | |
Andrew M. Kuchling | 0fff6c8 | 2004-07-10 17:36:11 +0000 | [diff] [blame] | 155 | for fd in e: |
| 156 | obj = map.get(fd) |
| 157 | if obj is None: |
| 158 | continue |
| 159 | _exception(obj) |
| 160 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 161 | def poll2(timeout=0.0, map=None): |
Andrew M. Kuchling | af6963c | 2001-01-24 15:50:19 +0000 | [diff] [blame] | 162 | # Use the poll() support added to the select module in Python 2.0 |
| 163 | if map is None: |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 164 | map = socket_map |
Martin v. Löwis | f6cc07c | 2001-09-19 17:31:47 +0000 | [diff] [blame] | 165 | if timeout is not None: |
| 166 | # timeout is in milliseconds |
| 167 | timeout = int(timeout*1000) |
Andrew M. Kuchling | af6963c | 2001-01-24 15:50:19 +0000 | [diff] [blame] | 168 | pollster = select.poll() |
| 169 | if map: |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 170 | for fd, obj in list(map.items()): |
Andrew M. Kuchling | e47c381 | 2004-09-01 14:04:51 +0000 | [diff] [blame] | 171 | flags = 0 |
Andrew M. Kuchling | af6963c | 2001-01-24 15:50:19 +0000 | [diff] [blame] | 172 | if obj.readable(): |
Andrew M. Kuchling | 6fe93cd | 2004-07-07 12:23:53 +0000 | [diff] [blame] | 173 | flags |= select.POLLIN | select.POLLPRI |
Andrew M. Kuchling | af6963c | 2001-01-24 15:50:19 +0000 | [diff] [blame] | 174 | if obj.writable(): |
Andrew M. Kuchling | 6fe93cd | 2004-07-07 12:23:53 +0000 | [diff] [blame] | 175 | flags |= select.POLLOUT |
Andrew M. Kuchling | af6963c | 2001-01-24 15:50:19 +0000 | [diff] [blame] | 176 | if flags: |
Andrew M. Kuchling | e47c381 | 2004-09-01 14:04:51 +0000 | [diff] [blame] | 177 | # Only check for exceptions if object was either readable |
| 178 | # or writable. |
| 179 | flags |= select.POLLERR | select.POLLHUP | select.POLLNVAL |
Andrew M. Kuchling | af6963c | 2001-01-24 15:50:19 +0000 | [diff] [blame] | 180 | pollster.register(fd, flags) |
Jeremy Hylton | fbd5797 | 2001-10-29 16:32:19 +0000 | [diff] [blame] | 181 | try: |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 182 | r = pollster.poll(timeout) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 183 | except select.error as err: |
Georg Brandl | f112369 | 2008-07-20 07:31:30 +0000 | [diff] [blame] | 184 | if err.args[0] != EINTR: |
Jeremy Hylton | fbd5797 | 2001-10-29 16:32:19 +0000 | [diff] [blame] | 185 | raise |
| 186 | r = [] |
Andrew M. Kuchling | af6963c | 2001-01-24 15:50:19 +0000 | [diff] [blame] | 187 | for fd, flags in r: |
Jeremy Hylton | d750036 | 2002-09-08 00:14:54 +0000 | [diff] [blame] | 188 | obj = map.get(fd) |
| 189 | if obj is None: |
Martin v. Löwis | 6ec9a36 | 2001-10-09 10:10:33 +0000 | [diff] [blame] | 190 | continue |
Jeremy Hylton | d750036 | 2002-09-08 00:14:54 +0000 | [diff] [blame] | 191 | readwrite(obj, flags) |
Andrew M. Kuchling | af6963c | 2001-01-24 15:50:19 +0000 | [diff] [blame] | 192 | |
Andrew M. Kuchling | 6c2871e | 2003-10-22 14:38:27 +0000 | [diff] [blame] | 193 | poll3 = poll2 # Alias for backward compatibility |
| 194 | |
Michael W. Hudson | d5cf143 | 2004-06-30 09:02:33 +0000 | [diff] [blame] | 195 | def loop(timeout=30.0, use_poll=False, map=None, count=None): |
Andrew M. Kuchling | af6963c | 2001-01-24 15:50:19 +0000 | [diff] [blame] | 196 | if map is None: |
Jeremy Hylton | d750036 | 2002-09-08 00:14:54 +0000 | [diff] [blame] | 197 | map = socket_map |
Andrew M. Kuchling | af6963c | 2001-01-24 15:50:19 +0000 | [diff] [blame] | 198 | |
Andrew M. Kuchling | 6c2871e | 2003-10-22 14:38:27 +0000 | [diff] [blame] | 199 | if use_poll and hasattr(select, 'poll'): |
| 200 | poll_fun = poll2 |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 201 | else: |
| 202 | poll_fun = poll |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 203 | |
Michael W. Hudson | d5cf143 | 2004-06-30 09:02:33 +0000 | [diff] [blame] | 204 | if count is None: |
| 205 | while map: |
| 206 | poll_fun(timeout, map) |
| 207 | |
| 208 | else: |
| 209 | while map and count > 0: |
| 210 | poll_fun(timeout, map) |
| 211 | count = count - 1 |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 212 | |
| 213 | class dispatcher: |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 214 | |
Andrew M. Kuchling | 68522b1 | 2004-03-21 19:46:16 +0000 | [diff] [blame] | 215 | debug = False |
| 216 | connected = False |
| 217 | accepting = False |
| 218 | closing = False |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 219 | addr = None |
R. David Murray | 78532ba | 2009-04-12 15:35:44 +0000 | [diff] [blame] | 220 | ignore_log_types = frozenset(['warning']) |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 221 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 222 | def __init__(self, sock=None, map=None): |
Andrew M. Kuchling | f9ca409 | 2003-10-22 13:48:27 +0000 | [diff] [blame] | 223 | if map is None: |
| 224 | self._map = socket_map |
| 225 | else: |
| 226 | self._map = map |
| 227 | |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 228 | self._fileno = None |
| 229 | |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 230 | if sock: |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 231 | # Set to nonblocking just to make sure for cases where we |
| 232 | # get a socket from a blocking source. |
| 233 | sock.setblocking(0) |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 234 | self.set_socket(sock, map) |
Andrew M. Kuchling | 68522b1 | 2004-03-21 19:46:16 +0000 | [diff] [blame] | 235 | self.connected = True |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 236 | # The constructor no longer requires that the socket |
| 237 | # passed be connected. |
Jeremy Hylton | 2a05bc7 | 2001-12-14 16:15:11 +0000 | [diff] [blame] | 238 | try: |
| 239 | self.addr = sock.getpeername() |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 240 | except socket.error as err: |
Georg Brandl | f112369 | 2008-07-20 07:31:30 +0000 | [diff] [blame] | 241 | if err.args[0] == ENOTCONN: |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 242 | # To handle the case where we got an unconnected |
| 243 | # socket. |
| 244 | self.connected = False |
| 245 | else: |
| 246 | # The socket is broken in some unknown way, alert |
| 247 | # the user and remove it from the map (to prevent |
| 248 | # polling of broken sockets). |
| 249 | self.del_channel(map) |
| 250 | raise |
Jeremy Hylton | fbd5797 | 2001-10-29 16:32:19 +0000 | [diff] [blame] | 251 | else: |
| 252 | self.socket = None |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 253 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 254 | def __repr__(self): |
Martin v. Löwis | 29103c7 | 2001-10-18 17:33:19 +0000 | [diff] [blame] | 255 | status = [self.__class__.__module__+"."+self.__class__.__name__] |
| 256 | if self.accepting and self.addr: |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 257 | status.append('listening') |
Martin v. Löwis | 29103c7 | 2001-10-18 17:33:19 +0000 | [diff] [blame] | 258 | elif self.connected: |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 259 | status.append('connected') |
Martin v. Löwis | 29103c7 | 2001-10-18 17:33:19 +0000 | [diff] [blame] | 260 | if self.addr is not None: |
| 261 | try: |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 262 | status.append('%s:%d' % self.addr) |
Martin v. Löwis | 29103c7 | 2001-10-18 17:33:19 +0000 | [diff] [blame] | 263 | except TypeError: |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 264 | status.append(repr(self.addr)) |
| 265 | return '<%s at %#x>' % (' '.join(status), id(self)) |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 266 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 267 | def add_channel(self, map=None): |
| 268 | #self.log_info('adding channel %s' % self) |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 269 | if map is None: |
Andrew M. Kuchling | f9ca409 | 2003-10-22 13:48:27 +0000 | [diff] [blame] | 270 | map = self._map |
Guido van Rossum | 12e9668 | 2002-09-13 14:09:26 +0000 | [diff] [blame] | 271 | map[self._fileno] = self |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 272 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 273 | def del_channel(self, map=None): |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 274 | fd = self._fileno |
| 275 | if map is None: |
Andrew M. Kuchling | f9ca409 | 2003-10-22 13:48:27 +0000 | [diff] [blame] | 276 | map = self._map |
Guido van Rossum | e2b70bc | 2006-08-18 22:13:04 +0000 | [diff] [blame] | 277 | if fd in map: |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 278 | #self.log_info('closing channel %d:%s' % (fd, self)) |
Guido van Rossum | 12e9668 | 2002-09-13 14:09:26 +0000 | [diff] [blame] | 279 | del map[fd] |
Raymond Hettinger | 3dc3484 | 2004-02-08 11:32:50 +0000 | [diff] [blame] | 280 | self._fileno = None |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 281 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 282 | def create_socket(self, family, type): |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 283 | self.family_and_type = family, type |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 284 | sock = socket.socket(family, type) |
| 285 | sock.setblocking(0) |
| 286 | self.set_socket(sock) |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 287 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 288 | def set_socket(self, sock, map=None): |
Jeremy Hylton | fbd5797 | 2001-10-29 16:32:19 +0000 | [diff] [blame] | 289 | self.socket = sock |
| 290 | ## self.__dict__['socket'] = sock |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 291 | self._fileno = sock.fileno() |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 292 | self.add_channel(map) |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 293 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 294 | def set_reuse_addr(self): |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 295 | # try to re-use a server port if possible |
| 296 | try: |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 297 | self.socket.setsockopt( |
Andrew M. Kuchling | 9d499f2 | 2004-08-13 20:06:57 +0000 | [diff] [blame] | 298 | socket.SOL_SOCKET, socket.SO_REUSEADDR, |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 299 | self.socket.getsockopt(socket.SOL_SOCKET, |
Andrew M. Kuchling | 9d499f2 | 2004-08-13 20:06:57 +0000 | [diff] [blame] | 300 | socket.SO_REUSEADDR) | 1 |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 301 | ) |
Fred Drake | 9f9b593 | 2001-05-11 18:28:54 +0000 | [diff] [blame] | 302 | except socket.error: |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 303 | pass |
Tim Peters | 182b5ac | 2004-07-18 06:16:08 +0000 | [diff] [blame] | 304 | |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 305 | # ================================================== |
| 306 | # predicates for select() |
| 307 | # these are used as filters for the lists of sockets |
| 308 | # to pass to select(). |
| 309 | # ================================================== |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 310 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 311 | def readable(self): |
Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 312 | return True |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 313 | |
Andrew M. Kuchling | 419af88 | 2004-03-21 19:52:01 +0000 | [diff] [blame] | 314 | def writable(self): |
| 315 | return True |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 316 | |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 317 | # ================================================== |
| 318 | # socket object methods. |
| 319 | # ================================================== |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 320 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 321 | def listen(self, num): |
Andrew M. Kuchling | 68522b1 | 2004-03-21 19:46:16 +0000 | [diff] [blame] | 322 | self.accepting = True |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 323 | if os.name == 'nt' and num > 5: |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 324 | num = 5 |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 325 | return self.socket.listen(num) |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 326 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 327 | def bind(self, addr): |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 328 | self.addr = addr |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 329 | return self.socket.bind(addr) |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 330 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 331 | def connect(self, address): |
Andrew M. Kuchling | 68522b1 | 2004-03-21 19:46:16 +0000 | [diff] [blame] | 332 | self.connected = False |
Jeremy Hylton | e16e54f | 2001-10-29 16:44:37 +0000 | [diff] [blame] | 333 | err = self.socket.connect_ex(address) |
Guido van Rossum | 9a40c1c | 2002-12-26 18:22:54 +0000 | [diff] [blame] | 334 | # XXX Should interpret Winsock return values |
Jeremy Hylton | e16e54f | 2001-10-29 16:44:37 +0000 | [diff] [blame] | 335 | if err in (EINPROGRESS, EALREADY, EWOULDBLOCK): |
| 336 | return |
| 337 | if err in (0, EISCONN): |
| 338 | self.addr = address |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 339 | self.handle_connect_event() |
Jeremy Hylton | f24339f | 2001-10-30 14:16:17 +0000 | [diff] [blame] | 340 | else: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 341 | raise socket.error(err, errorcode[err]) |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 342 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 343 | def accept(self): |
Jeremy Hylton | f32e459 | 2002-04-04 21:02:24 +0000 | [diff] [blame] | 344 | # XXX can return either an address pair or None |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 345 | try: |
| 346 | conn, addr = self.socket.accept() |
| 347 | return conn, addr |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 348 | except socket.error as why: |
Georg Brandl | f112369 | 2008-07-20 07:31:30 +0000 | [diff] [blame] | 349 | if why.args[0] == EWOULDBLOCK: |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 350 | pass |
| 351 | else: |
Tim Peters | 4e0e1b6 | 2004-07-07 20:54:48 +0000 | [diff] [blame] | 352 | raise |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 353 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 354 | def send(self, data): |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 355 | try: |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 356 | result = self.socket.send(data) |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 357 | return result |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 358 | except socket.error as why: |
Georg Brandl | f112369 | 2008-07-20 07:31:30 +0000 | [diff] [blame] | 359 | if why.args[0] == EWOULDBLOCK: |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 360 | return 0 |
Georg Brandl | f112369 | 2008-07-20 07:31:30 +0000 | [diff] [blame] | 361 | elif why.args[0] in (ECONNRESET, ENOTCONN, ESHUTDOWN, ECONNABORTED): |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 362 | self.handle_close() |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 363 | return 0 |
| 364 | else: |
Tim Peters | 4e0e1b6 | 2004-07-07 20:54:48 +0000 | [diff] [blame] | 365 | raise |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 366 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 367 | def recv(self, buffer_size): |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 368 | try: |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 369 | data = self.socket.recv(buffer_size) |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 370 | if not data: |
| 371 | # a closed connection is indicated by signaling |
| 372 | # a read condition, and having recv() return 0. |
| 373 | self.handle_close() |
Guido van Rossum | df4a743 | 2007-07-18 20:57:44 +0000 | [diff] [blame] | 374 | return b'' |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 375 | else: |
| 376 | return data |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 377 | except socket.error as why: |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 378 | # winsock sometimes throws ENOTCONN |
Georg Brandl | f112369 | 2008-07-20 07:31:30 +0000 | [diff] [blame] | 379 | if why.args[0] in [ECONNRESET, ENOTCONN, ESHUTDOWN, ECONNABORTED]: |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 380 | self.handle_close() |
Guido van Rossum | df4a743 | 2007-07-18 20:57:44 +0000 | [diff] [blame] | 381 | return b'' |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 382 | else: |
Tim Peters | 4e0e1b6 | 2004-07-07 20:54:48 +0000 | [diff] [blame] | 383 | raise |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 384 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 385 | def close(self): |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 386 | self.connected = False |
| 387 | self.accepting = False |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 388 | self.del_channel() |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 389 | try: |
| 390 | self.socket.close() |
| 391 | except socket.error as why: |
Georg Brandl | f112369 | 2008-07-20 07:31:30 +0000 | [diff] [blame] | 392 | if why.args[0] not in (ENOTCONN, EBADF): |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 393 | raise |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 394 | |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 395 | # cheap inheritance, used to pass all other attribute |
| 396 | # references to the underlying socket object. |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 397 | def __getattr__(self, attr): |
| 398 | return getattr(self.socket, attr) |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 399 | |
Andrew M. Kuchling | c07fb2f | 2003-02-14 01:13:01 +0000 | [diff] [blame] | 400 | # log and log_info may be overridden to provide more sophisticated |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 401 | # logging and warning methods. In general, log is for 'hit' logging |
Tim Peters | 146965a | 2001-01-14 18:09:23 +0000 | [diff] [blame] | 402 | # and 'log_info' is for informational, warning and error logging. |
Andrew M. Kuchling | da85a27 | 2000-09-08 20:30:39 +0000 | [diff] [blame] | 403 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 404 | def log(self, message): |
| 405 | sys.stderr.write('log: %s\n' % str(message)) |
Andrew M. Kuchling | da85a27 | 2000-09-08 20:30:39 +0000 | [diff] [blame] | 406 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 407 | def log_info(self, message, type='info'): |
R. David Murray | 78532ba | 2009-04-12 15:35:44 +0000 | [diff] [blame] | 408 | if type not in self.ignore_log_types: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 409 | print('%s: %s' % (type, message)) |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 410 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 411 | def handle_read_event(self): |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 412 | if self.accepting: |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 413 | # accepting sockets are never connected, they "spawn" new |
| 414 | # sockets that are connected |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 415 | self.handle_accept() |
| 416 | elif not self.connected: |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 417 | self.handle_connect_event() |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 418 | self.handle_read() |
| 419 | else: |
| 420 | self.handle_read() |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 421 | |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 422 | def handle_connect_event(self): |
| 423 | self.connected = True |
| 424 | self.handle_connect() |
| 425 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 426 | def handle_write_event(self): |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 427 | if self.accepting: |
| 428 | # Accepting sockets shouldn't get a write event. |
| 429 | # We will pretend it didn't happen. |
| 430 | return |
| 431 | |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 432 | if not self.connected: |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 433 | #check for errors |
| 434 | err = self.socket.getsockopt(socket.SOL_SOCKET, socket.SO_ERROR) |
| 435 | if err != 0: |
| 436 | raise socket.error(err, _strerror(err)) |
| 437 | |
| 438 | self.handle_connect_event() |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 439 | self.handle_write() |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 440 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 441 | def handle_expt_event(self): |
R. David Murray | 78532ba | 2009-04-12 15:35:44 +0000 | [diff] [blame] | 442 | # handle_expt_event() is called if there might be an error on the |
| 443 | # socket, or if there is OOB data |
| 444 | # check for the error condition first |
| 445 | err = self.socket.getsockopt(socket.SOL_SOCKET, socket.SO_ERROR) |
| 446 | if err != 0: |
| 447 | # we can get here when select.select() says that there is an |
| 448 | # exceptional condition on the socket |
| 449 | # since there is an error, we'll go ahead and close the socket |
| 450 | # like we would in a subclassed handle_read() that received no |
| 451 | # data |
| 452 | self.handle_close() |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 453 | else: |
| 454 | self.handle_expt() |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 455 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 456 | def handle_error(self): |
Jeremy Hylton | a8b5f7d | 2001-08-10 14:30:35 +0000 | [diff] [blame] | 457 | nil, t, v, tbinfo = compact_traceback() |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 458 | |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 459 | # sometimes a user repr method will crash. |
| 460 | try: |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 461 | self_repr = repr(self) |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 462 | except: |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 463 | self_repr = '<__repr__(self) failed for object at %0x>' % id(self) |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 464 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 465 | self.log_info( |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 466 | 'uncaptured python exception, closing channel %s (%s:%s %s)' % ( |
| 467 | self_repr, |
| 468 | t, |
| 469 | v, |
| 470 | tbinfo |
| 471 | ), |
| 472 | 'error' |
| 473 | ) |
Josiah Carlson | 9f2f833 | 2008-07-07 05:04:12 +0000 | [diff] [blame] | 474 | self.handle_close() |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 475 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 476 | def handle_expt(self): |
R. David Murray | 78532ba | 2009-04-12 15:35:44 +0000 | [diff] [blame] | 477 | self.log_info('unhandled incoming priority event', 'warning') |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 478 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 479 | def handle_read(self): |
| 480 | self.log_info('unhandled read event', 'warning') |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 481 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 482 | def handle_write(self): |
| 483 | self.log_info('unhandled write event', 'warning') |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 484 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 485 | def handle_connect(self): |
| 486 | self.log_info('unhandled connect event', 'warning') |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 487 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 488 | def handle_accept(self): |
| 489 | self.log_info('unhandled accept event', 'warning') |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 490 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 491 | def handle_close(self): |
| 492 | self.log_info('unhandled close event', 'warning') |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 493 | self.close() |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 494 | |
| 495 | # --------------------------------------------------------------------------- |
| 496 | # adds simple buffered output capability, useful for simple clients. |
| 497 | # [for more sophisticated usage use asynchat.async_chat] |
| 498 | # --------------------------------------------------------------------------- |
| 499 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 500 | class dispatcher_with_send(dispatcher): |
| 501 | |
Andrew M. Kuchling | 67867ea | 2004-03-21 20:03:18 +0000 | [diff] [blame] | 502 | def __init__(self, sock=None, map=None): |
| 503 | dispatcher.__init__(self, sock, map) |
Guido van Rossum | df4a743 | 2007-07-18 20:57:44 +0000 | [diff] [blame] | 504 | self.out_buffer = b'' |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 505 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 506 | def initiate_send(self): |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 507 | num_sent = 0 |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 508 | num_sent = dispatcher.send(self, self.out_buffer[:512]) |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 509 | self.out_buffer = self.out_buffer[num_sent:] |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 510 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 511 | def handle_write(self): |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 512 | self.initiate_send() |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 513 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 514 | def writable(self): |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 515 | return (not self.connected) or len(self.out_buffer) |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 516 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 517 | def send(self, data): |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 518 | if self.debug: |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 519 | self.log_info('sending %s' % repr(data)) |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 520 | self.out_buffer = self.out_buffer + data |
| 521 | self.initiate_send() |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 522 | |
| 523 | # --------------------------------------------------------------------------- |
| 524 | # used for debugging. |
| 525 | # --------------------------------------------------------------------------- |
| 526 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 527 | def compact_traceback(): |
Guido van Rossum | 12e9668 | 2002-09-13 14:09:26 +0000 | [diff] [blame] | 528 | t, v, tb = sys.exc_info() |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 529 | tbinfo = [] |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 530 | if not tb: # Must have a traceback |
| 531 | raise AssertionError("traceback does not exist") |
Guido van Rossum | 12e9668 | 2002-09-13 14:09:26 +0000 | [diff] [blame] | 532 | while tb: |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 533 | tbinfo.append(( |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 534 | tb.tb_frame.f_code.co_filename, |
Tim Peters | 146965a | 2001-01-14 18:09:23 +0000 | [diff] [blame] | 535 | tb.tb_frame.f_code.co_name, |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 536 | str(tb.tb_lineno) |
| 537 | )) |
| 538 | tb = tb.tb_next |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 539 | |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 540 | # just to be safe |
| 541 | del tb |
Guido van Rossum | a8d0f4f | 1999-06-08 13:20:05 +0000 | [diff] [blame] | 542 | |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 543 | file, function, line = tbinfo[-1] |
Guido van Rossum | 12e9668 | 2002-09-13 14:09:26 +0000 | [diff] [blame] | 544 | info = ' '.join(['[%s|%s|%s]' % x for x in tbinfo]) |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 545 | return (file, function, line), t, v, info |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 546 | |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 547 | def close_all(map=None, ignore_all=False): |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 548 | if map is None: |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 549 | map = socket_map |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 550 | for x in list(map.values()): |
| 551 | try: |
| 552 | x.close() |
| 553 | except OSError as x: |
Georg Brandl | f112369 | 2008-07-20 07:31:30 +0000 | [diff] [blame] | 554 | if x.args[0] == EBADF: |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 555 | pass |
| 556 | elif not ignore_all: |
| 557 | raise |
R. David Murray | 78532ba | 2009-04-12 15:35:44 +0000 | [diff] [blame] | 558 | except _reraised_exceptions: |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 559 | raise |
| 560 | except: |
| 561 | if not ignore_all: |
| 562 | raise |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 563 | map.clear() |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 564 | |
| 565 | # Asynchronous File I/O: |
| 566 | # |
| 567 | # After a little research (reading man pages on various unixen, and |
| 568 | # digging through the linux kernel), I've determined that select() |
Walter Dörwald | f0dfc7a | 2003-10-20 14:01:56 +0000 | [diff] [blame] | 569 | # isn't meant for doing asynchronous file i/o. |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 570 | # Heartening, though - reading linux/mm/filemap.c shows that linux |
| 571 | # supports asynchronous read-ahead. So _MOST_ of the time, the data |
| 572 | # will be sitting in memory for us already when we go to read it. |
| 573 | # |
| 574 | # What other OS's (besides NT) support async file i/o? [VMS?] |
| 575 | # |
| 576 | # Regardless, this is useful for pipes, and stdin/stdout... |
| 577 | |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 578 | if os.name == 'posix': |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 579 | import fcntl |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 580 | |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 581 | class file_wrapper: |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 582 | # Here we override just enough to make a file |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 583 | # look like a socket for the purposes of asyncore. |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 584 | # The passed fd is automatically os.dup()'d |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 585 | |
| 586 | def __init__(self, fd): |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 587 | self.fd = os.dup(fd) |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 588 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 589 | def recv(self, *args): |
Jeremy Hylton | f32e459 | 2002-04-04 21:02:24 +0000 | [diff] [blame] | 590 | return os.read(self.fd, *args) |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 591 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 592 | def send(self, *args): |
Jeremy Hylton | f32e459 | 2002-04-04 21:02:24 +0000 | [diff] [blame] | 593 | return os.write(self.fd, *args) |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 594 | |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 595 | read = recv |
| 596 | write = send |
Andrew M. Kuchling | da85a27 | 2000-09-08 20:30:39 +0000 | [diff] [blame] | 597 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 598 | def close(self): |
Andrew M. Kuchling | dfa74b9 | 2004-07-10 15:51:19 +0000 | [diff] [blame] | 599 | os.close(self.fd) |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 600 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 601 | def fileno(self): |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 602 | return self.fd |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 603 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 604 | class file_dispatcher(dispatcher): |
| 605 | |
Andrew M. Kuchling | 67867ea | 2004-03-21 20:03:18 +0000 | [diff] [blame] | 606 | def __init__(self, fd, map=None): |
| 607 | dispatcher.__init__(self, None, map) |
Andrew M. Kuchling | 68522b1 | 2004-03-21 19:46:16 +0000 | [diff] [blame] | 608 | self.connected = True |
Josiah Carlson | d74900e | 2008-07-07 04:15:08 +0000 | [diff] [blame] | 609 | try: |
| 610 | fd = fd.fileno() |
| 611 | except AttributeError: |
| 612 | pass |
Andrew M. Kuchling | dfa74b9 | 2004-07-10 15:51:19 +0000 | [diff] [blame] | 613 | self.set_file(fd) |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 614 | # set it to non-blocking mode |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 615 | flags = fcntl.fcntl(fd, fcntl.F_GETFL, 0) |
Fred Drake | a94414a | 2001-05-10 15:33:31 +0000 | [diff] [blame] | 616 | flags = flags | os.O_NONBLOCK |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 617 | fcntl.fcntl(fd, fcntl.F_SETFL, flags) |
Guido van Rossum | 0039d7b | 1999-01-12 20:19:27 +0000 | [diff] [blame] | 618 | |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 619 | def set_file(self, fd): |
Guido van Rossum | d560ace | 2002-09-12 04:57:29 +0000 | [diff] [blame] | 620 | self.socket = file_wrapper(fd) |
Josiah Carlson | aae55cb | 2008-11-19 18:22:41 +0000 | [diff] [blame] | 621 | self._fileno = self.socket.fileno() |
Fred Drake | 526a182 | 2000-09-11 04:00:46 +0000 | [diff] [blame] | 622 | self.add_channel() |