Skip to main content

Engine

commonware_broadcast::buffered

Struct Engine 

Source 
pub struct Engine<E, P, M, D>
where
    E: BufferPooler + Clock + Spawner + Metrics,
    P: PublicKey,
    M: Digestible + Codec,
    D: Provider<PublicKey = P>,
{ /* private fields */ }
Expand description

Instance of the main engine for the module.

It is responsible for:

  • Broadcasting messages to the network
  • Receiving messages from the network
  • Storing messages in the cache
  • Responding to requests from the application

Implementations§

Source§

impl<E, P, M, D> Engine<E, P, M, D>
where E: BufferPooler + Clock + Spawner + Metrics, P: PublicKey, M: Digestible + Codec, D: Provider<PublicKey = P>,

Source

pub fn new(context: E, cfg: Config<P, M::Cfg, D>) -> (Self, Mailbox<P, M>)

Creates a new engine with the given context and configuration. Returns the engine and a mailbox for sending messages to the engine.

Source

pub fn start( self, network: (impl Sender<PublicKey = P>, impl Receiver<PublicKey = P>), ) -> Handle<()> ⓘ

Starts the engine with the given network.

Auto Trait Implementations§

§

impl<E, P, M, D> !RefUnwindSafe for Engine<E, P, M, D>

§

impl<E, P, M, D> !UnwindSafe for Engine<E, P, M, D>

§

impl<E, P, M, D> Freeze for Engine<E, P, M, D>
where Cell<E>: Freeze, P: Freeze, <M as Read>::Cfg: Freeze, Receiver<Message<P, M>>: Freeze, BTreeMap<<M as Digestible>::Digest, Vec<Waiter<M>>>: Freeze, D: Freeze, BTreeMap<<M as Digestible>::Digest, Arc<M>>: Freeze, BTreeMap<P, VecDeque<<M as Digestible>::Digest>>: Freeze, BTreeMap<<M as Digestible>::Digest, usize>: Freeze, Set<P>: Freeze, Metrics<P>: Freeze,

§

impl<E, P, M, D> Send for Engine<E, P, M, D>
where Cell<E>: Send, <M as Read>::Cfg: Send, Receiver<Message<P, M>>: Send, BTreeMap<<M as Digestible>::Digest, Vec<Waiter<M>>>: Send, BTreeMap<<M as Digestible>::Digest, Arc<M>>: Send, BTreeMap<P, VecDeque<<M as Digestible>::Digest>>: Send, BTreeMap<<M as Digestible>::Digest, usize>: Send, Set<P>: Send, Metrics<P>: Send,

§

impl<E, P, M, D> Sync for Engine<E, P, M, D>
where Cell<E>: Sync, <M as Read>::Cfg: Sync, Receiver<Message<P, M>>: Sync, BTreeMap<<M as Digestible>::Digest, Vec<Waiter<M>>>: Sync, D: Sync, BTreeMap<<M as Digestible>::Digest, Arc<M>>: Sync, BTreeMap<P, VecDeque<<M as Digestible>::Digest>>: Sync, BTreeMap<<M as Digestible>::Digest, usize>: Sync, Set<P>: Sync, Metrics<P>: Sync,

§

impl<E, P, M, D> Unpin for Engine<E, P, M, D>
where Cell<E>: Unpin, P: Unpin, <M as Read>::Cfg: Unpin, Receiver<Message<P, M>>: Unpin, BTreeMap<<M as Digestible>::Digest, Vec<Waiter<M>>>: Unpin, D: Unpin, BTreeMap<<M as Digestible>::Digest, Arc<M>>: Unpin, BTreeMap<P, VecDeque<<M as Digestible>::Digest>>: Unpin, BTreeMap<<M as Digestible>::Digest, usize>: Unpin, Set<P>: Unpin, Metrics<P>: Unpin,

§

impl<E, P, M, D> UnsafeUnpin for Engine<E, P, M, D>
where Cell<E>: UnsafeUnpin, P: UnsafeUnpin, <M as Read>::Cfg: UnsafeUnpin, Receiver<Message<P, M>>: UnsafeUnpin, BTreeMap<<M as Digestible>::Digest, Vec<Waiter<M>>>: UnsafeUnpin, D: UnsafeUnpin, BTreeMap<<M as Digestible>::Digest, Arc<M>>: UnsafeUnpin, BTreeMap<P, VecDeque<<M as Digestible>::Digest>>: UnsafeUnpin, BTreeMap<<M as Digestible>::Digest, usize>: UnsafeUnpin, Set<P>: UnsafeUnpin, Metrics<P>: UnsafeUnpin,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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: Sized + 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: Sized + 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Threaded<T> for T

Source§

type Rest = ()

The outputs beyond the threaded value.
Source§

fn split(self) -> (T, ())

Splits into the threaded value and the extra outputs.
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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