Skip to main content

ChildOptions

Struct ChildOptions 

Source
pub struct ChildOptions {
Show 19 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>>, pub schemas: Vec<String>, pub consent_required: bool, pub revoked: Option<String>,
}
Expand description

How the service reaches its children.

Fields§

§principal: String

The 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: String

The proof’s agent id (spec/00): 1–64 of [A-Za-z0-9._-].

§timeout: Duration

A child’s answer to _info, its schema, and every call’s open.

§max_calls: usize

Calls open on one child at once; past it, too_many_calls.

§buffer: usize

Items 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: Backoff

Restarting (or redialing) a child that died.

§max_depth: usize

NEST-4: how many levels of static children a mount walks (--child-max-depth); a deeper one fails the mount, naming it.

§schema_cache: usize

NEST-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: bool

NEST-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: bool

KEEL-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.

§schemas: Vec<String>

KEEL-32: paths of the service whose schemas the child may read outside any call before its needs are known — what it is grown against at its start (plexus-dyn: a dendrite’s --via-host targets, dyn.peer.<target>). A path at, above or below one of these is answered; any other only as the child’s consented needs allow.

§consent_required: bool

KEEL-32 (R3-1): the mount keeps a consent — nothing the child declares counts as consented until the mount applies it (RemoteChild::set_consent), from the handshake on. false (a plain mount, no consent kept): every declared need counts, as before.

§revoked: Option<String>

KEEL-32 (R3-1): the child is mounted revoked, and why — a remount of a revoked peer is revoked from its first byte, not once it is held.

Implementations§

Source§

impl ChildOptions

Source

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

pub fn seed(&self, c: &Config)

NEST-21: put what these options say above the defaults into c as the flag layer (what a host read from its flags at start), so config.list shows it and a runtime set goes over it.

Source§

impl ChildOptions

Source

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.

Source

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).

Source

pub fn with_schemas<I: IntoIterator<Item = S>, S: Into<String>>( self, paths: I, ) -> Self

KEEL-32: the paths whose schemas the child may read outside any call before its needs are known (ChildOptions::schemas).

KEEL-32 (R3-1): nothing counts as consented until the mount applies its consent (ChildOptions::consent_required).

Source

pub fn with_revoked(self, why: Option<String>) -> Self

KEEL-32 (R3-1): mounted revoked (ChildOptions::revoked).

Source

pub fn with_host(self, service: &DynamicHub) -> Self

Trait Implementations§

Source§

impl Clone for ChildOptions

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ChildOptions

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for ChildOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> MaybeSend for T
where T: Send,

Source§

impl<T> MaybeSendSync for T
where T: Send + Sync,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more