Python Work Queue object.
More...
Public Member Functions |
def | __init__ |
| Create a new work queue.
|
def | activate_fast_abort |
| Turn on or off fast abort functionality for a given queue.
|
def | empty |
| Determine whether there are any known tasks queued, running, or waiting to be collected.
|
def | hungry |
| Determine whether the queue can support more tasks.
|
def | specify_algorithm |
| Set the worker selection algorithm for queue.
|
def | specify_name |
| Change the project name for the given queue.
|
def | specify_priority |
| Change the project priority for the given queue.
|
def | specify_master_mode |
| Specify the master mode for the given queue.
|
def | specify_worker_mode |
| Specify the worker mode for the given queue.
|
def | shutdown_workers |
| Shutdown workers connected to queue.
|
def | submit |
| Submit a task to the queue.
|
def | wait |
| Wait for tasks to complete.
|
Detailed Description
Python Work Queue object.
This class uses a dictionary to map between the task pointer objects and the work_queue::Task.
Constructor & Destructor Documentation
def work_queue::WorkQueue::__init__ |
( |
|
self, |
|
|
|
port = WORK_QUEUE_DEFAULT_PORT , |
|
|
|
name = None , |
|
|
|
catalog = True , |
|
|
|
exclusive = True , |
|
|
|
shutdown = False |
|
) |
| |
Create a new work queue.
- Parameters:
-
self | Reference to the current work queue object. |
port | The port number to listen on. If zero is specified, then the default is chosen, and if -1 is specified, a random port is chosen. |
name | The project name to use. |
catalog | Whether or not to enable catalog mode. |
exclusive | Whether or not the workers should be exclusive. |
shutdown | Automatically shutdown workers when queue is finished. Disabled by default. |
- See also:
- work_queue_create - For more information about environmental variables that affect the behavior this method.
Member Function Documentation
def work_queue::WorkQueue::activate_fast_abort |
( |
|
self, |
|
|
|
multiplier |
|
) |
| |
Turn on or off fast abort functionality for a given queue.
- Parameters:
-
self | Reference to the current work queue object. |
multiplier | The multiplier of the average task time at which point to abort; if negative (the default) fast_abort is deactivated. |
def work_queue::WorkQueue::empty |
( |
|
self | ) |
|
Determine whether there are any known tasks queued, running, or waiting to be collected.
Returns 0 if there are tasks remaining in the system, 1 if the system is "empty".
- Parameters:
-
self | Reference to the current work queue object. |
def work_queue::WorkQueue::hungry |
( |
|
self | ) |
|
Determine whether the queue can support more tasks.
Returns the number of additional tasks it can support if "hungry" and 0 if "sated".
- Parameters:
-
self | Reference to the current work queue object. |
def work_queue::WorkQueue::specify_algorithm |
( |
|
self, |
|
|
|
algorithm |
|
) |
| |
Set the worker selection algorithm for queue.
- Parameters:
-
self | Reference to the current work queue object. |
algorithm | One of the following algorithms to use in assigning a task to a worker:
|
def work_queue::WorkQueue::specify_name |
( |
|
self, |
|
|
|
name |
|
) |
| |
Change the project name for the given queue.
- Parameters:
-
self | Reference to the current work queue object. |
name | The new project name. |
def work_queue::WorkQueue::specify_priority |
( |
|
self, |
|
|
|
priority |
|
) |
| |
Change the project priority for the given queue.
- Parameters:
-
self | Reference to the current work queue object. |
priority | An integer that presents the priorty of this work queue master. The higher the value, the higher the priority. |
def work_queue::WorkQueue::specify_master_mode |
( |
|
self, |
|
|
|
mode |
|
) |
| |
Specify the master mode for the given queue.
- Parameters:
-
def work_queue::WorkQueue::specify_worker_mode |
( |
|
self, |
|
|
|
mode |
|
) |
| |
Specify the worker mode for the given queue.
- Parameters:
-
def work_queue::WorkQueue::shutdown_workers |
( |
|
self, |
|
|
|
n |
|
) |
| |
Shutdown workers connected to queue.
Gives a best effort and then returns the number of workers given the shutdown order.
- Parameters:
-
self | Reference to the current work queue object. |
n | The number to shutdown. To shut down all workers, specify "0". |
def work_queue::WorkQueue::submit |
( |
|
self, |
|
|
|
task |
|
) |
| |
Submit a task to the queue.
It is safe to re-submit a task returned by wait.
- Parameters:
-
self | Reference to the current work queue object. |
task | A task description created from work_queue::Task. |
def work_queue::WorkQueue::wait |
( |
|
self, |
|
|
|
timeout = WORK_QUEUE_WAITFORTASK |
|
) |
| |
Wait for tasks to complete.
This call will block until the timeout has elapsed
- Parameters:
-
self | Reference to the current work queue object. |
timeout | The number of seconds to wait for a completed task before returning. Use an integer to set the timeout or the constant WORK_QUEUE_WAITFORTASK to block until a task has completed. |
The documentation for this class was generated from the following file: