Struct paxakos::Core

pub struct Core<I, C> where
    I: Invocation,
    C: Communicator<Node = NodeOf<I>, RoundNum = RoundNumOf<I>, CoordNum = CoordNumOf<I>, LogEntry = LogEntryOf<I>, Error = CommunicationErrorOf<I>, Yea = YeaOf<I>, Nay = NayOf<I>, Abstain = AbstainOf<I>>,  { /* private fields */ }

The core Node implementation.

This Node implemenation does most of the heavy lifting w/r/t the consensus protocol. It has a counterpart Shell.

Trait Implementations

impl<I, C> MaybeLeadershipAwareNode<()> for Core<I, C> where
    I: Invocation,
    C: Communicator<Node = NodeOf<I>, RoundNum = RoundNumOf<I>, CoordNum = CoordNumOf<I>, LogEntry = LogEntryOf<I>, Error = CommunicationErrorOf<I>, Yea = YeaOf<I>, Nay = NayOf<I>, Abstain = AbstainOf<I>>, 

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

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

impl<I, C> Node for Core<I, C> where
    I: Invocation,
    C: Communicator<Node = NodeOf<I>, RoundNum = RoundNumOf<I>, CoordNum = CoordNumOf<I>, LogEntry = LogEntryOf<I>, Error = CommunicationErrorOf<I>, Yea = YeaOf<I>, Nay = NayOf<I>, Abstain = AbstainOf<I>>, 

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

Polls the node’s status, yielding Ready on every change.

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

type Invocation = I

Parametrization of the paxakos algorithm.

type Shutdown = DefaultShutdown<I>

Type that will perform graceful shutdown if requsted.

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

This node’s identifier.

fn status(&self) -> NodeStatus

Node’s current status.

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

Node’s current mode of participation.

fn handle(&self) -> NodeHandle<I>

Returns a handle for this node.

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

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 the given snapshot be installed.

fn append<A, P, R>(
    &self,
    applicable: A,
    args: P
) -> LocalBoxFuture<'_, AppendResultFor<Self, A, R>> where
    A: ApplicableTo<StateOf<Self::Invocation>> + '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::Invocation>> + '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 read_stale<F, T>(&self, f: F) -> LocalBoxFuture<'_, Result<T, Disoriented>> where
    F: FnOnce(&StateOf<Self::Invocation>) -> T + Send + 'static,
    T: Send + 'static, 

Reads the node’s current state.

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.

impl<I, C> NodeImpl for Core<I, C> where
    I: Invocation,
    C: Communicator<Node = NodeOf<I>, RoundNum = RoundNumOf<I>, CoordNum = CoordNumOf<I>, LogEntry = LogEntryOf<I>, Error = CommunicationErrorOf<I>, Yea = YeaOf<I>, Nay = NayOf<I>, Abstain = AbstainOf<I>>, 

fn append_impl<A, P, R>(
    &self,
    applicable: A,
    args: P
) -> LocalBoxFuture<'static, ImplAppendResultFor<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 await_commit_of(
    &self,
    log_entry_id: LogEntryIdOf<Self>
) -> LocalBoxFuture<'static, Result<CommitFor<Self>, ShutDown>>

Wait for the log entry with the given ID to be committed.

fn eject(
    &self,
    reason: EjectionOf<Self>
) -> LocalBoxFuture<'static, Result<bool, ShutDown>>

Eject the node’s state.

fn poll(
    &self,
    round_num: RoundNumOf<Self>,
    additional_nodes: Vec<NodeOf<Self>>
) -> LocalBoxFuture<'static, Result<bool, AppendError<InvocationOf<Self>>>>

Polls the given nodes for the log entry to apply to the given round.