blob: e6998157499e1211505d56655afd1dd4f345a0e6 [file] [log] [blame]
Fred Drake526a1822000-09-11 04:00:46 +00001# -*- Mode: Python -*-
Tim Peters146965a2001-01-14 18:09:23 +00002# Id: asyncore.py,v 2.51 2000/09/07 22:29:26 rushing Exp
Fred Drake526a1822000-09-11 04:00:46 +00003# Author: Sam Rushing <rushing@nightmare.com>
Guido van Rossum0039d7b1999-01-12 20:19:27 +00004
5# ======================================================================
6# Copyright 1996 by Sam Rushing
Tim Peters146965a2001-01-14 18:09:23 +00007#
Guido van Rossum0039d7b1999-01-12 20:19:27 +00008# All Rights Reserved
Tim Peters146965a2001-01-14 18:09:23 +00009#
Guido van Rossum0039d7b1999-01-12 20:19:27 +000010# 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 Peters146965a2001-01-14 18:09:23 +000018#
Guido van Rossum0039d7b1999-01-12 20:19:27 +000019# 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 Rossum4b8c6ea2000-02-04 15:39:30 +000028"""Basic infrastructure for asynchronous socket service clients and servers.
29
30There are only two ways to have a program on a single processor do "more
Tim Peters146965a2001-01-14 18:09:23 +000031than one thing at a time". Multi-threaded programming is the simplest and
Guido van Rossum4b8c6ea2000-02-04 15:39:30 +000032most popular way to do it, but there is another very different technique,
33that lets you have nearly all the advantages of multi-threading, without
34actually using multiple threads. it's really only practical if your program
35is largely I/O bound. If your program is CPU bound, then pre-emptive
36scheduled threads are probably what you really need. Network servers are
Tim Peters146965a2001-01-14 18:09:23 +000037rarely CPU-bound, however.
Guido van Rossum4b8c6ea2000-02-04 15:39:30 +000038
Tim Peters146965a2001-01-14 18:09:23 +000039If your operating system supports the select() system call in its I/O
Guido van Rossum4b8c6ea2000-02-04 15:39:30 +000040library (and nearly all do), then you can use it to juggle multiple
41communication channels at once; doing other work while your I/O is taking
42place in the "background." Although this strategy can seem strange and
43complex, especially at first, it is in many ways easier to understand and
44control than multi-threaded programming. The module documented here solves
45many of the difficult problems for you, making the task of building
Tim Peters146965a2001-01-14 18:09:23 +000046sophisticated high-performance network servers and clients a snap.
Guido van Rossum4b8c6ea2000-02-04 15:39:30 +000047"""
48
Guido van Rossum0039d7b1999-01-12 20:19:27 +000049import select
50import socket
Guido van Rossum0039d7b1999-01-12 20:19:27 +000051import sys
Thomas Hellerd8ce87a2002-09-24 17:30:31 +000052import time
Giampaolo Rodolà8d2dc852010-05-06 18:06:30 +000053import warnings
54
Guido van Rossum0039d7b1999-01-12 20:19:27 +000055import os
Giampaolo Rodolà76fc8c72010-08-23 21:53:41 +000056from errno import EALREADY, EINPROGRESS, EWOULDBLOCK, ECONNRESET, EINVAL, \
Giampaolo Rodolàde3dc0f2011-03-03 14:10:58 +000057 ENOTCONN, ESHUTDOWN, EINTR, EISCONN, EBADF, ECONNABORTED, EPIPE, EAGAIN, \
58 errorcode
Guido van Rossum0039d7b1999-01-12 20:19:27 +000059
Giampaolo Rodolà1bc75c62011-03-03 13:57:47 +000060_DISCONNECTED = frozenset((ECONNRESET, ENOTCONN, ESHUTDOWN, ECONNABORTED, EPIPE,
61 EBADF))
Giampaolo Rodolà985b68e2010-09-15 21:43:47 +000062
Andrew M. Kuchlingda85a272000-09-08 20:30:39 +000063try:
Fred Drake526a1822000-09-11 04:00:46 +000064 socket_map
Andrew M. Kuchlingda85a272000-09-08 20:30:39 +000065except NameError:
Fred Drake526a1822000-09-11 04:00:46 +000066 socket_map = {}
Guido van Rossum0039d7b1999-01-12 20:19:27 +000067
Josiah Carlsond74900e2008-07-07 04:15:08 +000068def _strerror(err):
Giampaolo Rodolà8d2dc852010-05-06 18:06:30 +000069 try:
Giampaolo Rodolà82e02b52010-05-18 20:11:58 +000070 return os.strerror(err)
71 except (ValueError, OverflowError, NameError):
Giampaolo Rodolà8d2dc852010-05-06 18:06:30 +000072 if err in errorcode:
73 return errorcode[err]
74 return "Unknown error %s" %err
Josiah Carlsond74900e2008-07-07 04:15:08 +000075
Neal Norwitz4ce69a52005-09-01 00:45:28 +000076class ExitNow(Exception):
Fred Drake526a1822000-09-11 04:00:46 +000077 pass
Andrew M. Kuchlingda85a272000-09-08 20:30:39 +000078
R. David Murray78532ba2009-04-12 15:35:44 +000079_reraised_exceptions = (ExitNow, KeyboardInterrupt, SystemExit)
80
Jeremy Hyltond7500362002-09-08 00:14:54 +000081def read(obj):
82 try:
83 obj.handle_read_event()
R. David Murray78532ba2009-04-12 15:35:44 +000084 except _reraised_exceptions:
Jeremy Hyltond7500362002-09-08 00:14:54 +000085 raise
86 except:
87 obj.handle_error()
88
89def write(obj):
90 try:
91 obj.handle_write_event()
R. David Murray78532ba2009-04-12 15:35:44 +000092 except _reraised_exceptions:
Jeremy Hyltond7500362002-09-08 00:14:54 +000093 raise
94 except:
95 obj.handle_error()
96
Josiah Carlsond74900e2008-07-07 04:15:08 +000097def _exception(obj):
Andrew M. Kuchling0fff6c82004-07-10 17:36:11 +000098 try:
99 obj.handle_expt_event()
R. David Murray78532ba2009-04-12 15:35:44 +0000100 except _reraised_exceptions:
Andrew M. Kuchling0fff6c82004-07-10 17:36:11 +0000101 raise
102 except:
103 obj.handle_error()
104
Jeremy Hyltond7500362002-09-08 00:14:54 +0000105def readwrite(obj, flags):
106 try:
R. David Murray78532ba2009-04-12 15:35:44 +0000107 if flags & select.POLLIN:
Jeremy Hyltond7500362002-09-08 00:14:54 +0000108 obj.handle_read_event()
109 if flags & select.POLLOUT:
110 obj.handle_write_event()
R. David Murray78532ba2009-04-12 15:35:44 +0000111 if flags & select.POLLPRI:
112 obj.handle_expt_event()
Josiah Carlson0abc64d2009-06-03 19:48:02 +0000113 if flags & (select.POLLHUP | select.POLLERR | select.POLLNVAL):
114 obj.handle_close()
115 except socket.error as e:
Giampaolo Rodolà1bc75c62011-03-03 13:57:47 +0000116 if e.args[0] not in _DISCONNECTED:
Josiah Carlson0abc64d2009-06-03 19:48:02 +0000117 obj.handle_error()
118 else:
119 obj.handle_close()
R. David Murray78532ba2009-04-12 15:35:44 +0000120 except _reraised_exceptions:
Jeremy Hyltond7500362002-09-08 00:14:54 +0000121 raise
122 except:
123 obj.handle_error()
Andrew M. Kuchlingda85a272000-09-08 20:30:39 +0000124
Guido van Rossumd560ace2002-09-12 04:57:29 +0000125def poll(timeout=0.0, map=None):
Fred Drake526a1822000-09-11 04:00:46 +0000126 if map is None:
127 map = socket_map
128 if map:
129 r = []; w = []; e = []
Josiah Carlsond74900e2008-07-07 04:15:08 +0000130 for fd, obj in list(map.items()):
Andrew M. Kuchlinge47c3812004-09-01 14:04:51 +0000131 is_r = obj.readable()
132 is_w = obj.writable()
133 if is_r:
Jeremy Hyltond7500362002-09-08 00:14:54 +0000134 r.append(fd)
Charles-François Natalif64f9e92011-07-14 20:00:49 +0200135 # accepting sockets should not be writable
136 if is_w and not obj.accepting:
Jeremy Hyltond7500362002-09-08 00:14:54 +0000137 w.append(fd)
Andrew M. Kuchlinge47c3812004-09-01 14:04:51 +0000138 if is_r or is_w:
139 e.append(fd)
Thomas Hellerd8ce87a2002-09-24 17:30:31 +0000140 if [] == r == w == e:
141 time.sleep(timeout)
Josiah Carlsond74900e2008-07-07 04:15:08 +0000142 return
143
144 try:
145 r, w, e = select.select(r, w, e, timeout)
146 except select.error as err:
Georg Brandlf1123692008-07-20 07:31:30 +0000147 if err.args[0] != EINTR:
Josiah Carlsond74900e2008-07-07 04:15:08 +0000148 raise
149 else:
150 return
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000151
Fred Drake526a1822000-09-11 04:00:46 +0000152 for fd in r:
Jeremy Hyltond7500362002-09-08 00:14:54 +0000153 obj = map.get(fd)
154 if obj is None:
Martin v. Löwis6ec9a362001-10-09 10:10:33 +0000155 continue
Jeremy Hyltond7500362002-09-08 00:14:54 +0000156 read(obj)
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000157
Fred Drake526a1822000-09-11 04:00:46 +0000158 for fd in w:
Jeremy Hyltond7500362002-09-08 00:14:54 +0000159 obj = map.get(fd)
160 if obj is None:
Martin v. Löwis6ec9a362001-10-09 10:10:33 +0000161 continue
Jeremy Hyltond7500362002-09-08 00:14:54 +0000162 write(obj)
Andrew M. Kuchlingda85a272000-09-08 20:30:39 +0000163
Andrew M. Kuchling0fff6c82004-07-10 17:36:11 +0000164 for fd in e:
165 obj = map.get(fd)
166 if obj is None:
167 continue
168 _exception(obj)
169
Guido van Rossumd560ace2002-09-12 04:57:29 +0000170def poll2(timeout=0.0, map=None):
Andrew M. Kuchlingaf6963c2001-01-24 15:50:19 +0000171 # Use the poll() support added to the select module in Python 2.0
172 if map is None:
Guido van Rossumd560ace2002-09-12 04:57:29 +0000173 map = socket_map
Martin v. Löwisf6cc07c2001-09-19 17:31:47 +0000174 if timeout is not None:
175 # timeout is in milliseconds
176 timeout = int(timeout*1000)
Andrew M. Kuchlingaf6963c2001-01-24 15:50:19 +0000177 pollster = select.poll()
178 if map:
Josiah Carlsond74900e2008-07-07 04:15:08 +0000179 for fd, obj in list(map.items()):
Andrew M. Kuchlinge47c3812004-09-01 14:04:51 +0000180 flags = 0
Andrew M. Kuchlingaf6963c2001-01-24 15:50:19 +0000181 if obj.readable():
Andrew M. Kuchling6fe93cd2004-07-07 12:23:53 +0000182 flags |= select.POLLIN | select.POLLPRI
Charles-François Natalif64f9e92011-07-14 20:00:49 +0200183 # accepting sockets should not be writable
184 if obj.writable() and not obj.accepting:
Andrew M. Kuchling6fe93cd2004-07-07 12:23:53 +0000185 flags |= select.POLLOUT
Andrew M. Kuchlingaf6963c2001-01-24 15:50:19 +0000186 if flags:
Andrew M. Kuchlinge47c3812004-09-01 14:04:51 +0000187 # Only check for exceptions if object was either readable
188 # or writable.
189 flags |= select.POLLERR | select.POLLHUP | select.POLLNVAL
Andrew M. Kuchlingaf6963c2001-01-24 15:50:19 +0000190 pollster.register(fd, flags)
Jeremy Hyltonfbd57972001-10-29 16:32:19 +0000191 try:
Guido van Rossumd560ace2002-09-12 04:57:29 +0000192 r = pollster.poll(timeout)
Guido van Rossumb940e112007-01-10 16:19:56 +0000193 except select.error as err:
Georg Brandlf1123692008-07-20 07:31:30 +0000194 if err.args[0] != EINTR:
Jeremy Hyltonfbd57972001-10-29 16:32:19 +0000195 raise
196 r = []
Andrew M. Kuchlingaf6963c2001-01-24 15:50:19 +0000197 for fd, flags in r:
Jeremy Hyltond7500362002-09-08 00:14:54 +0000198 obj = map.get(fd)
199 if obj is None:
Martin v. Löwis6ec9a362001-10-09 10:10:33 +0000200 continue
Jeremy Hyltond7500362002-09-08 00:14:54 +0000201 readwrite(obj, flags)
Andrew M. Kuchlingaf6963c2001-01-24 15:50:19 +0000202
Andrew M. Kuchling6c2871e2003-10-22 14:38:27 +0000203poll3 = poll2 # Alias for backward compatibility
204
Michael W. Hudsond5cf1432004-06-30 09:02:33 +0000205def loop(timeout=30.0, use_poll=False, map=None, count=None):
Andrew M. Kuchlingaf6963c2001-01-24 15:50:19 +0000206 if map is None:
Jeremy Hyltond7500362002-09-08 00:14:54 +0000207 map = socket_map
Andrew M. Kuchlingaf6963c2001-01-24 15:50:19 +0000208
Andrew M. Kuchling6c2871e2003-10-22 14:38:27 +0000209 if use_poll and hasattr(select, 'poll'):
210 poll_fun = poll2
Fred Drake526a1822000-09-11 04:00:46 +0000211 else:
212 poll_fun = poll
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000213
Michael W. Hudsond5cf1432004-06-30 09:02:33 +0000214 if count is None:
215 while map:
216 poll_fun(timeout, map)
217
218 else:
219 while map and count > 0:
220 poll_fun(timeout, map)
221 count = count - 1
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000222
223class dispatcher:
Guido van Rossumd560ace2002-09-12 04:57:29 +0000224
Giampaolo Rodolà900d5472011-02-11 14:01:46 +0000225 debug = False
Andrew M. Kuchling68522b12004-03-21 19:46:16 +0000226 connected = False
227 accepting = False
Giampaolo Rodolà900d5472011-02-11 14:01:46 +0000228 closing = False
Fred Drake526a1822000-09-11 04:00:46 +0000229 addr = None
R. David Murray78532ba2009-04-12 15:35:44 +0000230 ignore_log_types = frozenset(['warning'])
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000231
Guido van Rossumd560ace2002-09-12 04:57:29 +0000232 def __init__(self, sock=None, map=None):
Andrew M. Kuchlingf9ca4092003-10-22 13:48:27 +0000233 if map is None:
234 self._map = socket_map
235 else:
236 self._map = map
237
Josiah Carlsond74900e2008-07-07 04:15:08 +0000238 self._fileno = None
239
Fred Drake526a1822000-09-11 04:00:46 +0000240 if sock:
Josiah Carlsond74900e2008-07-07 04:15:08 +0000241 # Set to nonblocking just to make sure for cases where we
242 # get a socket from a blocking source.
243 sock.setblocking(0)
Guido van Rossumd560ace2002-09-12 04:57:29 +0000244 self.set_socket(sock, map)
Andrew M. Kuchling68522b12004-03-21 19:46:16 +0000245 self.connected = True
Josiah Carlsond74900e2008-07-07 04:15:08 +0000246 # The constructor no longer requires that the socket
247 # passed be connected.
Jeremy Hylton2a05bc72001-12-14 16:15:11 +0000248 try:
249 self.addr = sock.getpeername()
Josiah Carlsond74900e2008-07-07 04:15:08 +0000250 except socket.error as err:
Georg Brandlf1123692008-07-20 07:31:30 +0000251 if err.args[0] == ENOTCONN:
Josiah Carlsond74900e2008-07-07 04:15:08 +0000252 # To handle the case where we got an unconnected
253 # socket.
254 self.connected = False
255 else:
256 # The socket is broken in some unknown way, alert
257 # the user and remove it from the map (to prevent
258 # polling of broken sockets).
259 self.del_channel(map)
260 raise
Jeremy Hyltonfbd57972001-10-29 16:32:19 +0000261 else:
262 self.socket = None
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000263
Guido van Rossumd560ace2002-09-12 04:57:29 +0000264 def __repr__(self):
Martin v. Löwis29103c72001-10-18 17:33:19 +0000265 status = [self.__class__.__module__+"."+self.__class__.__name__]
266 if self.accepting and self.addr:
Guido van Rossumd560ace2002-09-12 04:57:29 +0000267 status.append('listening')
Martin v. Löwis29103c72001-10-18 17:33:19 +0000268 elif self.connected:
Guido van Rossumd560ace2002-09-12 04:57:29 +0000269 status.append('connected')
Martin v. Löwis29103c72001-10-18 17:33:19 +0000270 if self.addr is not None:
271 try:
Guido van Rossumd560ace2002-09-12 04:57:29 +0000272 status.append('%s:%d' % self.addr)
Martin v. Löwis29103c72001-10-18 17:33:19 +0000273 except TypeError:
Guido van Rossumd560ace2002-09-12 04:57:29 +0000274 status.append(repr(self.addr))
275 return '<%s at %#x>' % (' '.join(status), id(self))
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000276
Giampaolo Rodolà8d2dc852010-05-06 18:06:30 +0000277 __str__ = __repr__
278
Guido van Rossumd560ace2002-09-12 04:57:29 +0000279 def add_channel(self, map=None):
280 #self.log_info('adding channel %s' % self)
Fred Drake526a1822000-09-11 04:00:46 +0000281 if map is None:
Andrew M. Kuchlingf9ca4092003-10-22 13:48:27 +0000282 map = self._map
Guido van Rossum12e96682002-09-13 14:09:26 +0000283 map[self._fileno] = self
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000284
Guido van Rossumd560ace2002-09-12 04:57:29 +0000285 def del_channel(self, map=None):
Fred Drake526a1822000-09-11 04:00:46 +0000286 fd = self._fileno
287 if map is None:
Andrew M. Kuchlingf9ca4092003-10-22 13:48:27 +0000288 map = self._map
Guido van Rossume2b70bc2006-08-18 22:13:04 +0000289 if fd in map:
Guido van Rossumd560ace2002-09-12 04:57:29 +0000290 #self.log_info('closing channel %d:%s' % (fd, self))
Guido van Rossum12e96682002-09-13 14:09:26 +0000291 del map[fd]
Raymond Hettinger3dc34842004-02-08 11:32:50 +0000292 self._fileno = None
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000293
Giampaolo Rodolà103a6d62011-02-25 22:21:22 +0000294 def create_socket(self, family=socket.AF_INET, type=socket.SOCK_STREAM):
Fred Drake526a1822000-09-11 04:00:46 +0000295 self.family_and_type = family, type
Josiah Carlsond74900e2008-07-07 04:15:08 +0000296 sock = socket.socket(family, type)
297 sock.setblocking(0)
298 self.set_socket(sock)
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000299
Guido van Rossumd560ace2002-09-12 04:57:29 +0000300 def set_socket(self, sock, map=None):
Jeremy Hyltonfbd57972001-10-29 16:32:19 +0000301 self.socket = sock
302## self.__dict__['socket'] = sock
Fred Drake526a1822000-09-11 04:00:46 +0000303 self._fileno = sock.fileno()
Guido van Rossumd560ace2002-09-12 04:57:29 +0000304 self.add_channel(map)
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000305
Guido van Rossumd560ace2002-09-12 04:57:29 +0000306 def set_reuse_addr(self):
Fred Drake526a1822000-09-11 04:00:46 +0000307 # try to re-use a server port if possible
308 try:
Guido van Rossumd560ace2002-09-12 04:57:29 +0000309 self.socket.setsockopt(
Andrew M. Kuchling9d499f22004-08-13 20:06:57 +0000310 socket.SOL_SOCKET, socket.SO_REUSEADDR,
Guido van Rossumd560ace2002-09-12 04:57:29 +0000311 self.socket.getsockopt(socket.SOL_SOCKET,
Andrew M. Kuchling9d499f22004-08-13 20:06:57 +0000312 socket.SO_REUSEADDR) | 1
Fred Drake526a1822000-09-11 04:00:46 +0000313 )
Fred Drake9f9b5932001-05-11 18:28:54 +0000314 except socket.error:
Fred Drake526a1822000-09-11 04:00:46 +0000315 pass
Tim Peters182b5ac2004-07-18 06:16:08 +0000316
Fred Drake526a1822000-09-11 04:00:46 +0000317 # ==================================================
318 # predicates for select()
319 # these are used as filters for the lists of sockets
320 # to pass to select().
321 # ==================================================
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000322
Guido van Rossumd560ace2002-09-12 04:57:29 +0000323 def readable(self):
Tim Petersbc0e9102002-04-04 22:55:58 +0000324 return True
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000325
Andrew M. Kuchling419af882004-03-21 19:52:01 +0000326 def writable(self):
327 return True
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000328
Fred Drake526a1822000-09-11 04:00:46 +0000329 # ==================================================
330 # socket object methods.
331 # ==================================================
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000332
Guido van Rossumd560ace2002-09-12 04:57:29 +0000333 def listen(self, num):
Andrew M. Kuchling68522b12004-03-21 19:46:16 +0000334 self.accepting = True
Fred Drake526a1822000-09-11 04:00:46 +0000335 if os.name == 'nt' and num > 5:
Josiah Carlsond74900e2008-07-07 04:15:08 +0000336 num = 5
Guido van Rossumd560ace2002-09-12 04:57:29 +0000337 return self.socket.listen(num)
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000338
Guido van Rossumd560ace2002-09-12 04:57:29 +0000339 def bind(self, addr):
Fred Drake526a1822000-09-11 04:00:46 +0000340 self.addr = addr
Guido van Rossumd560ace2002-09-12 04:57:29 +0000341 return self.socket.bind(addr)
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000342
Guido van Rossumd560ace2002-09-12 04:57:29 +0000343 def connect(self, address):
Andrew M. Kuchling68522b12004-03-21 19:46:16 +0000344 self.connected = False
Jeremy Hyltone16e54f2001-10-29 16:44:37 +0000345 err = self.socket.connect_ex(address)
Giampaolo Rodolà76fc8c72010-08-23 21:53:41 +0000346 if err in (EINPROGRESS, EALREADY, EWOULDBLOCK) \
347 or err == EINVAL and os.name in ('nt', 'ce'):
Jeremy Hyltone16e54f2001-10-29 16:44:37 +0000348 return
349 if err in (0, EISCONN):
350 self.addr = address
Josiah Carlsond74900e2008-07-07 04:15:08 +0000351 self.handle_connect_event()
Jeremy Hyltonf24339f2001-10-30 14:16:17 +0000352 else:
Collin Winterce36ad82007-08-30 01:19:48 +0000353 raise socket.error(err, errorcode[err])
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000354
Guido van Rossumd560ace2002-09-12 04:57:29 +0000355 def accept(self):
Jeremy Hyltonf32e4592002-04-04 21:02:24 +0000356 # XXX can return either an address pair or None
Fred Drake526a1822000-09-11 04:00:46 +0000357 try:
358 conn, addr = self.socket.accept()
Giampaolo Rodolà977c7072010-10-04 21:08:36 +0000359 except TypeError:
360 return None
Guido van Rossumb940e112007-01-10 16:19:56 +0000361 except socket.error as why:
Giampaolo Rodolà1bc75c62011-03-03 13:57:47 +0000362 if why.args[0] in (EWOULDBLOCK, ECONNABORTED, EAGAIN):
Giampaolo Rodolà977c7072010-10-04 21:08:36 +0000363 return None
Fred Drake526a1822000-09-11 04:00:46 +0000364 else:
Tim Peters4e0e1b62004-07-07 20:54:48 +0000365 raise
Giampaolo Rodolà977c7072010-10-04 21:08:36 +0000366 else:
367 return conn, addr
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000368
Guido van Rossumd560ace2002-09-12 04:57:29 +0000369 def send(self, data):
Fred Drake526a1822000-09-11 04:00:46 +0000370 try:
Guido van Rossumd560ace2002-09-12 04:57:29 +0000371 result = self.socket.send(data)
Fred Drake526a1822000-09-11 04:00:46 +0000372 return result
Guido van Rossumb940e112007-01-10 16:19:56 +0000373 except socket.error as why:
Georg Brandlf1123692008-07-20 07:31:30 +0000374 if why.args[0] == EWOULDBLOCK:
Josiah Carlsond74900e2008-07-07 04:15:08 +0000375 return 0
Giampaolo Rodolà86909b52010-09-15 21:59:04 +0000376 elif why.args[0] in _DISCONNECTED:
Josiah Carlsond74900e2008-07-07 04:15:08 +0000377 self.handle_close()
Fred Drake526a1822000-09-11 04:00:46 +0000378 return 0
379 else:
Tim Peters4e0e1b62004-07-07 20:54:48 +0000380 raise
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000381
Guido van Rossumd560ace2002-09-12 04:57:29 +0000382 def recv(self, buffer_size):
Fred Drake526a1822000-09-11 04:00:46 +0000383 try:
Guido van Rossumd560ace2002-09-12 04:57:29 +0000384 data = self.socket.recv(buffer_size)
Fred Drake526a1822000-09-11 04:00:46 +0000385 if not data:
386 # a closed connection is indicated by signaling
387 # a read condition, and having recv() return 0.
388 self.handle_close()
Guido van Rossumdf4a7432007-07-18 20:57:44 +0000389 return b''
Fred Drake526a1822000-09-11 04:00:46 +0000390 else:
391 return data
Guido van Rossumb940e112007-01-10 16:19:56 +0000392 except socket.error as why:
Fred Drake526a1822000-09-11 04:00:46 +0000393 # winsock sometimes throws ENOTCONN
Giampaolo Rodolà86909b52010-09-15 21:59:04 +0000394 if why.args[0] in _DISCONNECTED:
Fred Drake526a1822000-09-11 04:00:46 +0000395 self.handle_close()
Guido van Rossumdf4a7432007-07-18 20:57:44 +0000396 return b''
Fred Drake526a1822000-09-11 04:00:46 +0000397 else:
Tim Peters4e0e1b62004-07-07 20:54:48 +0000398 raise
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000399
Guido van Rossumd560ace2002-09-12 04:57:29 +0000400 def close(self):
Giampaolo Rodolà900d5472011-02-11 14:01:46 +0000401 self.connected = False
402 self.accepting = False
403 self.del_channel()
404 try:
405 self.socket.close()
406 except socket.error as why:
407 if why.args[0] not in (ENOTCONN, EBADF):
408 raise
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000409
Fred Drake526a1822000-09-11 04:00:46 +0000410 # cheap inheritance, used to pass all other attribute
411 # references to the underlying socket object.
Guido van Rossumd560ace2002-09-12 04:57:29 +0000412 def __getattr__(self, attr):
Giampaolo Rodolà8d2dc852010-05-06 18:06:30 +0000413 try:
414 retattr = getattr(self.socket, attr)
415 except AttributeError:
416 raise AttributeError("%s instance has no attribute '%s'"
417 %(self.__class__.__name__, attr))
418 else:
Giampaolo Rodolàd61e3972010-05-06 20:02:37 +0000419 msg = "%(me)s.%(attr)s is deprecated; use %(me)s.socket.%(attr)s " \
420 "instead" % {'me' : self.__class__.__name__, 'attr' : attr}
421 warnings.warn(msg, DeprecationWarning, stacklevel=2)
Giampaolo Rodolà8d2dc852010-05-06 18:06:30 +0000422 return retattr
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000423
Andrew M. Kuchlingc07fb2f2003-02-14 01:13:01 +0000424 # log and log_info may be overridden to provide more sophisticated
Fred Drake526a1822000-09-11 04:00:46 +0000425 # logging and warning methods. In general, log is for 'hit' logging
Tim Peters146965a2001-01-14 18:09:23 +0000426 # and 'log_info' is for informational, warning and error logging.
Andrew M. Kuchlingda85a272000-09-08 20:30:39 +0000427
Guido van Rossumd560ace2002-09-12 04:57:29 +0000428 def log(self, message):
429 sys.stderr.write('log: %s\n' % str(message))
Andrew M. Kuchlingda85a272000-09-08 20:30:39 +0000430
Guido van Rossumd560ace2002-09-12 04:57:29 +0000431 def log_info(self, message, type='info'):
R. David Murray78532ba2009-04-12 15:35:44 +0000432 if type not in self.ignore_log_types:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000433 print('%s: %s' % (type, message))
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000434
Guido van Rossumd560ace2002-09-12 04:57:29 +0000435 def handle_read_event(self):
Fred Drake526a1822000-09-11 04:00:46 +0000436 if self.accepting:
Josiah Carlsond74900e2008-07-07 04:15:08 +0000437 # accepting sockets are never connected, they "spawn" new
438 # sockets that are connected
Fred Drake526a1822000-09-11 04:00:46 +0000439 self.handle_accept()
440 elif not self.connected:
Josiah Carlsond74900e2008-07-07 04:15:08 +0000441 self.handle_connect_event()
Fred Drake526a1822000-09-11 04:00:46 +0000442 self.handle_read()
443 else:
444 self.handle_read()
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000445
Josiah Carlsond74900e2008-07-07 04:15:08 +0000446 def handle_connect_event(self):
Giampaolo Rodolà934abdd2010-08-04 09:02:27 +0000447 err = self.socket.getsockopt(socket.SOL_SOCKET, socket.SO_ERROR)
448 if err != 0:
449 raise socket.error(err, _strerror(err))
Josiah Carlsond74900e2008-07-07 04:15:08 +0000450 self.handle_connect()
Giampaolo Rodolà934abdd2010-08-04 09:02:27 +0000451 self.connected = True
Josiah Carlsond74900e2008-07-07 04:15:08 +0000452
Guido van Rossumd560ace2002-09-12 04:57:29 +0000453 def handle_write_event(self):
Josiah Carlsond74900e2008-07-07 04:15:08 +0000454 if self.accepting:
455 # Accepting sockets shouldn't get a write event.
456 # We will pretend it didn't happen.
457 return
458
Fred Drake526a1822000-09-11 04:00:46 +0000459 if not self.connected:
Josiah Carlsond74900e2008-07-07 04:15:08 +0000460 #check for errors
461 err = self.socket.getsockopt(socket.SOL_SOCKET, socket.SO_ERROR)
462 if err != 0:
463 raise socket.error(err, _strerror(err))
464
465 self.handle_connect_event()
Fred Drake526a1822000-09-11 04:00:46 +0000466 self.handle_write()
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000467
Guido van Rossumd560ace2002-09-12 04:57:29 +0000468 def handle_expt_event(self):
R. David Murray78532ba2009-04-12 15:35:44 +0000469 # handle_expt_event() is called if there might be an error on the
470 # socket, or if there is OOB data
471 # check for the error condition first
472 err = self.socket.getsockopt(socket.SOL_SOCKET, socket.SO_ERROR)
473 if err != 0:
474 # we can get here when select.select() says that there is an
475 # exceptional condition on the socket
476 # since there is an error, we'll go ahead and close the socket
477 # like we would in a subclassed handle_read() that received no
478 # data
479 self.handle_close()
Josiah Carlsond74900e2008-07-07 04:15:08 +0000480 else:
481 self.handle_expt()
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000482
Guido van Rossumd560ace2002-09-12 04:57:29 +0000483 def handle_error(self):
Jeremy Hyltona8b5f7d2001-08-10 14:30:35 +0000484 nil, t, v, tbinfo = compact_traceback()
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000485
Fred Drake526a1822000-09-11 04:00:46 +0000486 # sometimes a user repr method will crash.
487 try:
Guido van Rossumd560ace2002-09-12 04:57:29 +0000488 self_repr = repr(self)
Fred Drake526a1822000-09-11 04:00:46 +0000489 except:
Guido van Rossumd560ace2002-09-12 04:57:29 +0000490 self_repr = '<__repr__(self) failed for object at %0x>' % id(self)
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000491
Guido van Rossumd560ace2002-09-12 04:57:29 +0000492 self.log_info(
Fred Drake526a1822000-09-11 04:00:46 +0000493 'uncaptured python exception, closing channel %s (%s:%s %s)' % (
494 self_repr,
495 t,
496 v,
497 tbinfo
498 ),
499 'error'
500 )
Josiah Carlson9f2f8332008-07-07 05:04:12 +0000501 self.handle_close()
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000502
Guido van Rossumd560ace2002-09-12 04:57:29 +0000503 def handle_expt(self):
R. David Murray78532ba2009-04-12 15:35:44 +0000504 self.log_info('unhandled incoming priority event', 'warning')
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000505
Guido van Rossumd560ace2002-09-12 04:57:29 +0000506 def handle_read(self):
507 self.log_info('unhandled read event', 'warning')
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000508
Guido van Rossumd560ace2002-09-12 04:57:29 +0000509 def handle_write(self):
510 self.log_info('unhandled write event', 'warning')
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000511
Guido van Rossumd560ace2002-09-12 04:57:29 +0000512 def handle_connect(self):
513 self.log_info('unhandled connect event', 'warning')
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000514
Guido van Rossumd560ace2002-09-12 04:57:29 +0000515 def handle_accept(self):
Giampaolo Rodolà977c7072010-10-04 21:08:36 +0000516 pair = self.accept()
517 if pair is not None:
518 self.handle_accepted(*pair)
519
520 def handle_accepted(self, sock, addr):
521 sock.close()
522 self.log_info('unhandled accepted event', 'warning')
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000523
Guido van Rossumd560ace2002-09-12 04:57:29 +0000524 def handle_close(self):
525 self.log_info('unhandled close event', 'warning')
Fred Drake526a1822000-09-11 04:00:46 +0000526 self.close()
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000527
528# ---------------------------------------------------------------------------
529# adds simple buffered output capability, useful for simple clients.
530# [for more sophisticated usage use asynchat.async_chat]
531# ---------------------------------------------------------------------------
532
Guido van Rossumd560ace2002-09-12 04:57:29 +0000533class dispatcher_with_send(dispatcher):
534
Andrew M. Kuchling67867ea2004-03-21 20:03:18 +0000535 def __init__(self, sock=None, map=None):
536 dispatcher.__init__(self, sock, map)
Guido van Rossumdf4a7432007-07-18 20:57:44 +0000537 self.out_buffer = b''
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000538
Guido van Rossumd560ace2002-09-12 04:57:29 +0000539 def initiate_send(self):
Fred Drake526a1822000-09-11 04:00:46 +0000540 num_sent = 0
Guido van Rossumd560ace2002-09-12 04:57:29 +0000541 num_sent = dispatcher.send(self, self.out_buffer[:512])
Fred Drake526a1822000-09-11 04:00:46 +0000542 self.out_buffer = self.out_buffer[num_sent:]
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000543
Guido van Rossumd560ace2002-09-12 04:57:29 +0000544 def handle_write(self):
Fred Drake526a1822000-09-11 04:00:46 +0000545 self.initiate_send()
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000546
Guido van Rossumd560ace2002-09-12 04:57:29 +0000547 def writable(self):
Fred Drake526a1822000-09-11 04:00:46 +0000548 return (not self.connected) or len(self.out_buffer)
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000549
Guido van Rossumd560ace2002-09-12 04:57:29 +0000550 def send(self, data):
Giampaolo Rodolà900d5472011-02-11 14:01:46 +0000551 if self.debug:
552 self.log_info('sending %s' % repr(data))
Fred Drake526a1822000-09-11 04:00:46 +0000553 self.out_buffer = self.out_buffer + data
554 self.initiate_send()
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000555
556# ---------------------------------------------------------------------------
557# used for debugging.
558# ---------------------------------------------------------------------------
559
Guido van Rossumd560ace2002-09-12 04:57:29 +0000560def compact_traceback():
Guido van Rossum12e96682002-09-13 14:09:26 +0000561 t, v, tb = sys.exc_info()
Fred Drake526a1822000-09-11 04:00:46 +0000562 tbinfo = []
Josiah Carlsond74900e2008-07-07 04:15:08 +0000563 if not tb: # Must have a traceback
564 raise AssertionError("traceback does not exist")
Guido van Rossum12e96682002-09-13 14:09:26 +0000565 while tb:
Guido van Rossumd560ace2002-09-12 04:57:29 +0000566 tbinfo.append((
Fred Drake526a1822000-09-11 04:00:46 +0000567 tb.tb_frame.f_code.co_filename,
Tim Peters146965a2001-01-14 18:09:23 +0000568 tb.tb_frame.f_code.co_name,
Fred Drake526a1822000-09-11 04:00:46 +0000569 str(tb.tb_lineno)
570 ))
571 tb = tb.tb_next
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000572
Fred Drake526a1822000-09-11 04:00:46 +0000573 # just to be safe
574 del tb
Guido van Rossuma8d0f4f1999-06-08 13:20:05 +0000575
Fred Drake526a1822000-09-11 04:00:46 +0000576 file, function, line = tbinfo[-1]
Guido van Rossum12e96682002-09-13 14:09:26 +0000577 info = ' '.join(['[%s|%s|%s]' % x for x in tbinfo])
Fred Drake526a1822000-09-11 04:00:46 +0000578 return (file, function, line), t, v, info
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000579
Josiah Carlsond74900e2008-07-07 04:15:08 +0000580def close_all(map=None, ignore_all=False):
Fred Drake526a1822000-09-11 04:00:46 +0000581 if map is None:
Guido van Rossumd560ace2002-09-12 04:57:29 +0000582 map = socket_map
Josiah Carlsond74900e2008-07-07 04:15:08 +0000583 for x in list(map.values()):
584 try:
585 x.close()
586 except OSError as x:
Georg Brandlf1123692008-07-20 07:31:30 +0000587 if x.args[0] == EBADF:
Josiah Carlsond74900e2008-07-07 04:15:08 +0000588 pass
589 elif not ignore_all:
590 raise
R. David Murray78532ba2009-04-12 15:35:44 +0000591 except _reraised_exceptions:
Josiah Carlsond74900e2008-07-07 04:15:08 +0000592 raise
593 except:
594 if not ignore_all:
595 raise
Fred Drake526a1822000-09-11 04:00:46 +0000596 map.clear()
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000597
598# Asynchronous File I/O:
599#
600# After a little research (reading man pages on various unixen, and
601# digging through the linux kernel), I've determined that select()
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000602# isn't meant for doing asynchronous file i/o.
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000603# Heartening, though - reading linux/mm/filemap.c shows that linux
604# supports asynchronous read-ahead. So _MOST_ of the time, the data
605# will be sitting in memory for us already when we go to read it.
606#
607# What other OS's (besides NT) support async file i/o? [VMS?]
608#
609# Regardless, this is useful for pipes, and stdin/stdout...
610
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000611if os.name == 'posix':
Fred Drake526a1822000-09-11 04:00:46 +0000612 import fcntl
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000613
Fred Drake526a1822000-09-11 04:00:46 +0000614 class file_wrapper:
Josiah Carlsond74900e2008-07-07 04:15:08 +0000615 # Here we override just enough to make a file
Fred Drake526a1822000-09-11 04:00:46 +0000616 # look like a socket for the purposes of asyncore.
Josiah Carlsond74900e2008-07-07 04:15:08 +0000617 # The passed fd is automatically os.dup()'d
Guido van Rossumd560ace2002-09-12 04:57:29 +0000618
619 def __init__(self, fd):
Josiah Carlsond74900e2008-07-07 04:15:08 +0000620 self.fd = os.dup(fd)
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000621
Guido van Rossumd560ace2002-09-12 04:57:29 +0000622 def recv(self, *args):
Jeremy Hyltonf32e4592002-04-04 21:02:24 +0000623 return os.read(self.fd, *args)
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000624
Guido van Rossumd560ace2002-09-12 04:57:29 +0000625 def send(self, *args):
Jeremy Hyltonf32e4592002-04-04 21:02:24 +0000626 return os.write(self.fd, *args)
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000627
Georg Brandlcbb0ae42010-07-28 08:19:35 +0000628 def getsockopt(self, level, optname, buflen=None):
629 if (level == socket.SOL_SOCKET and
630 optname == socket.SO_ERROR and
631 not buflen):
632 return 0
633 raise NotImplementedError("Only asyncore specific behaviour "
634 "implemented.")
635
Fred Drake526a1822000-09-11 04:00:46 +0000636 read = recv
637 write = send
Andrew M. Kuchlingda85a272000-09-08 20:30:39 +0000638
Guido van Rossumd560ace2002-09-12 04:57:29 +0000639 def close(self):
Andrew M. Kuchlingdfa74b92004-07-10 15:51:19 +0000640 os.close(self.fd)
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000641
Guido van Rossumd560ace2002-09-12 04:57:29 +0000642 def fileno(self):
Fred Drake526a1822000-09-11 04:00:46 +0000643 return self.fd
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000644
Guido van Rossumd560ace2002-09-12 04:57:29 +0000645 class file_dispatcher(dispatcher):
646
Andrew M. Kuchling67867ea2004-03-21 20:03:18 +0000647 def __init__(self, fd, map=None):
648 dispatcher.__init__(self, None, map)
Andrew M. Kuchling68522b12004-03-21 19:46:16 +0000649 self.connected = True
Josiah Carlsond74900e2008-07-07 04:15:08 +0000650 try:
651 fd = fd.fileno()
652 except AttributeError:
653 pass
Andrew M. Kuchlingdfa74b92004-07-10 15:51:19 +0000654 self.set_file(fd)
Fred Drake526a1822000-09-11 04:00:46 +0000655 # set it to non-blocking mode
Guido van Rossumd560ace2002-09-12 04:57:29 +0000656 flags = fcntl.fcntl(fd, fcntl.F_GETFL, 0)
Fred Drakea94414a2001-05-10 15:33:31 +0000657 flags = flags | os.O_NONBLOCK
Guido van Rossumd560ace2002-09-12 04:57:29 +0000658 fcntl.fcntl(fd, fcntl.F_SETFL, flags)
Guido van Rossum0039d7b1999-01-12 20:19:27 +0000659
Guido van Rossumd560ace2002-09-12 04:57:29 +0000660 def set_file(self, fd):
Guido van Rossumd560ace2002-09-12 04:57:29 +0000661 self.socket = file_wrapper(fd)
Josiah Carlsonaae55cb2008-11-19 18:22:41 +0000662 self._fileno = self.socket.fileno()
Fred Drake526a1822000-09-11 04:00:46 +0000663 self.add_channel()