c.t.t.ITaskConsumer(Interface) : interface documentation

Part of canonical.twistedsupport.task View In Hierarchy

Known implementations: canonical.twistedsupport.task.ParallelLimitedTaskConsumer, canonical.twistedsupport.tests.test_task.NoopTaskConsumer

A consumer of tasks.

Pass this to the 'start' method of an ITaskSource provider.

Note that implementations of ITaskConsumer need to provide their own way of getting references to ITaskSources.

Method taskStarted Called when the task source generates a task.
Method noTasksFound Called when no tasks were found.
Method taskProductionFailed Called when the task source fails to produce a task.
def taskStarted(task):
Called when the task source generates a task.

This is a throw-it-over-the-wall interface used by ITaskSource. ITaskSource expects it to finish quickly and to not raise errors. Any return value is completely ignored.

ParameterstaskThe interface for this is defined by the task source.
def noTasksFound():
Called when no tasks were found.
def taskProductionFailed(reason):
Called when the task source fails to produce a task.
ParametersreasonA twisted.python.failure.Failure object.
API Documentation for Launchpad, generated by pydoctor at 2010-03-21 00:00:03.