Struct SessionLink 

pub struct SessionLink<P> { /* private fields */ }

Reliable ordered delivery within a session, and honesty across one.

Implementations

impl<P> SessionLink<P>

pub fn new() -> Self

pub fn epoch(&self, peer: NodeId) -> Option<u64>

The epoch in force with peer, or None when there is no session with it.

pub fn tracked_peers(&self) -> usize

How many peers this link currently holds a session with. Its entire footprint.

Trait Implementations

impl<P: Debug> Debug for SessionLink<P>

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

Formats the value using the given formatter.

impl<P: Default> Default for SessionLink<P>

fn default() -> SessionLink<P>

Returns the “default value” for a type.

impl<P> Link<P> for SessionLink<P>

where P: Clone,

The session link satisfies the link port, and reports scope boundaries through it.

It classifies its two boundary indications as boundaries, which is a claim that it can observe them — and it can: the simulator raises a session ending and an establishment, and this link is where they enter the stack. That is what a layer above needs in order to repair a lost suffix, and what the perfect link cannot offer.

fn send(to: NodeId, msg: P) -> Cmd<P>

The request that sends msg to to.

fn classify(ind: Ind<P>) -> LinkInd<P>

What this indication means to the layer above.

impl<P: Clone> Protocol for SessionLink<P>

type Meta = Infallible

Keeps nothing durably: a crash loses everything this protocol knows.

type Cmd = Cmd<P>

Requests from the layer above.

type Ind = Ind<P>

Indications to the layer above — this protocol delivering on its guarantee.

type Msg = P

What crosses the wire to a peer running the same protocol.

type Scope = SessionEvent

Scopes whose boundaries this protocol’s guarantees depend on, and which it can observe.

type Note = Note

The vocabulary in which this protocol narrates its decisions.

type Entry = Infallible

The durable entries this protocol appends: what accumulates.

fn on_cmd(&mut self, _: Cmd<P>, cx: &mut ProtoCx<'_, Self>)

Handle a request from the layer above.

fn on_msg(&mut self, from: NodeId, msg: Wire<P>, cx: &mut ProtoCx<'_, Self>)

Handle a message received from from.

fn on_timer(&mut self, _id: TimerId, _cx: &mut ProtoCx<'_, Self>)

Handle a timer that fired somewhere in this protocol or in what it composes.

fn on_scope_event(&mut self, event: SessionEvent, cx: &mut ProtoCx<'_, Self>)

Handle a boundary of a scope this protocol’s guarantees depend on — its end, or the beginning of the one that succeeds it.

fn on_init( &mut self, _cx: &mut Cx<'_, Self::Msg, Self::Ind, Self::Note, Self::Meta, Self::Entry>, )

Begin, on a first start — when nothing has been written down.

fn on_recovery( &mut self, _cx: &mut Cx<'_, Self::Msg, Self::Ind, Self::Note, Self::Meta, Self::Entry>, )

Resume after a crash, reading what survived.