Struct capnp_rpc::RpcSystem

pub struct RpcSystem<VatId>
where
    VatId: 'static,
{ /* private fields */ }

A portal to objects available on the network.

The RPC implemententation sits on top of an implementation of VatNetwork, which determines how to form connections between vats. The RPC implementation determines how to use such connections to manage object references and make method calls.

At the moment, this is all rather more general than it needs to be, because the only implementation of VatNetwork is twoparty::VatNetwork. However, eventually we will need to have more sophisticated VatNetwork implementations, in order to support level 3 features.

An RpcSystem is a non-Sendable Future and needs to be driven by a task executor. A common way accomplish that is to pass the RpcSystem to tokio::task::spawn_local().

Implementations

impl<VatId> RpcSystem<VatId>

pub fn new( network: Box<dyn VatNetwork<VatId>>, bootstrap: Option<Client> ) -> Self

Constructs a new RpcSystem with the given network and bootstrap capability.

pub fn bootstrap<T>(&mut self, vat_id: VatId) -> T

where T: FromClientHook,

Connects to the given vat and returns its bootstrap interface.

pub fn get_disconnector(&self) -> Disconnector<VatId>

Returns a Disconnector future that can be run to cleanly close the connection to this RpcSystem’s network. You should get the Disconnector before you spawn the RpcSystem.

Trait Implementations

impl<VatId> Future for RpcSystem<VatId>

where VatId: 'static,

type Output = Result<(), Error>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.