canonical.twistedsupport.tests.test_task.LoggingSource : API documentation

Task source that logs calls to start and stop'

def __init__(self, log, stop_deferred=None):

Undocumented

def start(self, consumer):

from canonical.twistedsupport.task.ITaskSource

Start generating tasks.

If start has already been called, then the given 'task_consumer' replaces the existing task accepter.

Parameters task_consumer A provider of ITaskConsumer.

def stop(self):

from canonical.twistedsupport.task.ITaskSource

Stop generating tasks.

It might not be possible to return instantly, so this method should return a Deferred with a boolean that indicates whether ITaskSource.start was called in the meantime.

Any subsequent calls to stop are silently ignored.

Returns A Deferred that will fire when the source is stopped. It is possible that tasks may be produced until this deferred fires. The deferred will fire with a boolean; True if the source is still stopped, False if the source has been restarted since stop() was called.

Method	__init__	Undocumented
Method	start	Start generating tasks.
Method	stop	Stop generating tasks.

c.t.t.t.LoggingSource : class documentation