GitHub

EncodedRunnerStorage

API reference for EncodedRunnerStorage.

What a runner storage driver implements (Effect's RunnerStorage.Encoded): addresses are host:port, runners their JSON text, shards group:id. acquire gets at least one shard.

Attributes

AttributeTypeDescription
get_runnersEffect[list[tuple[str, bool]], PersistenceError]

Functions

register

register(address, runner, healthy) -> Effect[int, PersistenceError]
ParameterTypeDescription
addressstr
runnerstr
healthybool

Returns Effect[int, PersistenceError]

def register(
    self, address: str, runner: str, healthy: bool, /
) -> Effect[int, PersistenceError]: ...

unregister

unregister(address) -> Effect[None, PersistenceError]
ParameterTypeDescription
addressstr

Returns Effect[None, PersistenceError]

def unregister(self, address: str, /) -> Effect[None, PersistenceError]: ...

set_runner_health

set_runner_health(address, healthy) -> Effect[None, PersistenceError]
ParameterTypeDescription
addressstr
healthybool

Returns Effect[None, PersistenceError]

def set_runner_health(
    self, address: str, healthy: bool, /
) -> Effect[None, PersistenceError]: ...

acquire

acquire(address, shard_ids) -> Effect[list[str], PersistenceError]
ParameterTypeDescription
addressstr
shard_idsSequence[str]

Returns Effect[list[str], PersistenceError]

def acquire(
    self, address: str, shard_ids: Sequence[str], /
) -> Effect[list[str], PersistenceError]: ...

refresh

refresh(address, shard_ids) -> Effect[list[str], PersistenceError]
ParameterTypeDescription
addressstr
shard_idsSequence[str]

Returns Effect[list[str], PersistenceError]

def refresh(
    self, address: str, shard_ids: Sequence[str], /
) -> Effect[list[str], PersistenceError]: ...

release

release(address, shard_id) -> Effect[None, PersistenceError]
ParameterTypeDescription
addressstr
shard_idstr

Returns Effect[None, PersistenceError]

def release(self, address: str, shard_id: str, /) -> Effect[None, PersistenceError]: ...

release_all

release_all(address) -> Effect[None, PersistenceError]
ParameterTypeDescription
addressstr

Returns Effect[None, PersistenceError]

def release_all(self, address: str, /) -> Effect[None, PersistenceError]: ...