work_queue.WorkQueue Class Reference

Python Work Queue object. More...

Inheritance diagram for work_queue.WorkQueue:

Public Member Functions
def	__init__
	Create a new work queue. More...
def	activate_fast_abort (self, multiplier)
	Turn on or off fast abort functionality for a given queue. More...
def	empty (self)
	Determine whether there are any known tasks queued, running, or waiting to be collected. More...
def	hungry (self)
	Determine whether the queue can support more tasks. More...
def	specify_algorithm (self, algorithm)
	Set the worker selection algorithm for queue. More...
def	specify_name (self, name)
	Change the project name for the given queue. More...
def	specify_priority (self, priority)
	Change the project priority for the given queue. More...
def	specify_master_mode (self, mode)
	Specify the master mode for the given queue. More...
def	specify_worker_mode (self, mode)
	Specify the worker mode for the given queue. More...
def	shutdown_workers (self, n)
	Shutdown workers connected to queue. More...
def	submit (self, task)
	Submit a task to the queue. More...
def	wait
	Wait for tasks to complete. More...

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.

References work_queue.WorkQueue._shutdown, work_queue.WorkQueue._stats, work_queue.WorkQueue._task_table, work_queue.WorkQueue._work_queue, work_queue.WorkQueue.shutdown_workers(), work_queue_create(), work_queue_delete(), work_queue_get_stats(), work_queue_name(), work_queue_port(), work_queue_specify_master_mode(), work_queue_specify_name(), and work_queue_specify_worker_mode().

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.

References work_queue.WorkQueue._work_queue, and work_queue_activate_fast_abort().

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.

References work_queue.WorkQueue._work_queue, and work_queue_empty().

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.

References work_queue.WorkQueue._work_queue, and work_queue_hungry().

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: WORK_QUEUE_SCHEDULE_FCFS WORK_QUEUE_SCHEDULE_FILES WORK_QUEUE_SCHEDULE_TIME WORK_QUEUE_SCHEDULE_DEFAULT WORK_QUEUE_SCHEDULE_PREFERRED_HOSTS WORK_QUEUE_SCHEDULE_RAND

References work_queue.WorkQueue._work_queue, and work_queue_specify_algorithm().

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.

References work_queue.WorkQueue._work_queue, and work_queue_specify_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.

References work_queue.WorkQueue._work_queue, and work_queue_specify_priority().

def work_queue.WorkQueue.specify_master_mode	(		self,
			mode
	)

Specify the master mode for the given queue.

Parameters

self	Reference to the current work queue object.
mode	This may be one of the following values: WORK_QUEUE_MASTER_MODE_STANDALONE or WORK_QUEUE_MASTER_MODE_CATALOG.

References work_queue.WorkQueue._work_queue, and work_queue_specify_master_mode().

def work_queue.WorkQueue.specify_worker_mode	(		self,
			mode
	)

Specify the worker mode for the given queue.

Parameters

self	Reference to the current work queue object.
mode	This may be one of the following values: WORK_QUEUE_WORKER_MODE_SHARED or WORK_QUEUE_WORKER_MODE_EXCLUSIVE.

References work_queue.WorkQueue._work_queue, and work_queue_specify_worker_mode().

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".

References work_queue.WorkQueue._work_queue, and work_queue_shut_down_workers().

Referenced by work_queue.WorkQueue.__init__().

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.

References work_queue.WorkQueue._task_table, work_queue.WorkQueue._work_queue, and work_queue_submit().

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.

References work_queue.WorkQueue._task_table, work_queue.WorkQueue._work_queue, and work_queue_wait().

---

The documentation for this class was generated from the following file:

• work_queue.binding.py