asyncore.rst 13.3 KB
Newer Older
1 2 3 4
:mod:`asyncore` --- Asynchronous socket handler
===============================================

.. module:: asyncore
5 6
   :synopsis: A base class for developing asynchronous socket handling
              services.
7

8 9 10
.. moduleauthor:: Sam Rushing <rushing@nightmare.com>
.. sectionauthor:: Christopher Petrilli <petrilli@amber.org>
.. sectionauthor:: Steve Holden <sholden@holdenweb.com>
11
.. heavily adapted from original documentation by Sam Rushing
12

13 14
**Source code:** :source:`Lib/asyncore.py`

15 16 17
.. deprecated:: 3.6
   Please use :mod:`asyncio` instead.

18
--------------
19

20 21 22 23
.. note::

   This module exists for backwards compatibility only.  For new code we
   recommend using :mod:`asyncio`.
24

25 26 27 28 29
This module provides the basic infrastructure for writing asynchronous  socket
service clients and servers.

There are only two ways to have a program on a single processor do  "more than
one thing at a time." Multi-threaded programming is the  simplest and most
30
popular way to do it, but there is another very different technique, that lets
31 32
you have nearly all the advantages of  multi-threading, without actually using
multiple threads.  It's really  only practical if your program is largely I/O
33 34 35
bound.  If your program is processor bound, then pre-emptive scheduled threads
are probably what you really need.  Network servers are rarely processor
bound, however.
36

37
If your operating system supports the :c:func:`select` system call in its I/O
38
library (and nearly all do), then you can use it to juggle multiple
39 40 41 42 43 44 45 46 47 48 49 50 51 52
communication channels at once; doing other work while your I/O is taking
place in the "background."  Although this strategy can seem strange and
complex, especially at first, it is in many ways easier to understand and
control than multi-threaded programming.  The :mod:`asyncore` module solves
many of the difficult problems for you, making the task of building
sophisticated high-performance network servers and clients a snap.  For
"conversational" applications and protocols the companion :mod:`asynchat`
module is invaluable.

The basic idea behind both modules is to create one or more network
*channels*, instances of class :class:`asyncore.dispatcher` and
:class:`asynchat.async_chat`.  Creating the channels adds them to a global
map, used by the :func:`loop` function if you do not provide it with your own
*map*.
53 54

Once the initial channel(s) is(are) created, calling the :func:`loop` function
55 56
activates channel service, which continues until the last channel (including
any that have been added to the map during asynchronous service) is closed.
57 58 59 60


.. function:: loop([timeout[, use_poll[, map[,count]]]])

61 62
   Enter a polling loop that terminates after count passes or all open
   channels have been closed.  All arguments are optional.  The *count*
63
   parameter defaults to ``None``, resulting in the loop terminating only when all
64
   channels have been closed.  The *timeout* argument sets the timeout
65 66 67 68
   parameter for the appropriate :func:`~select.select` or :func:`~select.poll`
   call, measured in seconds; the default is 30 seconds.  The *use_poll*
   parameter, if true, indicates that :func:`~select.poll` should be used in
   preference to :func:`~select.select` (the default is ``False``).
69

70 71 72 73 74
   The *map* parameter is a dictionary whose items are the channels to watch.
   As channels are closed they are deleted from their map.  If *map* is
   omitted, a global map is used. Channels (instances of
   :class:`asyncore.dispatcher`, :class:`asynchat.async_chat` and subclasses
   thereof) can freely be mixed in the map.
75 76 77 78 79


.. class:: dispatcher()

   The :class:`dispatcher` class is a thin wrapper around a low-level socket
80 81 82 83 84 85 86 87 88 89 90
   object. To make it more useful, it has a few methods for event-handling
   which are called from the asynchronous loop.   Otherwise, it can be treated
   as a normal non-blocking socket object.

   The firing of low-level events at certain times or in certain connection
   states tells the asynchronous loop that certain higher-level events have
   taken place.  For example, if we have asked for a socket to connect to
   another host, we know that the connection has been made when the socket
   becomes writable for the first time (at this point you know that you may
   write to it with the expectation of success).  The implied higher-level
   events are:
91 92 93 94

   +----------------------+----------------------------------------+
   | Event                | Description                            |
   +======================+========================================+
95 96
   | ``handle_connect()`` | Implied by the first read or write     |
   |                      | event                                  |
