Margrete RPC

discovery

funcdiscovery_dir() -> Path

Return the directory where running plugins write their discovery records.

Uses %LOCALAPPDATA%\MargreteRPC\instances when available, else a temp-dir fallback.

Returns

pathlib.Path
funclist_instances(*, validate=True, timeout=1.0) -> list[MargreteInstance]

List Margrete RPC instances advertised in the discovery directory.

paramvalidatebool
= True

Ping each instance and drop any that do not respond.

paramtimeoutfloat
= 1.0

Per-instance ping timeout in seconds when validating.

Returns

list

The discovered instances (only reachable ones when validate is true).

funcresolve_endpoint(instance_id=None, *, timeout=1.0) -> str

Resolve a connectable host:port endpoint via discovery.

paraminstance_idstr | None
= None

Select a specific instance by id; when None, auto-detect the sole running instance.

paramtimeoutfloat
= 1.0

Per-instance ping timeout in seconds.

Returns

str

The reachable instance's endpoint.

func_load_instance(path) -> MargreteInstance | None
parampathPath

Returns

margrete_rpc.discovery.MargreteInstance | None
func_validated(instance, timeout) -> MargreteInstance | None
paraminstanceMargreteInstance
paramtimeoutfloat

Returns

margrete_rpc.discovery.MargreteInstance | None
func_string(value) -> str | None
paramvalueobject

Returns

str | None
func_int_or_none(value) -> int | None
paramvalueobject

Returns

int | None