fluencelabs/rust-libp2p
1
0
Fork 0
mirror of https://github.com/fluencelabs/rust-libp2p synced 2025-05-15 04:11:19 +00:00
Code Issues Projects Releases Wiki Activity

protocols/gossipsub/src/config: Document peer exchange not supported (#2397)

Browse Source
This commit is contained in:
Max Inden 2021-12-22 11:55:23 +01:00 committed by GitHub
parent 17861d9cac
commit 5435539d05
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
protocols/gossipsub/src/config.rs
View File

@ -248,7 +248,10 @@ impl GossipsubConfig {
} }
/// Whether Peer eXchange is enabled; this should be enabled in bootstrappers and other well /// Whether Peer eXchange is enabled; this should be enabled in bootstrappers and other well
/// connected/trusted nodes. The default is true. /// connected/trusted nodes. The default is false.
///
/// Note: Peer exchange is not implemented today, see
/// https://github.com/libp2p/rust-libp2p/issues/2398.
pub fn do_px(&self) -> bool { pub fn do_px(&self) -> bool {
self.do_px self.do_px
} }
@ -602,7 +605,10 @@ impl GossipsubConfigBuilder {
} }
/// Enables Peer eXchange. This should be enabled in bootstrappers and other well /// Enables Peer eXchange. This should be enabled in bootstrappers and other well
/// connected/trusted nodes. The default is true. /// connected/trusted nodes. The default is false.
///
/// Note: Peer exchange is not implemented today, see
/// https://github.com/libp2p/rust-libp2p/issues/2398.
pub fn do_px(&mut self) -> &mut Self { pub fn do_px(&mut self) -> &mut Self {
self.config.do_px = true; self.config.do_px = true;
self self