Struct CompatNetwork 

pub struct CompatNetwork<A, TYPES: NodeType> {
    cliquenet: Cliquenet<TYPES::SignatureKey>,
    fallback: A,
    use_cliquenet: Arc<AtomicBool>,
    upgrade_lock: Arc<OnceLock<UpgradeLock<TYPES>>>,
}

Compatibility network.

Uses either a fallback network (any impl of ConnectedNetwork), or else Cliquenet once the protocol has been upgraded to CLIQUENET_VERSION.

Receiving listens on both networks simultaneously so that messages arriving on either side are never lost. Sending is routed to the active network only.

Fields

cliquenet: Cliquenet<TYPES::SignatureKey>

fallback: A

use_cliquenet: Arc<AtomicBool>

upgrade_lock: Arc<OnceLock<UpgradeLock<TYPES>>>

Implementations

impl<A, TYPES> CompatNetwork<A, TYPES>

where TYPES: NodeType,

pub async fn new(cliquenet: Cliquenet<TYPES::SignatureKey>, fallback: A) -> Self

pub fn cliquenet(&self) -> &Cliquenet<TYPES::SignatureKey>

pub fn fallback(&self) -> &A

pub fn set_upgrade_lock(&self, lock: UpgradeLock<TYPES>)

pub fn use_cliquenet(&self)

pub fn is_cliquenet(&self) -> bool

fn maybe_switch_to_cliquenet(&self, view: ViewNumber)

Trait Implementations

impl<A: Clone, TYPES: Clone + NodeType> Clone for CompatNetwork<A, TYPES>

where TYPES::SignatureKey: Clone,

fn clone(&self) -> CompatNetwork<A, TYPES>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<A, TYPES> ConnectedNetwork<<TYPES as NodeType>::SignatureKey> for CompatNetwork<A, TYPES>

where A: ConnectedNetwork<TYPES::SignatureKey>, TYPES: NodeType,

fn broadcast_message<'life0, 'async_trait>( &'life0 self, v: ViewNumber, m: Vec<u8>, t: Topic, d: 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<TYPES::SignatureKey>, d: 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: TYPES::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, e: Option<EpochNumber>, m: EpochMembershipCoordinator<U>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where U: NodeType<SignatureKey = TYPES::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, A> TestableNetworkingImplementation<T> for CompatNetwork<A, T>

where T: NodeType, A: TestableNetworkingImplementation<T> + Clone + Send + 'static,

Available on crate feature hotshot-testing only.

fn generator( nodes: usize, num_bootstrap: usize, network_id: usize, da_committee_size: usize, reliability_config: Option<Box<dyn NetworkReliability>>, secondary_network_delay: Duration, connect_infos: &mut HashMap<T::SignatureKey, PeerConnectInfo>, ) -> 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.