Struct paxakos::node::Shell

pub struct Shell<N: NodeImpl> { /* fields omitted */ }

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.

Trait Implementations

impl<N, I> LeadershipAwareNode<(I,)> for Shell<N> 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> where
    N: NodeImpl, 

type Invocation = InvocationOf<N>

Parametrization of the paxakos algorithm.

type Communicator = CommunicatorOf<N>

Type of communicator this node uses.

type Shutdown = ShutdownOf<N>

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
) -> LocalBoxFuture<'static, Result<SnapshotFor<Self>, PrepareSnapshotError>>

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

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

Affirms that the given snapshot was written to persistent storage.

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

Requests that given snapshot be installed.

fn read_stale(
    &self
) -> LocalBoxFuture<'_, Result<Arc<StateOf<Self>>, Disoriented>>

Reads the node’s current state.

fn append<A, P, R>(
    &self,
    applicable: A,
    args: P
) -> LocalBoxFuture<'_, AppendResultFor<Self, A, R>> where
    A: ApplicableTo<StateOf<Self>> + 'static,
    P: Into<AppendArgs<Self::Invocation, R>>,
    R: RetryPolicy<Invocation = Self::Invocation>, 

Appends applicable to the shared log.

fn append_static<A, P, R>(
    &self,
    applicable: A,
    args: P
) -> LocalBoxFuture<'static, StaticAppendResultFor<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.