Struct Network

Source

pub struct Network<E: Spawner + Clock + ReasonablyRealtime + Rng + CryptoRng + RNetwork + Metrics, C: Scheme> { /* private fields */ }

Expand description

Implementation of an authenticated network.

Implementations§

Source §

impl<E: Spawner + Clock + ReasonablyRealtime + Rng + CryptoRng + RNetwork + Metrics, C: Scheme> Network<E, C>

Source

pub fn new(context: E, cfg: Config<C>) -> (Self, Oracle<E, C>)

Create a new instance of an authenticated network.

§Parameters

cfg - Configuration for the network.

§Returns

A tuple containing the network instance and the oracle that can be used by a developer to configure which peers are authorized.

Source

pub fn register( &mut self, channel: Channel, rate: Quota, backlog: usize, compression: Option<i32>, ) -> (Sender<C::PublicKey>, Receiver<C::PublicKey>)

Register a new channel over the network.

§Parameters

channel - Unique identifier for the channel.
rate - Rate at which messages can be received over the channel.
backlog - Maximum number of messages that can be queued on the channel before blocking.
compression - Optional compression level (using zstd) to use for messages on the channel.

§Returns

A tuple containing the sender and receiver for the channel (how to communicate with external peers on the network). It is safe to close either the sender or receiver without impacting the ability to process messages on other channels.

Source

pub fn start(self) -> Handle<()>

Starts the network.

After the network is started, it is not possible to add more channels.

Auto Trait Implementations§

§

impl<E, C> Unpin for Network<E, C>
where E: Unpin, C: Unpin, <E as Clock>::Instant: Unpin, <C as Specification>::PublicKey: Unpin, <C as Specification>::Signature: Unpin,

§

impl<E, C> !UnwindSafe for Network<E, C>

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 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 §