diff options
author | Sandro Tosi <sandro.tosi@gmail.com> | 2012-02-15 21:39:52 (GMT) |
---|---|---|
committer | Sandro Tosi <sandro.tosi@gmail.com> | 2012-02-15 21:39:52 (GMT) |
commit | c0b1172459bbc0ca507f6d21809cc421e0800145 (patch) | |
tree | 584d64535b24e2bbe0a8bf78c92a3c9075b1c7f4 /Doc | |
parent | dd7e071b23e7f4b33767653b3feea0ffb2bfa6b9 (diff) | |
download | cpython-c0b1172459bbc0ca507f6d21809cc421e0800145.zip cpython-c0b1172459bbc0ca507f6d21809cc421e0800145.tar.gz cpython-c0b1172459bbc0ca507f6d21809cc421e0800145.tar.bz2 |
Issue #11836: document multiprocessing.queues.SimpleQueue
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/library/multiprocessing.rst | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst index c0f394b..7d9aaf3 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 |