GitHub

API reference for Worker.

class Worker[O = Any, I = Any]

A spawned worker: send a message, run a handler for its replies. run starts the worker and never returns; it fails when the worker goes away or the handler fails.

Functions

__init__

__init__(*, send, run) -> None
ParameterTypeDescription
sendSendFn
runRunFn
def __init__(self, *, send: SendFn, run: RunFn) -> None:
    self._send = send
    self._run = run

send

send(message, transfers=()) -> Effect[None, WorkerError]
ParameterTypeDescription
messageI
transfersTransfers = ()

Returns Effect[None, WorkerError]

def send(self, message: I, transfers: Transfers = ()) -> Effect[None, WorkerError]:
    return self._send(message, transfers)

run

run[A, E = Never, R = Never](handler, *, on_spawn=None) -> Effect[Never, E | WorkerError, R]

Start the worker and handle each of its messages on a fiber of its own; on_spawn runs once the worker is ready.

ParameterTypeDescription
handlerCallable[[O], Effect[A, E, R]]
on_spawnEffect[None] | None = None

Returns Effect[Never, E | WorkerError, R]

def run[A, E = Never, R = Never](
    self,
    handler: Callable[[O], Effect[A, E, R]],
    *,
    on_spawn: Effect[None] | None = None,
) -> Effect[Never, E | WorkerError, R]:
    """Start the worker and handle each of its messages on a fiber of
    its own; ``on_spawn`` runs once the worker is ready."""
    if on_spawn is not None:
        require_effect(on_spawn, "on_spawn")
    return cast("Effect[Never, E | WorkerError, R]", self._run(handler, on_spawn))