Struct hotshot::traits::networking::push_cdn_network::PushCdnNetwork

pub struct PushCdnNetwork<K: SignatureKey + 'static> {
    client: Client<ClientDef<K>>,
    metrics: Arc<CdnMetricsValue>,
    internal_queue: Arc<Mutex<VecDeque<Vec<u8>>>>,
    public_key: K,
    is_paused: Arc<AtomicBool>,
}

A communication channel to the Push CDN, which is a collection of brokers and a marshal that helps organize them all. Is generic over both the type of key and the network protocol.

Fields

client: Client<ClientDef<K>>

The underlying client

metrics: Arc<CdnMetricsValue>

The CDN-specific metrics

internal_queue: Arc<Mutex<VecDeque<Vec<u8>>>>

The internal queue for messages to ourselves

public_key: K

The public key of this node

is_paused: Arc<AtomicBool>

Whether or not the underlying network is supposed to be paused

Implementations

impl<K: SignatureKey + 'static> PushCdnNetwork<K>

pub fn new( marshal_endpoint: String, topics: Vec<Topic>, keypair: KeyPair<WrappedSignatureKey<K>>, metrics: CdnMetricsValue, ) -> Result<Self>

Create a new PushCdnNetwork (really a client) from a marshal endpoint, a list of initial topics we are interested in, and our wrapped keypair that we use to authenticate with the marshal.

Errors

If we fail to build the config

async fn broadcast_message( &self, message: Vec<u8>, topic: Topic, ) -> Result<(), NetworkError>

Broadcast a message to members of the particular topic. Does not retry.

Errors

• If we fail to serialize the message
• If we fail to send the broadcast message.

Trait Implementations

impl<K: Clone + SignatureKey + 'static> Clone for PushCdnNetwork<K>

fn clone(&self) -> PushCdnNetwork<K>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: SignatureKey + 'static> ConnectedNetwork<K> for PushCdnNetwork<K>

fn pause(&self)

Pause sending and receiving on the PushCDN network.

fn resume(&self)

Resume sending and receiving on the PushCDN network.

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

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

Wait for the client to initialize the connection

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

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

TODO: shut down the networks. Unneeded for testing.

fn broadcast_message<'life0, 'async_trait>( &'life0 self, message: Vec<u8>, topic: HotShotTopic, _broadcast_delay: BroadcastDelay, ) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>

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

Broadcast a message to all members of the quorum.

Errors

• If we fail to serialize the message
• If we fail to send the broadcast message.

fn da_broadcast_message<'life0, 'async_trait>( &'life0 self, message: Vec<u8>, _recipients: Vec<K>, _broadcast_delay: BroadcastDelay, ) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>

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

Broadcast a message to all members of the DA committee.

Errors

• If we fail to serialize the message
• If we fail to send the broadcast message.

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

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

Send a direct message to a node with a particular key. Does not retry.

• If we fail to serialize the message
• If we fail to send the direct message

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 a message. Is agnostic over transmit_type, which has an issue to be removed anyway.

Errors

• If we fail to receive messages. Will trigger a retry automatically.

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

Do nothing here, as we don’t need to look up nodes.

fn vid_broadcast_message<'life0, 'async_trait>( &'life0 self, messages: HashMap<K, 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 update_view<'a, 'async_trait, TYPES>( &'a self, _view: u64, _epoch: u64, _membership: Arc<RwLock<<TYPES as NodeType>::Membership>>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where 'a: 'async_trait, TYPES: NodeType<SignatureKey = K> + 'a + 'async_trait, Self: '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 is_primary_down(&self) -> bool

Is primary network down? Makes sense only for combined network

impl<TYPES: NodeType> TestableNetworkingImplementation<TYPES> for PushCdnNetwork<TYPES::SignatureKey>

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

Generate n Push CDN clients, a marshal, and two brokers (that run locally). Uses a SQLite database instead of Redis.

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

The PushCDN does not support in-flight message counts