commonware_consensus::ordered_broadcast

Struct Engine

Source 
pub struct Engine<E: Clock + Spawner + Storage + Metrics, C: Signer, V: Variant, D: Digest, A: Automaton<Context = Context<C::PublicKey>, Digest = D> + Clone, R: Relay<Digest = D>, Z: Reporter<Activity = Activity<C::PublicKey, V, D>>, M: Monitor<Index = Epoch>, Su: Supervisor<Index = Epoch, PublicKey = C::PublicKey>, TSu: ThresholdSupervisor<Index = Epoch, PublicKey = C::PublicKey, Identity = V::Public, Polynomial = Public<V>, Share = Share>, NetS: Sender<PublicKey = C::PublicKey>, NetR: Receiver<PublicKey = C::PublicKey>> { /* private fields */ }
Expand description

Instance of the engine.

Implementations§

Source§

impl<E: Clock + Spawner + Storage + Metrics, C: Signer, V: Variant, D: Digest, A: Automaton<Context = Context<C::PublicKey>, Digest = D> + Clone, R: Relay<Digest = D>, Z: Reporter<Activity = Activity<C::PublicKey, V, D>>, M: Monitor<Index = Epoch>, Su: Supervisor<Index = Epoch, PublicKey = C::PublicKey>, TSu: ThresholdSupervisor<Index = Epoch, PublicKey = C::PublicKey, Identity = V::Public, Polynomial = Public<V>, Share = Share>, NetS: Sender<PublicKey = C::PublicKey>, NetR: Receiver<PublicKey = C::PublicKey>> Engine<E, C, V, D, A, R, Z, M, Su, TSu, NetS, NetR>

Source

pub fn new(context: E, cfg: Config<C, V, D, A, R, Z, M, Su, TSu>) -> Self

Creates a new engine with the given context and configuration.

Source

pub fn start( self, chunk_network: (NetS, NetR), ack_network: (NetS, NetR), ) -> Handle<()>

Runs the engine until the context is stopped.

The engine will handle:

  • Requesting and processing proposals from the application
  • Timeouts
    • Refreshing the Epoch
    • Rebroadcasting Proposals
  • Messages from the network:
    • Nodes
    • Acks

Auto Trait Implementations§

§

impl<E, C, V, D, A, R, Z, M, Su, TSu, NetS, NetR> !Freeze for Engine<E, C, V, D, A, R, Z, M, Su, TSu, NetS, NetR>

§

impl<E, C, V, D, A, R, Z, M, Su, TSu, NetS, NetR> !RefUnwindSafe for Engine<E, C, V, D, A, R, Z, M, Su, TSu, NetS, NetR>

§

impl<E, C, V, D, A, R, Z, M, Su, TSu, NetS, NetR> Send for Engine<E, C, V, D, A, R, Z, M, Su, TSu, NetS, NetR>

§

impl<E, C, V, D, A, R, Z, M, Su, TSu, NetS, NetR> !Sync for Engine<E, C, V, D, A, R, Z, M, Su, TSu, NetS, NetR>

§

impl<E, C, V, D, A, R, Z, M, Su, TSu, NetS, NetR> Unpin for Engine<E, C, V, D, A, R, Z, M, Su, TSu, NetS, NetR>
where E: Unpin, C: Unpin, A: Unpin, R: Unpin, M: Unpin, Su: Unpin, TSu: Unpin, Z: Unpin, NetS: Unpin, NetR: Unpin, <C as Signer>::PublicKey: Unpin, <C as Signer>::Signature: Unpin, D: Unpin, <V as Variant>::Signature: Unpin,

§

impl<E, C, V, D, A, R, Z, M, Su, TSu, NetS, NetR> !UnwindSafe for Engine<E, C, V, D, A, R, Z, M, Su, TSu, NetS, NetR>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,