Struct GossipEngine

pub struct GossipEngine<B: BlockT> { /* private fields */ }

Wraps around an implementation of the Network trait and provides gossiping capabilities on top of it.

Implementations

impl<B: BlockT> GossipEngine<B>

pub fn new<N, S>( network: N, sync: S, notification_service: Box<dyn NotificationService>, protocol: impl Into<ProtocolName>, validator: Arc<dyn Validator<B>>, metrics_registry: Option<&Registry>, ) -> Self

where B: 'static, N: Network<B> + Send + Clone + 'static, S: Syncing<B> + Send + Clone + 'static,

Create a new instance.

pub fn report(&self, who: PeerId, reputation: ReputationChange)

pub fn register_gossip_message(&mut self, topic: B::Hash, message: Vec<u8>)

Registers a message without propagating it to any peers. The message becomes available to new peers or when the service is asked to gossip the message’s topic. No validation is performed on the message, if the message is already expired it should be dropped on the next garbage collection.

pub fn broadcast_topic(&mut self, topic: B::Hash, force: bool)

Broadcast all messages with given topic.

pub fn messages_for(&mut self, topic: B::Hash) -> Receiver<TopicNotification>

Get data of valid, incoming messages for a topic (but might have expired meanwhile).

pub fn send_topic(&mut self, who: &PeerId, topic: B::Hash, force: bool)

Send all messages with given topic to a peer.

pub fn gossip_message(&mut self, topic: B::Hash, message: Vec<u8>, force: bool)

Multicast a message to all peers.

pub fn send_message(&mut self, who: Vec<PeerId>, data: Vec<u8>)

Send addressed message to the given peers. The message is not kept or multicast later on.

pub fn announce(&self, block: B::Hash, associated_data: Option<Vec<u8>>)

Notify everyone we’re connected to that we have the given block.

Note: this method isn’t strictly related to gossiping and should eventually be moved somewhere else.

pub fn take_notification_service(self) -> Box<dyn NotificationService>

Consume GossipEngine and return the notification service.

Trait Implementations

impl<B: BlockT> FusedFuture for GossipEngine<B>

fn is_terminated(&self) -> bool

Returns true if the underlying future should no longer be polled.

impl<B: BlockT> Future for GossipEngine<B>

type Output = ()

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl<B: BlockT> Unpin for GossipEngine<B>