Struct Cliquenet 

pub struct Cliquenet<T: NodeType> {
    net: Retry<T::SignatureKey>,
}

Fields

net: Retry<T::SignatureKey>

Implementations

impl<T: NodeType> Cliquenet<T>

pub async fn create<A, B, P, M>( name: &'static str, key: T::SignatureKey, keypair: Keypair, addr: A, parties: P, metrics: M, ) -> Result<Self, NetworkError>

where A: Into<Address>, B: Into<Address>, P: IntoIterator<Item = (T::SignatureKey, PublicKey, B)>, M: Metrics + 'static,

Trait Implementations

impl<T: Clone + NodeType> Clone for Cliquenet<T>

where T::SignatureKey: Clone,

fn clone(&self) -> Cliquenet<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: NodeType> ConnectedNetwork<<T as NodeType>::SignatureKey> for Cliquenet<T>

fn broadcast_message<'life0, 'async_trait>( &'life0 self, v: ViewNumber, m: Vec<u8>, __arg3: Topic, __arg4: BroadcastDelay, ) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

broadcast message to some subset of nodes blocking

fn da_broadcast_message<'life0, 'async_trait>( &'life0 self, v: ViewNumber, m: Vec<u8>, recipients: Vec<T::SignatureKey>, __arg4: BroadcastDelay, ) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

broadcast a message only to a DA committee blocking

fn direct_message<'life0, 'async_trait>( &'life0 self, v: ViewNumber, m: Vec<u8>, recipient: T::SignatureKey, ) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sends a direct message to a specific node blocking

fn recv_message<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, NetworkError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Receive one or many messages from the underlying network.

fn update_view<'life0, 'async_trait, U>( &'life0 self, v: ViewNumber, __arg2: Option<EpochNumber>, __arg3: EpochMembershipCoordinator<U>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where U: NodeType<SignatureKey = T::SignatureKey> + 'async_trait, Self: 'async_trait, 'life0: 'async_trait,

Update view can be used for any reason, but mostly it’s for canceling tasks, and looking up the address of the leader of a future view.

fn wait_for_ready<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Blocks until the network is successfully initialized

fn pause(&self)

Pauses the underlying network

fn resume(&self)

Resumes the underlying network

fn shut_down<'a, 'b>(&'a self) -> BoxSyncFuture<'b, ()>

where Self: 'b, 'a: 'b,

Blocks until the network is shut down

fn vid_broadcast_message<'life0, 'async_trait>( &'life0 self, messages: HashMap<K, (ViewNumber, Vec<u8>)>, ) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

send messages with vid shares to its recipients blocking

fn queue_node_lookup( &self, _: ViewNumber, _: K, ) -> Result<(), TrySendError<Option<(ViewNumber, K)>>>

queues lookup of a node

fn is_primary_down(&self) -> bool

Is primary network down? Makes sense only for combined network

impl<T: NodeType> TestableNetworkingImplementation<T> for Cliquenet<T>

Available on crate feature hotshot-testing only.

fn generator( expected_node_count: usize, _num_bootstrap: usize, _network_id: usize, _da_committee_size: usize, _reliability_config: Option<Box<dyn NetworkReliability>>, _secondary_network_delay: Duration, ) -> AsyncGenerator<Arc<Self>>

generates a network given an expected node count

fn in_flight_message_count(&self) -> Option<usize>

Get the number of messages in-flight.