Struct paxakos::node::NodeHandle

pub struct NodeHandle<I: Invocation> { /* private fields */ }

A remote handle for a paxakos Node.

Implementations

impl<I: Invocation> NodeHandle<I>

pub fn status(&self) -> impl Future<Output = Result<NodeStatus, ShutDown>>

Node’s current status.

pub fn prepare_snapshot(
    &self
) -> impl Future<Output = Result<SnapshotFor<I>, ShutDown>>

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

pub fn affirm_snapshot(
    &self,
    snapshot: SnapshotFor<I>
) -> impl Future<Output = Result<(), AffirmSnapshotError>>

Affirms that the given snapshot was written to persistent storage.

Currently does nothing.

pub fn install_snapshot(
    &self,
    snapshot: SnapshotFor<I>
) -> impl Future<Output = Result<(), InstallSnapshotError>>

Requests that the given snapshot be installed.

See Node::install_snapshot.

pub fn read_stale<F, T>(
    &self,
    f: F
) -> impl Future<Output = Result<T, ReadStaleError>>where
    F: FnOnce(&StateOf<I>) -> T + Send + 'static,
    T: Send + 'static,

Reads the node’s current state.

As the name implies the state may be stale, i.e. other node’s may have advanced the shared state without this node being aware.

pub fn read_stale_scoped<'read, F, T>(
    &self,
    f: F
) -> impl Future<Output = Result<T, ReadStaleError>> + 'readwhere
    F: FnOnce(&StateOf<I>) -> T + Send + 'read,
    T: Send + 'static,

Reads the node’s current state.

As the name implies the state may be stale, i.e. other node’s may have advanced the shared state without this node being aware.

pub fn append<A, P, R>(
    &self,
    applicable: A,
    args: P
) -> impl Future<Output = Result<CommitFor<I, A>, R::StaticError>>where
    A: ApplicableTo<StateOf<I>>,
    P: Into<AppendArgs<I, R>>,
    R: RetryPolicy<Invocation = I> + Send + 'static,
    R::Error: Send,
    R::StaticError: From<ShutDownOr<R::Error>>,
    R::Future: Send,

Appends applicable to the shared log.

Trait Implementations

impl<I: Invocation> Admin for NodeHandle<I>

fn force_active(&self) -> BoxFuture<'static, Result<bool, ShutDown>>

Forces node out of passive participation.

impl<I: Invocation> Clone for NodeHandle<I>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<I: Invocation> Debug for NodeHandle<I>

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

Formats the value using the given formatter.