Struct ockam::WorkerSystem

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

A composable worker system type.

A worker system is a single worker which can act as a full cluster of workers. This is achieved via the send_to_self(...) API endpoint on the Ockam Node API.

The worker system also provides some utilities for creating and managing mappings between hidden API-addresses and behaviour hooks associated to each address.

The advantage of a worker system over a full set of workers is a lower memory overhead for resource constrained devices.

Implementations

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

pub fn is_empty(&self) -> bool

Check whether this system has registered handlers

pub fn addresses(&self) -> Vec<Address>

Return the set of used addresses in this system

pub fn attach<A, H>(&mut self, addr: A, handler: H) where
    A: Into<Address>,
    H: SystemHandler<C, M> + Send + 'static, 

Attach a system handler to this system

pub fn attach_boxed<A: Into<Address>>(
    &mut self,
    addr: A,
    handler: Box<dyn SystemHandler<C, M> + Send + 'static>
)

Attach a boxed system handler to this system

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

Specify an “entry point” address for this system

Because a worker system is a graph of relationships between ‘SystemHandler’ instances it may be hard to determine which instance to send a message to first. The pre-configuration phase of a worker system can determine this address and store it as the entry-point.

You can then start the handling process by calling dispatch_entry().

pub fn entrypoint(&self) -> Option<&Address>

Get an optional reference to the entry point of this system

pub async fn dispatch_entry(
    &mut self,
    ctx: &mut C,
    msg: Routed<M>
) -> Result<()>

Dispatch a message to the pre-configured system entry point

This function returns an error if no entry point was configured or the configured address was not bound.

pub async fn handle_message(
    &mut self,
    ctx: &mut C,
    msg: Routed<M>
) -> Result<()>

Handle a message via this worker system

Trait Implementations

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

fn default() -> Self

Returns the “default value” for a type.