pub struct RemoteChild { /* private fields */ }Expand description
An activation in another process (or behind a WebSocket), mounted under
its ChildSpec’s name. Cheap to clone; the child stops when the last
clone is dropped.
Implementations§
Source§impl RemoteChild
impl RemoteChild
Sourcepub async fn connect(
spec: ChildSpec,
opts: ChildOptions,
) -> Result<Self, ChildError>
pub async fn connect( spec: ChildSpec, opts: ChildOptions, ) -> Result<Self, ChildError>
Start (or dial) the child, ask its _info and its schema within
opts.timeout, and keep the connection. Fails naming the child and
why: it did not start, did not answer, or published a schema the
service will not mount.
Sourcepub fn stats(&self) -> ChildStats
pub fn stats(&self) -> ChildStats
What the seam has seen.
Sourcepub fn identity(&self) -> Option<&PeerIdentity>
pub fn identity(&self) -> Option<&PeerIdentity>
DYNAUTH-8 (TM-3): who the child proved it was when it was mounted —
pinned for the life of this mount: a restart (or redial) that proves
another is refused for good (RemoteChild::dead).
Sourcepub fn set_consent(&self, consent: Option<Vec<Consented>>)
pub fn set_consent(&self, consent: Option<Vec<Consented>>)
DYNAUTH-5: hold the child’s calls back to the needs an admin
consented to, each on its scopes (None: no consent kept — every
declared need, as NEST-16 has it). A declared need not consented is
refused forbidden (not_needed), saying so.
Sourcepub fn consent(&self) -> Option<Vec<Consented>>
pub fn consent(&self) -> Option<Vec<Consented>>
DYNAUTH-5: the consent this mount holds its child’s calls back to.
Sourcepub fn revoke(&self, why: &str)
pub fn revoke(&self, why: &str)
DYNAUTH-7: revoke the child: from now no call is forwarded to it (so
no token is minted for it), and every call it is making back ends
with one error item saying why. A token already in its hand lives
out its exp (≤ 60 s) at a peer that verifies without asking.
KEEL-59: and every call open into it ends with one child_unavailable
item, revoked: <why>, the child told to stop each (call_unsub), as
a dialed-in node’s and an in-process peer’s do.
Sourcepub fn stop(&self, why: &str)
pub fn stop(&self, why: &str)
KEEL-59: cut the child off (dyn.disconnect): every call open into
it ends with one child_unavailable item saying why, the child is
told to stop each (call_unsub), every call it is making back under
them ends, and nothing more is forwarded to it. The first why
stands; a revoke after it is still recorded.
Sourcepub fn stopped(&self) -> Option<String>
pub fn stopped(&self) -> Option<String>
KEEL-59: why the child was cut off (RemoteChild::stop,
RemoteChild::revoke), if it was.
Sourcepub fn may_exchange(
&self,
need: &str,
forwarded: &str,
presented: &PeerClaims,
) -> Result<Vec<String>, String>
pub fn may_exchange( &self, need: &str, forwarded: &str, presented: &PeerClaims, ) -> Result<Vec<String>, String>
KEEL-19: may this child, presenting presented (a token minted for a
call into it), have it exchanged for one that reaches need — a path
of its service (dyn.peer.b.forecast), presented to the audience as
forwarded (the method in the audience’s own terms)? Decided by the
one function its calls back are decided by (Upcalls::decide):
not revoked, need declared and consented, and held by the token.
Answers the exchanged token’s scope: forwarded on each scope both
the token holds need’s grant on and the consent holds.
Sourcepub fn peer_key(&self) -> Option<&str>
pub fn peer_key(&self) -> Option<&str>
DYNAUTH-5: the Ed25519 key the child proved at its mount
(key:<hex>), if it proved one; pinned with Self::identity.
Sourcepub fn dead(&self) -> Option<String>
pub fn dead(&self) -> Option<String>
NEST-12: why the child will never be mounted again under this
mount, if it will not — a restart published another schema
("schema changed; restart the service"): a fresh
RemoteChild::connect mounts the new one.
Sourcepub fn why_down(&self) -> Option<String>
pub fn why_down(&self) -> Option<String>
NEST-12: why the child is down, when it is — its last connection’s
end, the last start that failed, or why it will never be mounted
again; None while it is up.
Sourcepub async fn up(&self) -> Result<(), String>
pub async fn up(&self) -> Result<(), String>
NEST-12: bring the child up now if it is down — start (or redial) it
within its Backoff, as the next call would. Err: why it is not
up (and RemoteChild::dead says whether it never will be).
Sourcepub fn needs(&self) -> Option<&[Need]>
pub fn needs(&self) -> Option<&[Need]>
NEST-16: what the child’s schema says it needs of the service it is
mounted in (None: it declares nothing).
Sourcepub fn calls_open_back(&self) -> usize
pub fn calls_open_back(&self) -> usize
NEST-11: forwarded calls open now that the child may call back under.
Sourcepub fn mounted_hash(&self) -> &str
pub fn mounted_hash(&self) -> &str
The schema hash this mount took, as the child published it (its whole tree’s, NEST-4).
Sourcepub fn insecure(&self) -> bool
pub fn insecure(&self) -> bool
KEEL-7: whether the mount is plain ws:// beyond loopback — dialed
only because transport.insecure_ws allowed it, every hop and proof
on it in clear. Said wherever the mount is listed.
Sourcepub fn principal(&self) -> &str
pub fn principal(&self) -> &str
The hop’s principal: the service acting, as this child is told.
Sourcepub fn mount_timings(&self) -> MountTimings
pub fn mount_timings(&self) -> MountTimings
How long the mount took.
Trait Implementations§
Source§impl Activation for RemoteChild
impl Activation for RemoteChild
Source§fn into_rpc_methods(self) -> Methods
fn into_rpc_methods(self) -> Methods
Nothing of its own on the socket: a child is reached through the
service’s {service}.call, behind its gate.
Source§fn static_child_schemas(&self) -> Vec<(String, PluginSchema)>
fn static_child_schemas(&self) -> Vec<(String, PluginSchema)>
NEST-4: the kept tree — the host gates, lists and describes a mounted
child’s children by their whole path, as it does an in-process
child’s (MACRO-20, super::children).
type Methods = ChildMethods
Source§fn needs(&self) -> Option<Vec<Need>>
fn needs(&self) -> Option<Vec<Need>>
needs, answered without building the schema
(#[plexus_macros::activation(parent = …)] emits it). None: it
declares nothing.fn namespace(&self) -> &str
fn version(&self) -> &str
Source§fn description(&self) -> &str
fn description(&self) -> &str
Source§fn long_description(&self) -> Option<&str>
fn long_description(&self) -> Option<&str>
fn methods(&self) -> Vec<&str>
fn method_help(&self, method: &str) -> Option<String>
fn call<'life0, 'life1, 'life2, 'life3, 'async_trait>(
&'life0 self,
method: &'life1 str,
params: Value,
auth: Option<&'life2 AuthContext>,
_raw: Option<&'life3 RawRequestContext>,
) -> Pin<Box<dyn Future<Output = Result<PlexusStream, PlexusError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
'life3: 'async_trait,
Source§fn plugin_schema(&self) -> PluginSchema
fn plugin_schema(&self) -> PluginSchema
Source§fn plugin_id(&self) -> Uuid
fn plugin_id(&self) -> Uuid
fn resolve_handle<'life0, 'life1, 'async_trait>(
&'life0 self,
_handle: &'life1 Handle,
) -> Pin<Box<dyn Future<Output = Result<PlexusStream, PlexusError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Source§fn slot_schema() -> Option<PluginSchema>where
Self: Sized,
fn slot_schema() -> Option<PluginSchema>where
Self: Sized,
#[child] publishes as its slot’s type
(MethodRole::DynamicChild { child }). None (the default) for an
activation the macro did not write; #[plexus_macros::activation]
emits it (its static namespace, version, description, methods and
roles).Source§impl ChildRouter for RemoteChild
impl ChildRouter for RemoteChild
Source§fn router_namespace(&self) -> &str
fn router_namespace(&self) -> &str
Source§fn router_call<'life0, 'life1, 'life2, 'life3, 'async_trait>(
&'life0 self,
method: &'life1 str,
params: Value,
auth: Option<&'life2 AuthContext>,
raw: Option<&'life3 RawRequestContext>,
) -> Pin<Box<dyn Future<Output = Result<PlexusStream, PlexusError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
'life3: 'async_trait,
fn router_call<'life0, 'life1, 'life2, 'life3, 'async_trait>(
&'life0 self,
method: &'life1 str,
params: Value,
auth: Option<&'life2 AuthContext>,
raw: Option<&'life3 RawRequestContext>,
) -> Pin<Box<dyn Future<Output = Result<PlexusStream, PlexusError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
'life3: 'async_trait,
Source§fn get_child<'life0, 'life1, 'async_trait>(
&'life0 self,
_name: &'life1 str,
) -> Pin<Box<dyn Future<Output = Option<Box<dyn ChildRouter>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn get_child<'life0, 'life1, 'async_trait>(
&'life0 self,
_name: &'life1 str,
) -> Pin<Box<dyn Future<Output = Option<Box<dyn ChildRouter>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Source§fn router_schema(&self) -> Option<PluginSchema>
fn router_schema(&self) -> Option<PluginSchema>
Source§fn router_static_child_schemas(&self) -> Vec<(String, PluginSchema)>
fn router_static_child_schemas(&self) -> Vec<(String, PluginSchema)>
(path, schema) — path relative to this router, dotted for a
grandchild ("commits", "commits.audit"), schema the child’s own
(its methods’ grants and its roles relative to it, as its macro
wrote them). Read moreSource§fn peer_child<'life0, 'life1, 'async_trait>(
&'life0 self,
name: &'life1 str,
) -> Pin<Box<dyn Future<Output = Result<Option<Box<dyn ChildRouter>>, PeerError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn peer_child<'life0, 'life1, 'async_trait>(
&'life0 self,
name: &'life1 str,
) -> Pin<Box<dyn Future<Output = Result<Option<Box<dyn ChildRouter>>, PeerError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
name, or why a peer could not be
returned — what routing asks, so a caller gets a typed error item
(not_grafted, unavailable, shape_mismatch, …), never “not
found”, for a peer that failed. Default: Self::get_child, which
cannot fail. #[plexus_macros::activation] overrides it for an
activation with a #[plexus_macros::peer] slot.Source§fn capabilities(&self) -> ChildCapabilities
fn capabilities(&self) -> ChildCapabilities
Source§fn list_children<'life0, 'async_trait>(
&'life0 self,
) -> Pin<Box<dyn Future<Output = Option<BoxStream<'_, String>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn list_children<'life0, 'async_trait>(
&'life0 self,
) -> Pin<Box<dyn Future<Output = Option<BoxStream<'_, String>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Source§fn search_children<'life0, 'life1, 'async_trait>(
&'life0 self,
_query: &'life1 str,
) -> Pin<Box<dyn Future<Output = Option<BoxStream<'_, String>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn search_children<'life0, 'life1, 'async_trait>(
&'life0 self,
_query: &'life1 str,
) -> Pin<Box<dyn Future<Output = Option<BoxStream<'_, String>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Source§fn forward_policy_for(&self, _callee_ns: &str) -> Option<Arc<dyn ForwardPolicy>>
fn forward_policy_for(&self, _callee_ns: &str) -> Option<Arc<dyn ForwardPolicy>>
Source§fn framework_stamped_principal(&self) -> Principal
fn framework_stamped_principal(&self) -> Principal
plexus_auth_core::Principal of
this router. Read moreSource§impl Clone for RemoteChild
impl Clone for RemoteChild
Auto Trait Implementations§
impl !RefUnwindSafe for RemoteChild
impl !UnwindSafe for RemoteChild
impl Forget for RemoteChild
impl Freeze for RemoteChild
impl Move for RemoteChild
impl Send for RemoteChild
impl Sync for RemoteChild
impl Unpin for RemoteChild
impl UnsafeUnpin for RemoteChild
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
impl<T> MaybeSend for Twhere
T: Send,
impl<T> MaybeSendSync for T
Source§impl<T> Peer for Twhere
T: Activation + ChildRouter,
impl<T> Peer for Twhere
T: Activation + ChildRouter,
Source§fn call<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
method: &'life1 str,
params: Value,
auth: Option<&'life2 AuthContext>,
) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = PlexusStreamItem> + Send>>, PlexusError>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
T: 'async_trait,
fn call<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
method: &'life1 str,
params: Value,
auth: Option<&'life2 AuthContext>,
) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = PlexusStreamItem> + Send>>, PlexusError>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
T: 'async_trait,
repos, or a path below it: child.m).