summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSandro Tosi <sandro.tosi@gmail.com>2012-02-15 22:14:21 (GMT)
committerSandro Tosi <sandro.tosi@gmail.com>2012-02-15 22:14:21 (GMT)
commit5cb522cb32541c5c98df5d4571fef0ecf988cbaa (patch)
treefae30a63ae0114f19b1bc1aff88ae44087f3be0d
parent23357eb4d6becc93728b83c1fed9fe03e100bcfa (diff)
downloadcpython-5cb522cb32541c5c98df5d4571fef0ecf988cbaa.zip
cpython-5cb522cb32541c5c98df5d4571fef0ecf988cbaa.tar.gz
cpython-5cb522cb32541c5c98df5d4571fef0ecf988cbaa.tar.bz2
Issue #11836: document multiprocessing.queues.SimpleQueue
-rw-r--r--Doc/library/multiprocessing.rst19
1 files changed, 18 insertions, 1 deletions
diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst
index ebc41f8..7db2aed 100644
--- a/Doc/library/multiprocessing.rst
+++ b/Doc/library/multiprocessing.rst
@@ -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