Enum ockam_node::NodeMessage

pub enum NodeMessage {
    StartWorker {
        addrs: AddressSet,
        senders: SenderPair,
        bare: bool,
        reply: Sender<NodeReplyResult>,
    },
    ListWorkers(Sender<NodeReplyResult>),
    SetCluster(Address, String, Sender<NodeReplyResult>),
    StopWorker(Address, Sender<NodeReplyResult>),
    StartProcessor(Address, SenderPair, Sender<NodeReplyResult>),
    StopProcessor(Address, Sender<NodeReplyResult>),
    StopNode(ShutdownType, Sender<NodeReplyResult>),
    AbortNode,
    StopAck(Address),
    SenderReq(Address, Sender<NodeReplyResult>),
    Router(u8, Address, Sender<NodeReplyResult>),
}

Messages sent from the Node to the Executor

Variants

StartWorker

Start a new worker and store the send handle

Fields of StartWorker

addrs: AddressSet

The set of addresses in use by this worker

senders: SenderPair

Pair of senders to the worker relay (msgs and ctrl)

bare: bool

A bare worker runs no relay state

reply: Sender<NodeReplyResult>

Reply channel for command confirmation

ListWorkers(Sender<NodeReplyResult>)

Return a list of all worker addresses

Tuple Fields of ListWorkers

0: Sender<NodeReplyResult>

SetCluster(Address, String, Sender<NodeReplyResult>)

Add an existing address to a cluster

Tuple Fields of SetCluster

0: Address1: String2: Sender<NodeReplyResult>

StopWorker(Address, Sender<NodeReplyResult>)

Stop an existing worker

Tuple Fields of StopWorker

0: Address1: Sender<NodeReplyResult>

StartProcessor(Address, SenderPair, Sender<NodeReplyResult>)

Start a new processor

Tuple Fields of StartProcessor

0: Address1: SenderPair2: Sender<NodeReplyResult>

StopProcessor(Address, Sender<NodeReplyResult>)

Stop an existing processor

Tuple Fields of StopProcessor

0: Address1: Sender<NodeReplyResult>

StopNode(ShutdownType, Sender<NodeReplyResult>)

Stop the node (and all workers)

Tuple Fields of StopNode

0: ShutdownType1: Sender<NodeReplyResult>

AbortNode

Immediately stop the node runtime

StopAck(Address)

Let the router know a particular address has stopped

Tuple Fields of StopAck

0: Address

SenderReq(Address, Sender<NodeReplyResult>)

Request the sender for a worker address

Tuple Fields of SenderReq

0: Address1: Sender<NodeReplyResult>

Router(u8, Address, Sender<NodeReplyResult>)

Register a new router for a route id type

Tuple Fields of Router

0: u81: Address2: Sender<NodeReplyResult>

Implementations

impl NodeMessage

pub fn start_worker(
    addrs: AddressSet,
    senders: SenderPair,
    bare: bool
) -> (Self, Receiver<NodeReplyResult>)

Create a start worker message

• senders: message and command senders for the relay

• bare: indicate whether this worker address has a full relay behind it that can respond to shutdown commands. Setting this to true will disable stop ACK support in the router

pub fn start_processor(
    address: Address,
    senders: SenderPair
) -> (Self, Receiver<NodeReplyResult>)

Create a start worker message

pub fn stop_processor(address: Address) -> (Self, Receiver<NodeReplyResult>)

Create a stop worker message and reply receiver

pub fn list_workers() -> (Self, Receiver<NodeReplyResult>)

Create a list worker message and reply receiver

pub fn set_cluster(
    addr: Address,
    label: String
) -> (Self, Receiver<NodeReplyResult>)

Create a set cluster message and reply receiver

pub fn stop_worker(address: Address) -> (Self, Receiver<NodeReplyResult>)

Create a stop worker message and reply receiver

pub fn stop_node(tt: ShutdownType) -> (Self, Receiver<NodeReplyResult>)

Create a stop node message

pub fn sender_request(route: Address) -> (Self, Receiver<NodeReplyResult>)

Create a sender request message and reply receiver

Trait Implementations

impl Debug for NodeMessage

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

Formats the value using the given formatter.