Struct ockam::SystemBuilder

pub struct SystemBuilder<C, M> where
    C: Send + 'static,
    M: Message, { /* private fields */ }

An abstraction to build a worker system graph

When creating a worker system it’s important to initialise each handler with the set of internal addresses that it must communicate with. This structure aims to make initialisation easier.

Implementations

impl<C, M> SystemBuilder<C, M> where
    C: Send + 'static,
    M: Message, 

pub fn new() -> Self

Create an empty SystemBuilder

pub fn add<A, S, H>(
    &mut self,
    addr: A,
    id: S,
    handler: H
) -> HandlerBuilder<'_, C, M> where
    A: Into<Address>,
    S: Into<String>,
    H: SystemHandler<C, M> + Send + 'static, 

Add a new handler to this SystemBuilder

You must at least provide ONE route path (via .default(addr) or .condition(cond, addr)), or else initialisation will fail.

pub fn get_addr(&self, id: impl Into<String>) -> Option<Address>

Get the address of a previously added SystemHandler

pub fn set_entry<A: Into<Address>>(&mut self, addr: A)

Specify an entry-point for the soon-to-be-built system

pub fn chain_default<A, H>(
    &mut self,
    addr: A,
    prev_id: impl Into<String>,
    id: impl Into<String>,
    handler: H
) -> HandlerBuilder<'_, C, M> where
    A: Into<Address>,
    H: SystemHandler<C, M> + Send + 'static, 

Add a new handler to the builder, re-addressing the previous handler’s “default” route to this one

pub fn chain_for<A, H>(
    &mut self,
    rule: impl Into<String>,
    addr: A,
    prev_id: impl Into<String>,
    id: impl Into<String>,
    handler: H
) -> HandlerBuilder<'_, C, M> where
    A: Into<Address>,
    H: SystemHandler<C, M> + Send + 'static, 

Add a new handler to the builder, re-addressing the previous handler’s named route to this one

pub fn readdress(&mut self, fin_addr: &Address)

Re-address every system handler in order to clone it

When initialising a worker system builder you setup handlers and routes between them. However when cloning the worker system all addresses need to be re-addressed in order to allow a second instance of every address to exist on the same node.

This problem may be solved by having scoped addresses in the future.

This function assigns a new address to every handler and then changes routes that point to the old addresses. Any route that is not in the internal set (i.e. the fin address routes) are replaced with the externally provided fin-address.

pub async fn finalise(self, ctx: &mut C) -> Result<WorkerSystem<C, M>>

Create a WorkerSystem and pre-initialise every SystemHandler

Trait Implementations

impl<C, M> Clone for SystemBuilder<C, M> where
    C: Send + 'static,
    M: Message, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C, M> Default for SystemBuilder<C, M> where
    C: Send + 'static,
    M: Message, 

fn default() -> Self

Returns the “default value” for a type.