Struct Link 

pub struct Link { /* private fields */ }

The delivery state of one peer: the unacknowledged messages, the current connection, and the acknowledgements received. It outlives connections, so a reconnect sends every pending message again. It is Send + Sync; the I/O lives in the connection code, which hands the link a channel of outgoing frame texts on connect.

Implementations

impl Link

pub fn new() -> Self

A link with no connection yet.

pub fn offer(&self, env: Envelope) -> Offer

Offers env for delivery: sends it if connected and not yet sent on this connection, and reports whether the peer has acknowledged it. Offering the same message id again is how the outbox retries; it is sent once per connection.

pub fn watch(&self, id: &str)

Asks to hear of the acknowledgement (or refusal) of message id through Link::take_settled instead of a later Link::offer.

pub fn take_settled(&self) -> Vec<(String, Result<(), String>)>

The watched messages acknowledged or failed since the last call.

pub fn is_pending(&self, id: &str) -> bool

Whether message id waits for an acknowledgement.

pub fn pending_len(&self) -> usize

The number of messages waiting for an acknowledgement.

pub fn connected(&self, generation: u64, tx: UnboundedSender<String>)

A connection with number generation is open (and accepted): its writer takes the frame texts sent into tx. Every pending message is sent again, oldest first, and a refusal is forgotten.

pub fn disconnected(&self, generation: u64)

The connection generation closed (a later connection is left alone).

pub fn is_connected(&self) -> bool

Whether a connection is open.

pub fn ack(&self, id: &str)

Sends an acknowledgement of message id on the current connection.

pub fn send_frame(&self, f: &Frame) -> bool

Sends a frame on the current connection; false when there is none.

pub fn refused(&self, reason: &str) -> Vec<String>

The credential was refused: watched pending messages fail, the others are dropped from the link (the outbox offers them again and learns of the refusal then). The refusal holds until the next accepted connection.

pub fn refusal(&self) -> Option<String>

Whether the peer refused the credential (and no connection was accepted since).

pub fn learn_route(&self, iri: &str)

Learns that actor iri is reachable through this link (the origin of a message it sent).

pub fn routes_to(&self, iri: &str) -> bool

Whether actor iri is known to be reachable through this link.

pub fn receive(&self, text: &str) -> Result<Inbound, String>

Handles one received frame text.

Errors

A message for text that is not a frame.

Trait Implementations

impl Debug for Link

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

Formats the value using the given formatter.

impl Default for Link

fn default() -> Self

Returns the “default value” for a type.