Queue.Queue

Module Queue :: Class Queue

[show private | hide private]

Class Queue

Known Subclasses:: DbConnectionPool

Method Summary
	`__init__(self, maxsize)` Initialize a queue object with a given maximum size.
	`empty(self)` Return True if the queue is empty, False otherwise (not reliable!).
	`full(self)` Return True if the queue is full, False otherwise (not reliable!).
	`get(self, block, timeout)` Remove and return an item from the queue.
	`get_nowait(self)` Remove and return an item from the queue without blocking.
	`put(self, item, block, timeout)` Put an item into the queue.
	`put_nowait(self, item)` Put an item into the queue without blocking.
	`qsize(self)` Return the approximate size of the queue (not reliable!).

Method Details

init(self, maxsize=0)
(Constructor)

Initialize a queue object with a given maximum size.

If maxsize is <= 0, the queue size is infinite.

empty(self)

Return True if the queue is empty, False otherwise (not reliable!).

full(self)

Return True if the queue is full, False otherwise (not reliable!).

get(self, block=True, timeout=None)

Remove and return an item from the queue.

If optional args 'block' is true and 'timeout' is None (the default), block if necessary until an item is available. If 'timeout' is a positive number, it blocks at most 'timeout' seconds and raises the Empty exception if no item was available within that time. Otherwise ('block' is false), return an item if one is immediately available, else raise the Empty exception ('timeout' is ignored in that case).

get_nowait(self)

Remove and return an item from the queue without blocking.

Only get an item if one is immediately available. Otherwise raise the Empty exception.

put(self, item, block=True, timeout=None)

Put an item into the queue.

If optional args 'block' is true and 'timeout' is None (the default), block if necessary until a free slot is available. If 'timeout' is a positive number, it blocks at most 'timeout' seconds and raises the Full exception if no free slot was available within that time. Otherwise ('block' is false), put an item on the queue if a free slot is immediately available, else raise the Full exception ('timeout' is ignored in that case).

put_nowait(self, item)

Put an item into the queue without blocking.

Only enqueue the item if a free slot is immediately available. Otherwise raise the Full exception.

qsize(self)

Return the approximate size of the queue (not reliable!).

Generated by Epydoc 2.1 on Thu Aug 16 09:55:07 2007

http://epydoc.sf.net