97 98 99 100
   +----------------------+----------------------------------------+
   | ``handle_close()``   | Implied by a read event with no data   |
   |                      | available                              |
   +----------------------+----------------------------------------+
101
   | ``handle_accepted()``| Implied by a read event on a listening |
102 103 104 105 106
   |                      | socket                                 |
   +----------------------+----------------------------------------+

   During asynchronous processing, each mapped channel's :meth:`readable` and
   :meth:`writable` methods are used to determine whether the channel's socket
107 108
   should be added to the list of channels :c:func:`select`\ ed or
   :c:func:`poll`\ ed for read and write events.
109

110 111
   Thus, the set of channel events is larger than the basic socket events.  The
   full set of methods that can be overridden in your subclass follows:
112 113


114
   .. method:: handle_read()
115

116 117
      Called when the asynchronous loop detects that a :meth:`read` call on the
      channel's socket will succeed.
118 119


120
   .. method:: handle_write()
121

122 123 124
      Called when the asynchronous loop detects that a writable socket can be
      written.  Often this method will implement the necessary buffering for
      performance.  For example::
125

126 127 128
         def handle_write(self):
             sent = self.send(self.buffer)
             self.buffer = self.buffer[sent:]
129 130


131
   .. method:: handle_expt()
132

133 134
      Called when there is out of band (OOB) data for a socket connection.  This
      will almost never happen, as OOB is tenuously supported and rarely used.
135 136


137
   .. method:: handle_connect()
138

139 140 141
      Called when the active opener's socket actually makes a connection.  Might
      send a "welcome" banner, or initiate a protocol negotiation with the
      remote endpoint, for example.
142 143


144
   .. method:: handle_close()
145

146
      Called when the socket is closed.
147 148


149
   .. method:: handle_error()
150

151 152
      Called when an exception is raised and not otherwise handled.  The default
      version prints a condensed traceback.
153 154


155
   .. method:: handle_accept()
156

157 158
      Called on listening channels (passive openers) when a connection can be
      established with a new remote endpoint that has issued a :meth:`connect`
159 160
      call for the local endpoint. Deprecated in version 3.2; use
      :meth:`handle_accepted` instead.
161

162 163
      .. deprecated:: 3.2

164 165 166 167 168

   .. method:: handle_accepted(sock, addr)

      Called on listening channels (passive openers) when a connection has been
      established with a new remote endpoint that has issued a :meth:`connect`
169 170
      call for the local endpoint.  *sock* is a *new* socket object usable to
      send and receive data on the connection, and *addr* is the address
171 172
      bound to the socket on the other end of the connection.

173 174
      .. versionadded:: 3.2

175

176
   .. method:: readable()
177

178 179 180 181
      Called each time around the asynchronous loop to determine whether a
      channel's socket should be added to the list on which read events can
      occur.  The default method simply returns ``True``, indicating that by
      default, all channels will be interested in read events.
182 183


184
   .. method:: writable()
185

186 187 188 189
      Called each time around the asynchronous loop to determine whether a
      channel's socket should be added to the list on which write events can
      occur.  The default method simply returns ``True``, indicating that by
      default, all channels will be interested in write events.
190 191


192 193
   In addition, each channel delegates or extends many of the socket methods.
   Most of these are nearly identical to their socket partners.
194 195


196
   .. method:: create_socket(family=socket.AF_INET, type=socket.SOCK_STREAM)
197

198 199 200
      This is identical to the creation of a normal socket, and will use the
      same options for creation.  Refer to the :mod:`socket` documentation for
      information on creating sockets.
201

Georg Brandl's avatar
Georg Brandl committed
202 203
      .. versionchanged:: 3.3
         *family* and *type* arguments can be omitted.
204

205

206
   .. method:: connect(address)
207

208 209
      As with the normal socket object, *address* is a tuple with the first
      element the host to connect to, and the second the port number.
210 211


212
   .. method:: send(data)
213

214
      Send *data* to the remote end-point of the socket.
215 216


217
   .. method:: recv(buffer_size)
218

219
      Read at most *buffer_size* bytes from the socket's remote end-point.  An
220 221
      empty bytes object implies that the channel has been closed from the
      other end.
222

223 224 225 226
      Note that :meth:`recv` may raise :exc:`BlockingIOError` , even though
      :func:`select.select` or :func:`select.poll` has reported the socket
      ready for reading.

227

228
   .. method:: listen(backlog)
229

