Fix the concerns of #603 (#635)

This commit is contained in:
Pierre Krieger
2018-11-14 14:07:54 +01:00
committed by GitHub
parent 513b97b015
commit 24ccefbbc6
3 changed files with 19 additions and 20 deletions

View File

@ -33,7 +33,7 @@ use topic::{Topic, TopicHash};
/// Network behaviour that automatically identifies nodes periodically, and returns information
/// about them.
pub struct FloodsubBehaviour<TSubstream> {
/// Events that need to be produced outside when polling.
/// Events that need to be yielded to the outside when polling.
events: VecDeque<NetworkBehaviorAction<FloodsubRpc, FloodsubMessage>>,
/// Peer id of the local node. Used for the source of the messages that we publish.
@ -44,8 +44,8 @@ pub struct FloodsubBehaviour<TSubstream> {
// opened substream
connected_peers: HashMap<PeerId, SmallVec<[TopicHash; 8]>>,
// List of topics we're subscribed to. Necessary in order to filter out messages that we
// erroneously receive.
// List of topics we're subscribed to. Necessary to filter out messages that we receive
// erroneously.
subscribed_topics: SmallVec<[Topic; 16]>,
// Sequence number for the messages we send.
@ -102,6 +102,8 @@ impl<TSubstream> FloodsubBehaviour<TSubstream> {
/// Unsubscribes from a topic.
///
/// Note that this only requires a `TopicHash` and not a full `Topic`.
///
/// Returns true if we were subscribed to this topic.
pub fn unsubscribe(&mut self, topic: impl AsRef<TopicHash>) -> bool {
let topic = topic.as_ref();
@ -135,7 +137,7 @@ impl<TSubstream> FloodsubBehaviour<TSubstream> {
self.publish_many(iter::once(topic), data)
}
/// Publishes a message to the network that has multiple topics.
/// Publishes a message with multiple topics to the network.
///
/// > **Note**: Doesn't do anything if we're not subscribed to any of the topics.
pub fn publish_many(&mut self, topic: impl IntoIterator<Item = impl Into<TopicHash>>, data: impl Into<Vec<u8>>) {
@ -232,12 +234,12 @@ where
}
// Propagate the message to everyone else who is subscribed to any of the topics.
for (peer_id, sub_topics) in self.connected_peers.iter() {
for (peer_id, subscr_topics) in self.connected_peers.iter() {
if peer_id == &propagation_source {
continue;
}
if !sub_topics.iter().any(|t| message.topics.iter().any(|u| t == u)) {
if !subscr_topics.iter().any(|t| message.topics.iter().any(|u| t == u)) {
continue;
}