EffectRunner · pyoltra

La referencia de la API está disponible solo en inglés por ahora.

Dispatches per-event effects and bridges sync `emit` to async effects.

Constructor

Initialize self. See help(type(self)) for accurate signature.

signature

new(mode?): None

Initialize self. See help(type(self)) for accurate signature.

Name	Type	Description
`mode`?	`"auto" \| "inline" \| "asyncio"`

None

Name	Type	Description
`queue_depth`	`int`	Number of events whose effects are currently in flight.

Schedule an event's effects and return its `EmitHandle`.

signature

dispatch(run, event_id, committed): EmitHandle

Schedule an event's effects and return its `EmitHandle`.

Name	Type	Description
`run`	`() => any`	A thunk running the event's effects. Sync in `inline` mode; a coroutine function (returning an awaitable) otherwise.

Name	Type	Description
`event_id`	`str`	The event's id.

Name	Type	Description
`committed`	`bool`	Whether the event committed. Uncommitted events run no effects and get an already-settled handle.

EmitHandle — An `EmitHandle` that settles when the effects finish.

Tear down the daemon effect loop, if one was started.

signature

dispose(timeout?): None

Tear down the daemon effect loop, if one was started.

Name	Type	Description
`timeout`?	`float`	Seconds to wait for the worker thread to stop.

None