docs(gossip): add comment about message uniqueness (#2140)

This would have spared me some debugging if I knew beforehand. --------- Co-authored-by: Friedel Ziegelmayer <[email protected]>
n0-computer · Apr 4, 2024 · 9fc1266 · 9fc1266
1 parent aa1cf66
commit 9fc1266
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/iroh-gossip/src/net.rs b/iroh-gossip/src/net.rs
@@ -168,6 +168,8 @@ impl Gossip {
     ///
     /// This does not join the topic automatically, so you have to call [`Self::join`] yourself
     /// for messages to be broadcast to peers.
+    ///
+    /// Messages with the same content are only delivered once.
     pub async fn broadcast(&self, topic: TopicId, message: Bytes) -> anyhow::Result<()> {
         let (tx, rx) = oneshot::channel();
         self.send(ToActor::Broadcast(topic, message, Scope::Swarm, tx))