pub struct ChildOptions {Show 16 fields
pub principal: String,
pub key: Option<PathBuf>,
pub agent: String,
pub timeout: Duration,
pub max_calls: usize,
pub buffer: usize,
pub env: Vec<String>,
pub backoff: Backoff,
pub max_depth: usize,
pub schema_cache: usize,
pub host: Option<WeakService>,
pub ping: Option<Duration>,
pub legacy_upcalls: bool,
pub tls_roots: Option<PathBuf>,
pub insecure_ws: bool,
pub tokens: Option<Arc<TokenIssuer>>,
}Expand description
How the service reaches its children.
Fields§
§principal: StringThe hop’s principal (spec/12) on stdio, where no upgrade proves one:
the service naming itself, service:<its namespace>. Over a
WebSocket with a key the principal is that key’s.
key: Option<PathBuf>A key file (synapse’s ~/.plexus/keys/<name>.key: a 32-byte Ed25519
seed, base64, mode 0600): a WebSocket child is dialed with its proof
(spec/00). Read at each dial and never kept, logged or passed on.
agent: StringThe proof’s agent id (spec/00): 1–64 of [A-Za-z0-9._-].
timeout: DurationA child’s answer to _info, its schema, and every call’s open.
max_calls: usizeCalls open on one child at once; past it, too_many_calls.
buffer: usizeItems held for one call whose caller has not read them; past it the child’s reader waits (lossless; the child’s other calls wait too).
env: Vec<String>Variables passed from the service’s environment to a stdio child,
beyond PATH, HOME, LANG and PLEXUS_CHILD_NAME.
backoff: BackoffRestarting (or redialing) a child that died.
max_depth: usizeNEST-4: how many levels of static children a mount walks
(--child-max-depth); a deeper one fails the mount, naming it.
schema_cache: usizeNEST-6: how many dynamic instances’ schemas a mount keeps
(--child-schema-cache), the least recently used out first; 0
keeps none.
host: Option<WeakService>NEST-11: the service the child is mounted in, whose routing and gate
take the calls the child makes back (_host.call). None: the
service a call was routed in when the child was connected (inside a
call), else the service of the first call forwarded to it.
ping: Option<Duration>NEST-12: a WebSocket child is pinged this often, and marked down —
every open call child_unavailable, the next one redialing — when
nothing has come from it for twice as long. None: never pinged.
legacy_upcalls: boolNEST-16: a child whose schema declares no needs may call up, under
a call it serves, anything that call’s caller could (NEST-11’s rule,
--child-legacy-upcalls). Off: such a child has the standard upward
interface alone (host.schema, host.whoami, host.log,
host.notify). Kept for one release, for dendrites built before
needs; a child that declares needs is held to them either way.
tls_roots: Option<PathBuf>DYNAUTH-8: a PEM file of certificate authorities a wss:// child’s
certificate may chain to, beside the webpki roots (a private CA, a
test network’s). Certificates are always validated; nothing turns
that off.
insecure_ws: boolKEEL-7: dial plain ws:// beyond loopback (transport.insecure_ws,
a test network’s). Off: such a child is refused before a socket
opens (check_ws_url); on: dialed, and its mount says
insecure.
tokens: Option<Arc<TokenIssuer>>DYNAUTH-12: the service’s peer-token issuer. With one, every call
forwarded for a signed-in caller carries a token minted for it
(hop.token): aud the child’s proved key (bound to it), or
pipe:<name> for a child on the service’s own pipe; scope the
forwarded grant and the child’s needs (consented), within the call’s
reach. A WebSocket child that proved no key gets none. A keyed child
calling back presents a proof of possession with each call.
Implementations§
Source§impl ChildOptions
impl ChildOptions
Sourcepub fn configured(self, c: &Config) -> Self
pub fn configured(self, c: &Config) -> Self
NEST-21: these options with every child.*, transport.tls_roots
and (KEEL-7) transport.insecure_ws setting c holds above its default (a flag, the file, a runtime
set) put over them. Read at each mount, so a change applies to the
next one.
Source§impl ChildOptions
impl ChildOptions
Sourcepub fn for_service(service: &str) -> Self
pub fn for_service(service: &str) -> Self
The defaults for the service named service: its hop principal
service:<service>, its proof’s agent id service.
Sourcepub fn with_legacy_upcalls(self, on: bool) -> Self
pub fn with_legacy_upcalls(self, on: bool) -> Self
NEST-11: these options, the child mounted in service (see
ChildOptions::host).
NEST-16: NEST-11’s broad rule for a child that declares no needs
(ChildOptions::legacy_upcalls).