f9c26c2e68
When the WithDiscovery option is passed to PubSub then PubSub will be able to search for more peers that are interested in our topics. This includes the ability for Publishes (via Topic.Publish()) to block until the router is ready to publish. When a router is ready is currently defined by a combination of a user defined MinTopicSize function (passed into topic.Publish via the WithReadiness publish option) and the properties of the pubsub router used. The discovery tests show example usage.
go-libp2p-pubsub
A pubsub system with flooding and gossiping variants.
This is the canonical pubsub implementation for libp2p.
We currently provide three implementations:
- floodsub, which is the baseline flooding protocol.
- gossipsub, which is a more advanced router with mesh formation and gossip propagation. See spec and implementation for more details.
- randomsub, which is a simple probabilistic router that propagates to random subsets of peers.
Table of Contents
Install
go get github.com/libp2p/go-libp2p-pubsub
Usage
To be used for messaging in p2p instrastructure (as part of libp2p) such as IPFS, Ethereum, other blockchains, etc.
Implementations
See libp2p/specs/pubsub#Implementations.
Documentation
See the libp2p specs for high level documentation and godoc for API documentation.
Contribute
Contributions welcome. Please check out the issues.
Check out our contributing document for more information on how we work, and about contributing in general. Please be aware that all interactions related to multiformats are subject to the IPFS Code of Conduct.
Small note: If editing the README, please conform to the standard-readme specification.
License
MIT © Jeromy Johnson
The last gx published version of this module was: 0.11.16: QmfB4oDUTiaGEqT13P1JqCEhqW7cB1wpKtq3PP4BN8PhQd