API docs for “elisa.core.utils.cancellable

Queue of cancellable function calls.

One may need to enqueue function calls so that they are called one at a time sequentially. CancellableQueue allows that while giving the possibility to cancel these function calls before they are processed or while they are made if they return elisa.core.utils.cancellable_defer.CancellableDeferred.

Line #	Kind	Name	Docs
85	Method	__init__	Undocumented
98	Method	enqueue	Enqueue a function call that will be called whenever the previously
118	Method	empty	Remove all function call that were enqueued previously. The function
135	Method	_enqueue_request	Undocumented
143	Method	_process_next_request	Undocumented
162	Method	_process_request	Undocumented
167	Method	_current_request_done	Undocumented
173	Method	_current_request_failed	Undocumented

def __init__(self):

overrides elisa.core.log.Loggable.__init__

Undocumented

def enqueue(self, call, *args, **kwargs):

Enqueue a function call that will be called whenever the previously enqueued calls have been processed. Return a cancellable deferred that will allow interaction with the enqueued function call.

Parameters	call	function call to enqueue (type: callable )
	args	positional arguments to be passed to the function (type: tuple of objects )
	kwargs	keyword arguments to be passed to the function (type: dict of the form {str: object} )
Returns	(type: `elisa.core.utils.cancellable_defer.CancellableDeferred` )

def empty(self):

Remove all function call that were enqueued previously. The function call currently being processed is cancelled if it returned a cancellable deferred.

Class e.c.u.c.CancellableQueue(Loggable):