From 5cb522cb32541c5c98df5d4571fef0ecf988cbaa Mon Sep 17 00:00:00 2001 From: Sandro Tosi Date: Wed, 15 Feb 2012 23:14:21 +0100 Subject: Issue #11836: document multiprocessing.queues.SimpleQueue --- Doc/library/multiprocessing.rst | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) 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 -- cgit v0.12