Rosetta 3.3
Public Member Functions | Public Attributes
parallel::Queue Class Reference

List of all members.

Public Member Functions

def __init__
def task_done
def join
def qsize
def empty
def full
def put
def put_nowait
def get
def get_nowait

Public Attributes

 mutex
 not_empty
 not_full
 all_tasks_done
 unfinished_tasks
 maxsize
 queue

Detailed Description

Create a queue object with a given maximum size.

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

Constructor & Destructor Documentation

def parallel::Queue::__init__ (   self,
  maxsize = 0 
)

Member Function Documentation

def parallel::Queue::empty (   self)
Return True if the queue is empty, False otherwise (not reliable!).
def parallel::Queue::full (   self)
Return True if the queue is full, False otherwise (not reliable!).
def parallel::Queue::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).
def parallel::Queue::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.
def parallel::Queue::join (   self)
Blocks until all items in the Queue have been gotten and processed.

The count of unfinished tasks goes up whenever an item is added to the
queue. The count goes down whenever a consumer thread calls task_done()
to indicate the item was retrieved and all work on it is complete.

When the count of unfinished tasks drops to zero, join() unblocks.
def parallel::Queue::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).
def parallel::Queue::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.
def parallel::Queue::qsize (   self)
Return the approximate size of the queue (not reliable!).
def parallel::Queue::task_done (   self)
Indicate that a formerly enqueued task is complete.

Used by Queue consumer threads.  For each get() used to fetch a task,
a subsequent call to task_done() tells the queue that the processing
on the task is complete.

If a join() is currently blocking, it will resume when all items
have been processed (meaning that a task_done() call was received
for every item that had been put() into the queue).

Raises a ValueError if called more times than there were items
placed in the queue.

Member Data Documentation


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines