Struct paxakos::Shell

pub struct Shell<N: NodeImpl, S: State = Sendable> { /* private fields */ }

The Node implementation that’s returned from NodeBuilders.

This Node implementation processes requests from NodeHandles. It delegates to the outermost Decoration, thus giving decorations a chance to intercept.

Implementations

impl<N: NodeImpl> Shell<N, Unsendable>

pub fn into_send(self) -> Shell<N, Sendable>

Turns this node into a sendable one.

A sendable node can be more cumbersome to use but is Send.

impl<N: NodeImpl> Shell<N, Sendable>

pub fn enter<F, R>(&mut self, f: F) -> Rwhere
    F: for<'a> FnOnce(&'a mut EnteredShellRef<'a, N>) -> R,

Evaluates f, providing access to the full Node API through the argument passed to f.

pub fn enter_on_poll<'a, F, R>(&'a mut self, f: F) -> EnterOnPoll<'a, R> where
    F: FnOnce(&'a mut EnteredShell<N>) -> R,
    R: 'a,

Returns a wrapper around the future or stream returned by f that calls enter when polled.

pub fn into_enter_on_poll<F, R>(self, f: F) -> EnterOnPollOwned<R> where
    F: FnOnce(EnteredShell<N>) -> R,

Returns a wrapper around the future or stream returned by f that calls enter when polled.

pub fn into_unsend(self) -> Shell<N, Unsendable>

Turns this node into an unsendable one.

An unsendable node is easier to use but is !Send.

pub fn id(&self) -> NodeIdOf<N>

This node’s identifier.

pub fn status(&self) -> NodeStatus

Node’s current status.

pub fn participation(&self) -> Participation<RoundNumOf<N>>

Node’s current mode of participation.

pub fn poll_events(&mut self, cx: &mut Context<'_>) -> Poll<EventFor<N>>

Polls the node’s event stream.

It is important to poll the node’s event stream because it implicitly drives the actions that keep the node up to date.

pub fn next_event(&mut self) -> impl Future<Output = Event<N::Invocation>> + '_

Returns a future that polls this node for events until the next one is returned.

pub fn events(&mut self) -> impl Stream<Item = Event<N::Invocation>> + '_

Returns a stream that polls this node for events.

pub fn handle(&self) -> NodeHandle<N::Invocation>

Returns a handle for this node.

A node handle can be freely sent between threads.

pub fn shut_down(self) -> ShutdownOf<N>

Begins a graceful shutdown of this node.

Trait Implementations

impl<N: NodeImpl, S: State> Drop for Shell<N, S>

fn drop(&mut self)

Executes the destructor for this type.

impl<N, I> LeadershipAwareNode<(I,)> for Shell<N, Unsendable>where
    N: NodeImpl + LeadershipAwareNode<I>,

fn lax_leadership(&self) -> &[LeadershipFor<N>]

Leadership as assumed by this node.

fn strict_leadership(&self) -> &[LeadershipFor<N>]

Leadership as assumed by this node.

impl<N> Node for Shell<N, Unsendable>where
    N: NodeImpl,

type Invocation = <N as Node>::Invocation

Parametrization of the paxakos algorithm.

type Shutdown = <N as Node>::Shutdown

Type that will perform graceful shutdown if requsted.

fn id(&self) -> NodeIdOf<Self>

This node’s identifier.

fn status(&self) -> NodeStatus

Node’s current status.

fn participation(&self) -> Participation<RoundNumOf<Self>>

Node’s current mode of participation.

fn poll_events(&mut self, cx: &mut Context<'_>) -> Poll<EventFor<Self>>

Polls the node’s event stream.

fn handle(&self) -> NodeHandle<Self::Invocation>

Returns a handle for this node.

fn prepare_snapshot(&self) -> BoxFuture<'static, SnapshotFor<Self>>

Requests that snapshot of the node’s current state be taken.

fn affirm_snapshot(
    &self,
    snapshot: SnapshotFor<Self>
) -> BoxFuture<'static, Result<(), AffirmSnapshotError>>

Affirms that the given snapshot was written to persistent storage.

fn install_snapshot(
    &self,
    snapshot: SnapshotFor<Self>
) -> BoxFuture<'static, Result<(), InstallSnapshotError>>

Requests that the given snapshot be installed.

fn read_stale<F, T>(&self, f: F) -> BoxFuture<'_, Result<T, Disoriented>>where
    F: FnOnce(&StateOf<Self>) -> T + Send + 'static,
    T: Send + 'static,

Reads the node’s current state.

fn read_stale_infallibly<F, T>(&self, f: F) -> BoxFuture<'_, T>where
    F: FnOnce(Option<&StateOf<Self>>) -> T + Send + 'static,
    T: Send + 'static,

Reads the node’s current state.

fn read_stale_scoped<'read, F, T>(
    &self,
    f: F
) -> BoxFuture<'read, Result<T, Disoriented>>where
    F: FnOnce(&StateOf<Self>) -> T + Send + 'read,
    T: Send + 'static,

Reads the node’s current state.

fn read_stale_scoped_infallibly<'read, F, T>(&self, f: F) -> BoxFuture<'read, T>where
    F: FnOnce(Option<&StateOf<Self>>) -> T + Send + 'read,
    T: Send + 'static,

Reads the node’s current state.

fn append<A, P, R>(
    &mut self,
    applicable: A,
    args: P
) -> BoxFuture<'static, AppendResultFor<Self, A, R>>where
    A: ApplicableTo<StateOf<Self>> + 'static,
    P: Into<AppendArgs<Self::Invocation, R>>,
    R: RetryPolicy<Invocation = Self::Invocation>,
    R::StaticError: From<ShutDownOr<R::Error>>,

Appends applicable to the shared log.

fn shut_down(self) -> Self::Shutdown

Begins a graceful shutdown of this node.

fn next_event(&mut self) -> NextEvent<'_, Self>

Returns a future that polls this node for events until the next one is returned.

fn events(&mut self) -> Events<'_, Self>

Returns a stream that polls this node for events.