Struct NetworkController 

pub struct NetworkController {
    conf: Arc<Config>,
    node: PublicKey,
    parties: HashMap<PublicKey, Role>,
    tx: UnboundedSender<Command>,
    next_slot: Sender<Slot>,
    lower_bound: Slot,
    task: JoinHandle<()>,
    metrics: Arc<dyn Metrics>,
}

Fields

conf: Arc<Config>

node: PublicKey

parties: HashMap<PublicKey, Role>

tx: UnboundedSender<Command>

next_slot: Sender<Slot>

lower_bound: Slot

task: JoinHandle<()>

metrics: Arc<dyn Metrics>

Implementations

impl NetworkController

pub fn config(&self) -> &Config

pub fn parties(&self) -> impl Iterator<Item = (&PublicKey, &Role)>

Iterate over all parties.

pub fn unicast( &mut 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(&mut self, s: Slot, msg: Vec<u8>) -> Result<(), NetworkError>

Send a message to all parties.

pub fn multicast<P>( &mut 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(&mut self, cmd: SendCommand) -> Result<(), NetworkError>

General send operation, supporting custom retry policies.

pub fn add_peers<P>(&mut 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>(&mut self, peers: P) -> Result<(), NetworkError>

where P: IntoIterator<Item = PublicKey>,

Remove the given peers from the network.

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

where P: IntoIterator<Item = PublicKey>,

Assign the given role to the given peers.

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

pub fn shutdown( &mut 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 NetworkController

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

Formats the value using the given formatter.

impl Drop for NetworkController

fn drop(&mut self)

Executes the destructor for this type.