Struct Network 

pub struct Network {
    recv: NetworkReceiver,
    send: NetworkSender,
}

Fields

recv: NetworkReceiver

send: NetworkSender

Implementations

impl Network

pub async fn create(conf: Config) -> Result<Self, NetworkError>

pub fn sender(&self) -> &NetworkSender

pub fn receiver(&self) -> &NetworkReceiver

pub fn receiver_mut(&mut self) -> &mut NetworkReceiver

pub fn split_into(self) -> (NetworkSender, NetworkReceiver)

pub async fn receive(&mut self) -> Option<(PublicKey, Bytes)>

Methods from Deref<Target = NetworkSender>

pub fn config(&self) -> &Config

pub fn unicast( &self, s: Slot, to: PublicKey, msg: Vec<u8>, ) -> Result<(), NetworkError>

Send a message to a party, identified by the given public key.

pub fn broadcast(&self, s: Slot, msg: Vec<u8>) -> Result<(), NetworkError>

Send a message to all parties.

pub fn multicast<P>( &self, s: Slot, to: P, msg: Vec<u8>, ) -> Result<(), NetworkError>

where P: IntoIterator<Item = PublicKey>,

Send a message to several parties, identified by their public keys.

pub fn send(&self, cmd: SendCommand) -> Result<(), NetworkError>

General send operation, supporting custom retry policies.

pub fn add_peers<P>(&self, r: Role, peers: P) -> Result<(), NetworkError>

where P: IntoIterator<Item = (PublicKey, NetAddr)>,

Add the given peers to the network.

pub fn remove_peers<P>(&self, peers: P) -> Result<(), NetworkError>

where P: IntoIterator<Item = PublicKey>,

Remove the given peers from the network.

pub fn assign_peers<P>(&self, r: Role, peers: P) -> Result<(), NetworkError>

where P: IntoIterator<Item = PublicKey>,

Assign the given role to the given peers.

pub fn gc(&self, s: Slot) -> Result<(), NetworkError>

Trigger garbage collection of messages below the given slot.

pub fn shutdown(&self) -> Result<impl Future<Output = ()> + use<>, NetworkError>

Trigger network shutdown.

The returned future will resolve once the server task finished.

fn length_check(&self, msg: &[u8]) -> Result<(), NetworkError>

Check the number of message bytes does not exceed the configured maximum.

fn lt_lower_bound(&self, s: Slot) -> bool

Check if the given slot is less than our lower bound.

Trait Implementations

impl Debug for Network

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

Formats the value using the given formatter.

impl Deref for Network

type Target = NetworkSender

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.