230 231 232
      Listen for connections made to the socket.  The *backlog* argument
      specifies the maximum number of queued connections and should be at least
      1; the maximum value is system-dependent (usually 5).
233 234


235
   .. method:: bind(address)
236

237
      Bind the socket to *address*.  The socket must not already be bound.  (The
Benjamin Peterson's avatar
Benjamin Peterson committed
238 239
      format of *address* depends on the address family --- refer to the
      :mod:`socket` documentation for more information.)  To mark
240 241
      the socket as re-usable (setting the :const:`SO_REUSEADDR` option), call
      the :class:`dispatcher` object's :meth:`set_reuse_addr` method.
242 243


244
   .. method:: accept()
245

246
      Accept a connection.  The socket must be bound to an address and listening
247 248 249 250 251 252 253
      for connections.  The return value can be either ``None`` or a pair
      ``(conn, address)`` where *conn* is a *new* socket object usable to send
      and receive data on the connection, and *address* is the address bound to
      the socket on the other end of the connection.
      When ``None`` is returned it means the connection didn't take place, in
      which case the server should just ignore this event and keep listening
      for further incoming connections.
254 255


256 257 258 259 260 261
   .. method:: close()

      Close the socket.  All future operations on the socket object will fail.
      The remote end-point will receive no more data (after queued data is
      flushed).  Sockets are automatically closed when they are
      garbage-collected.
262

263 264 265 266 267 268 269

.. class:: dispatcher_with_send()

   A :class:`dispatcher` subclass which adds simple buffered output capability,
   useful for simple clients. For more sophisticated usage use
   :class:`asynchat.async_chat`.

270 271
.. class:: file_dispatcher()

272
   A file_dispatcher takes a file descriptor or :term:`file object` along
273 274 275
   with an optional map argument and wraps it for use with the :c:func:`poll`
   or :c:func:`loop` functions.  If provided a file object or anything with a
   :c:func:`fileno` method, that method will be called and passed to the
276 277 278
   :class:`file_wrapper` constructor.

   .. availability:: Unix.
279 280 281 282 283 284

.. class:: file_wrapper()

   A file_wrapper takes an integer file descriptor and calls :func:`os.dup` to
   duplicate the handle so that the original handle may be closed independently
   of the file_wrapper.  This class implements sufficient methods to emulate a
285 286 287
   socket for use by the :class:`file_dispatcher` class.

   .. availability:: Unix.
288

289

290
.. _asyncore-example-1:
291 292 293 294 295 296 297

asyncore Example basic HTTP client
----------------------------------

Here is a very basic HTTP client that uses the :class:`dispatcher` class to
implement its socket handling::

298
   import asyncore
299

300
   class HTTPClient(asyncore.dispatcher):
301 302 303

       def __init__(self, host, path):
           asyncore.dispatcher.__init__(self)
304
           self.create_socket()
305
           self.connect( (host, 80) )
306 307
           self.buffer = bytes('GET %s HTTP/1.0\r\nHost: %s\r\n\r\n' %
                               (path, host), 'ascii')
308 309 310 311 312 313 314 315

       def handle_connect(self):
           pass

       def handle_close(self):
           self.close()

       def handle_read(self):
316
           print(self.recv(8192))
317 318 319 320 321 322 323 324 325

       def writable(self):
           return (len(self.buffer) > 0)

       def handle_write(self):
           sent = self.send(self.buffer)
           self.buffer = self.buffer[sent:]


326 327
   client = HTTPClient('www.python.org', '/')
   asyncore.loop()
328 329 330 331 332 333

.. _asyncore-example-2:

asyncore Example basic echo server
----------------------------------

334
Here is a basic echo server that uses the :class:`dispatcher` class to accept
335 336 337 338 339 340 341 342
connections and dispatches the incoming connections to a handler::

    import asyncore

    class EchoHandler(asyncore.dispatcher_with_send):

        def handle_read(self):
            data = self.recv(8192)
343 344
            if data:
                self.send(data)
345 346 347 348 349

    class EchoServer(asyncore.dispatcher):

        def __init__(self, host, port):
            asyncore.dispatcher.__init__(self)
350
            self.create_socket()
351 352 353 354 355 356 357 358 359 360
            self.set_reuse_addr()
            self.bind((host, port))
            self.listen(5)

        def handle_accepted(self, sock, addr):
            print('Incoming connection from %s' % repr(addr))
            handler = EchoHandler(sock)

    server = EchoServer('localhost', 8080)
    asyncore.loop()