Changeset 391 for python/trunk/Doc/library/asynchat.rst

Timestamp:

Mar 19, 2014, 11:31:01 PM (11 years ago)

Author:

dmik

Message:

python: Merge vendor 2.7.6 to trunk.

Location:

python/trunk

Files:

• . (modified) (1 prop)
• Doc/library/asynchat.rst (modified) (9 diffs)

python/trunk/Doc/library/asynchat.rst

@@ -1 @@
-
 :mod:`asynchat` --- Asynchronous socket command/response handler
 ================================================================
@@ -8 +7 @@
 .. sectionauthor:: Steve Holden <sholden@holdenweb.com>
 
+**Source code:** :source:`Lib/asynchat.py`
+
+--------------
 
 This module builds on the :mod:`asyncore` infrastructure, simplifying
@@ -33 +35 @@
    Like :class:`asyncore.dispatcher`, :class:`async_chat` defines a set of
    events that are generated by an analysis of socket conditions after a
-   :cfunc:`select` call. Once the polling loop has been started the
+   :c:func:`select` call. Once the polling loop has been started the
    :class:`async_chat` object's methods are called by the event-processing
    framework with no action on the part of the programmer.
@@ -82 +84 @@
 
 
-.. method:: async_chat._collect_incoming_data(data)
-
-   Sample implementation of a data collection rutine to be used in conjunction
-   with :meth:`_get_data` in a user-specified :meth:`found_terminator`.
-
-
 .. method:: async_chat.discard_buffers()
 
@@ -102 +98 @@
 
 
-.. method:: async_chat._get_data()
-
-   Will return and clear the data received with the sample
-   :meth:`_collect_incoming_data` implementation.
-
-
 .. method:: async_chat.get_terminator()
 
@@ -113 +103 @@
 
 
-.. method:: async_chat.handle_close()
-
-   Called when the channel is closed. The default method silently closes the
-   channel's socket.
-
-
-.. method:: async_chat.handle_read()
-
-   Called when a read event fires on the channel's socket in the asynchronous
-   loop.  The default method checks for the termination condition established
-   by :meth:`set_terminator`, which can be either the appearance of a
-   particular string in the input stream or the receipt of a particular number
-   of characters.  When the terminator is found, :meth:`handle_read` calls the
-   :meth:`found_terminator` method after calling :meth:`collect_incoming_data`
-   with any data preceding the terminating condition.
-
-
-.. method:: async_chat.handle_write()
-
-   Called when the application may write data to the channel.   The default
-   method calls the :meth:`initiate_send` method, which in turn will call
-   :meth:`refill_buffer` to collect data from the producer fifo associated
-   with the channel.
-
-
 .. method:: async_chat.push(data)
 
-   Creates a :class:`simple_producer` object (*see below*) containing the data
-   and pushes it on to the channel's ``producer_fifo`` to ensure its
-   transmission.  This is all you need to do to have the channel write the
-   data out to the network, although it is possible to use your own producers
-   in more complex schemes to implement encryption and chunking, for example.
+   Pushes data on to the channel's fifo to ensure its transmission.
+   This is all you need to do to have the channel write the data out to the
+   network, although it is possible to use your own producers in more complex
+   schemes to implement encryption and chunking, for example.
 
 
@@ -155 +119 @@
 
 
-.. method:: async_chat.readable()
-
-   Should return ``True`` for the channel to be included in the set of
-   channels tested by the :cfunc:`select` loop for readability.
-
-
-.. method:: async_chat.refill_buffer()
-
-   Refills the output buffer by calling the :meth:`more` method of the
-   producer at the head of the fifo.  If it is exhausted then the producer is
-   popped off the fifo and the next producer is activated.  If the current
-   producer is, or becomes, ``None`` then the channel is closed.
-
-
 .. method:: async_chat.set_terminator(term)
 
@@ -193 +143 @@
 
 
-.. method:: async_chat.writable()
-
-   Should return ``True`` as long as items remain on the producer fifo, or the
-   channel is connected and the channel's output buffer is non-empty.
-
-
-asynchat - Auxiliary Classes and Functions
+asynchat - Auxiliary Classes
 ------------------------------------------
 
-
-.. class:: simple_producer(data[, buffer_size=512])
-
-   A :class:`simple_producer` takes a chunk of data and an optional buffer
-   size.  Repeated calls to its :meth:`more` method yield successive chunks of
-   the data no larger than *buffer_size*.
-
-
-   .. method:: more()
-
-      Produces the next chunk of information from the producer, or returns the
-      empty string.
-
-
 .. class:: fifo([list=None])
 
-   Each channel maintains a :class:`fifo` holding data which has been pushed
-   by the application but not yet popped for writing to the channel.  A
-   :class:`fifo` is a list used to hold data and/or producers until they are
-   required.  If the *list* argument is provided then it should contain
-   producers or data items to be written to the channel.
+   A :class:`fifo` holding data which has been pushed by the application but
+   not yet popped for writing to the channel.  A :class:`fifo` is a list used
+   to hold data and/or producers until they are required.  If the *list*
+   argument is provided then it should contain producers or data items to be
+   written to the channel.
 
 
@@ -245 +175 @@
       If the fifo is not empty, returns ``True, first()``, deleting the popped
       item.  Returns ``False, None`` for an empty fifo.
-
-The :mod:`asynchat` module also defines one utility function, which may be of
-use in network and textual analysis operations.
-
-
-.. function:: find_prefix_at_end(haystack, needle)
-
-   Returns ``True`` if string *haystack* ends with any non-empty prefix of
-   string *needle*.