commonware_consensus::marshal::coding::shards

Struct Config

pub struct Config<P, S, X, D, C, H, B, T>where
    P: PublicKey,
    S: Provider<Scope = Epoch>,
    X: Blocker<PublicKey = P>,
    D: PeerProvider<PublicKey = P>,
    C: CodingScheme,
    H: Hasher,
    B: CertifiableBlock,
    T: Strategy,{
    pub scheme_provider: S,
    pub blocker: X,
    pub shard_codec_cfg: <Shard<C, H> as Read>::Cfg,
    pub block_codec_cfg: B::Cfg,
    pub strategy: T,
    pub mailbox_size: usize,
    pub peer_buffer_size: NonZeroUsize,
    pub background_channel_capacity: usize,
    pub peer_provider: D,
}

Expand description

Configuration for the Engine.

Fields§

§scheme_provider: S

The scheme provider.

§blocker: X

The peer blocker.

§shard_codec_cfg: <Shard<C, H> as Read>::Cfg

Read configuration for decoding Shards.

§block_codec_cfg: B::Cfg

commonware_codec::Read configuration for decoding blocks.

§strategy: T

The strategy used for parallel computation.

§mailbox_size: usize

The size of the mailbox buffer.

§peer_buffer_size: NonZeroUsize

Number of shards to buffer per peer.

Shards for commitments without a reconstruction state are buffered per peer in a fixed-size ring to bound memory under Byzantine spam. These shards are only ingested when consensus provides a leader via Discovered.

The worst-case total memory usage for the set of shard buffers is num_participants * peer_buffer_size * max_shard_size.

§background_channel_capacity: usize

Capacity of the channel between the background receiver and the engine.

The background receiver decodes incoming network messages in a separate task and forwards them to the engine over an mpsc channel with this capacity.

§peer_provider: D

Provider for peer set information. Per-peer shard buffers are freed when a peer leaves all tracked peer sets.

Auto Trait Implementations§

§

impl<P, S, X, D, C, H, B, T> Freeze for Config<P, S, X, D, C, H, B, T>
where S: Freeze, X: Freeze, ::Cfg: Freeze, T: Freeze, D: Freeze,

§

impl<P, S, X, D, C, H, B, T> RefUnwindSafe for Config<P, S, X, D, C, H, B, T>
where S: RefUnwindSafe, X: RefUnwindSafe, ::Cfg: RefUnwindSafe, T: RefUnwindSafe, D: RefUnwindSafe,

§

impl<P, S, X, D, C, H, B, T> Send for Config<P, S, X, D, C, H, B, T>

§

impl<P, S, X, D, C, H, B, T> Sync for Config<P, S, X, D, C, H, B, T>
where X: Sync, D: Sync,

§

impl<P, S, X, D, C, H, B, T> Unpin for Config<P, S, X, D, C, H, B, T>
where S: Unpin, X: Unpin, ::Cfg: Unpin, T: Unpin, D: Unpin,

§

Config

Struct Config Copy item path

Fields§

Auto Trait Implementations§

impl<P, S, X, D, C, H, B, T> Freeze for Config<P, S, X, D, C, H, B, T>where S: Freeze, X: Freeze, <B as Read>::Cfg: Freeze, T: Freeze, D: Freeze,

impl<P, S, X, D, C, H, B, T> RefUnwindSafe for Config<P, S, X, D, C, H, B, T>where S: RefUnwindSafe, X: RefUnwindSafe, <B as Read>::Cfg: RefUnwindSafe, T: RefUnwindSafe, D: RefUnwindSafe,

impl<P, S, X, D, C, H, B, T> Send for Config<P, S, X, D, C, H, B, T>

impl<P, S, X, D, C, H, B, T> Sync for Config<P, S, X, D, C, H, B, T>where X: Sync, D: Sync,

impl<P, S, X, D, C, H, B, T> Unpin for Config<P, S, X, D, C, H, B, T>where S: Unpin, X: Unpin, <B as Read>::Cfg: Unpin, T: Unpin, D: Unpin,

impl<P, S, X, D, C, H, B, T> UnsafeUnpin for Config<P, S, X, D, C, H, B, T>where S: UnsafeUnpin, X: UnsafeUnpin, <B as Read>::Cfg: UnsafeUnpin, T: UnsafeUnpin, D: UnsafeUnpin,

impl<P, S, X, D, C, H, B, T> UnwindSafe for Config<P, S, X, D, C, H, B, T>where S: UnwindSafe, X: UnwindSafe, <B as Read>::Cfg: UnwindSafe, T: UnwindSafe, D: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> FutureExt for T

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

fn with_current_context(self) -> WithContext<Self>

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> IntoEither for T

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

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

impl<T> Pointable for T

const ALIGN: usize

type Init = T

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

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

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

unsafe fn drop(ptr: usize)

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

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

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

impl<T> Same for T

type Output = T

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

type Error = Infallible

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

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

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

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

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

Struct Config

impl<P, S, X, D, C, H, B, T> Freeze for Config<P, S, X, D, C, H, B, T>
where S: Freeze, X: Freeze, <B as Read>::Cfg: Freeze, T: Freeze, D: Freeze,

impl<P, S, X, D, C, H, B, T> RefUnwindSafe for Config<P, S, X, D, C, H, B, T>
where S: RefUnwindSafe, X: RefUnwindSafe, <B as Read>::Cfg: RefUnwindSafe, T: RefUnwindSafe, D: RefUnwindSafe,

impl<P, S, X, D, C, H, B, T> Sync for Config<P, S, X, D, C, H, B, T>
where X: Sync, D: Sync,

impl<P, S, X, D, C, H, B, T> Unpin for Config<P, S, X, D, C, H, B, T>
where S: Unpin, X: Unpin, <B as Read>::Cfg: Unpin, T: Unpin, D: Unpin,

impl<P, S, X, D, C, H, B, T> UnsafeUnpin for Config<P, S, X, D, C, H, B, T>
where S: UnsafeUnpin, X: UnsafeUnpin, <B as Read>::Cfg: UnsafeUnpin, T: UnsafeUnpin, D: UnsafeUnpin,

impl<P, S, X, D, C, H, B, T> UnwindSafe for Config<P, S, X, D, C, H, B, T>
where S: UnwindSafe, X: UnwindSafe, <B as Read>::Cfg: UnwindSafe, T: UnwindSafe, D: UnwindSafe,

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

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

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

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

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

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

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

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

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

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

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

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

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