fritter.repeat.Async

class documentation

class Async(Generic[AsyncType]): (source)

View In Hierarchy

An Async wraps an AsyncDriver and provides an implementation of repeatedly which:

  1. awaits each result from its async work callable, so that no overlapping work will be performed if an asynchronous operation takes longer than the repetition interval,
  2. returns an awaitable that fires when stopper.cancel() has been called on the stopper provided to that callable, and
  3. provides a .cancel() implementation on that returned awaitable which stops any in-progress async work and raises the appropriate cancellation error for your framework back to the caller.
Method repeatedly Kick off a repeated call within the given scheduler, returning an AsyncType (i.e. Future, Deferred, or similar, as defined by Async.asyncDriver).
Instance Variable asyncDriver The driver that supplies awaitables for this Async to return.
def repeatedly(self, scheduler: Scheduler[WhenT, Callable[[], None], object], rule: RecurrenceRule[WhenT, StepsTInv], work: Callable[[StepsTInv, Cancellable], AsyncType | Coroutine[AsyncType, Any, Any]]) -> AsyncType: (source)

Kick off a repeated call within the given scheduler, returning an AsyncType (i.e. Future, Deferred, or similar, as defined by Async.asyncDriver).

If you call .cancel() on the result of this method, the repetition will be stopped and a cancellation error will be signaled to the caller. If, instead, work calls its .cancel() method, then the result of this method will complete successfully, returning None to a coroutine awaiting it.

asyncDriver: AsyncDriver[AsyncType] = (source)

The driver that supplies awaitables for this Async to return.