Struct NodeHandle 

pub struct NodeHandle { /* private fields */ }

A handle on a node for callers outside the actor system: send, ask, register resolvers, shut down. It is Send + Sync and cheap to clone.

Implementations

impl NodeHandle

pub fn send(&self, to: &Address, event: Event) -> Result<String, DeliveryError>

Sends event to to from outside the actor system; returns the message id.

Errors

DeliveryError when to cannot be resolved.

pub fn send_envelope(&self, env: Envelope) -> Result<(), DeliveryError>

Delivers a complete envelope (with its own message id).

Errors

DeliveryError when its receiver cannot be resolved.

pub async fn ask( &self, to: &Address, event: Event, timeout: Duration, ) -> Result<Event, AskError>

Sends event to to and waits for its vt:reply, at most timeout on the node’s clock. For callers outside the actor system only (HTTP handlers, tests); charts never block. A reply arriving after the timeout is dropped.

Errors

AskError::Timeout, or AskError::Delivery when to cannot be resolved.

pub fn register_resolver(&self, scheme: &str, resolver: Arc<dyn Resolver>)

Registers a resolver for addresses of scheme.

pub fn bind_address(&self, address: &Address, chart_type: &str, key: &str)

Binds address to the virtual actor of chart_type with key: the actor is hosted here and activated on message like <chart_type>/<key>, with address as its subject. Used for actors whose address is a DID.

pub fn notify(&self, a: &Address) -> bool

Tells the node that the mailbox of the local actor a received messages from outside the node (a relay pickup), so the actor is activated and receives them. False when a is not hosted here.

pub fn shutdown(&self)

Asks Node::run to return.

pub fn now_ms(&self) -> i64

The node’s clock reading.

pub fn wakeup(&self) -> BoxFuture<()>

Completes once the node has new work (a delivered message, a finished background turn, a shutdown request), for shells that drive the node with Node::run_until_idle. A signal sent while nobody waits is kept for the next waiter.

pub fn deliver_here(&self, env: Envelope) -> Result<(), DeliveryError>

Delivers env to an actor hosted on this node without asking the placement: what a cluster does with a message another node sent here for an actor this node owns.

Errors

DeliveryError when its receiver cannot be resolved.

pub fn record_dead_letter( &self, receiver: &Address, env: &Envelope, reason: &str, )

Records env in receiver’s dead-letter graph with reason, at the node’s time.

pub fn pending(&self, a: &Address) -> usize

The number of messages waiting in the local mailbox of a (none when a has no mailbox here).

Trait Implementations

impl Clone for NodeHandle

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeHandle

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

Formats the value using the given formatter.