]> granicus.if.org Git - python/commitdiff
Issue #11836: document multiprocessing.queues.SimpleQueue
authorSandro Tosi <sandro.tosi@gmail.com>
Wed, 15 Feb 2012 22:14:21 +0000 (23:14 +0100)
committerSandro Tosi <sandro.tosi@gmail.com>
Wed, 15 Feb 2012 22:14:21 +0000 (23:14 +0100)
Doc/library/multiprocessing.rst

index ebc41f8da9bf9543e8cb07ef03e8df91fd84f776..7db2aed1bc71db6f50dbcb0f41604c1776d9e374 100644 (file)
@@ -464,7 +464,7 @@ primitives like locks.
 For passing messages one can use :func:`Pipe` (for a connection between two
 processes) or a queue (which allows multiple producers and consumers).
 
-The :class:`Queue` and :class:`JoinableQueue` types are multi-producer,
+The :class:`Queue`, :class:`multiprocessing.queues.SimpleQueue` and :class:`JoinableQueue` types are multi-producer,
 multi-consumer FIFO queues modelled on the :class:`queue.Queue` class in the
 standard library.  They differ in that :class:`Queue` lacks the
 :meth:`~queue.Queue.task_done` and :meth:`~queue.Queue.join` methods introduced
@@ -610,6 +610,23 @@ For an example of the usage of queues for interprocess communication see
       exits -- see :meth:`join_thread`.
 
 
+.. class:: multiprocessing.queues.SimpleQueue()
+
+   It is a simplified :class:`Queue` type, very close to a locked :class:`Pipe`.
+
+   .. method:: empty()
+
+      Return ``True`` if the queue is empty, ``False`` otherwise.
+
+   .. method:: get()
+
+      Remove and return an item from the queue.
+
+   .. method:: put(item)
+
+      Put *item* into the queue.
+
+
 .. class:: JoinableQueue([maxsize])
 
    :class:`JoinableQueue`, a :class:`Queue` subclass, is a queue which