status-im
/
go-wakurelay-pubsub
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #145 from libp2p/documentation 

Add documentation for subscribe's non-instanteneous semantics
This commit is contained in:
vyzo 2019-01-11 11:52:41 +02:00 committed by GitHub
parent 51b7501433 41306ab374
commit 4c242f5882
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc.go
View File

@ -1,5 +1,3 @@
package pubsub
// The pubsub package provides facilities for the Publish/Subscribe pattern of message
// propagation, also known as overlay multicast.
// The implementation provides topic-based pubsub, with pluggable routing algorithms.
@ -23,3 +21,4 @@ package pubsub
//
// To subscribe to a topic, use `Subscribe`; this will give you a subscription interface
// from which new messages can be pumped.
package pubsub

6
pubsub.go
View File

@ -718,14 +718,16 @@ type addSubReq struct {
type SubOpt func(sub *Subscription) error
// Subscribe returns a new Subscription for the given topic
// Subscribe returns a new Subscription for the given topic.
// Note that subscription is not an instanteneous operation. It may take some time
// before the subscription is processed by the pubsub main loop and propagated to our peers.
func (p *PubSub) Subscribe(topic string, opts ...SubOpt) (*Subscription, error) {
td := pb.TopicDescriptor{Name: &topic}
return p.SubscribeByTopicDescriptor(&td, opts...)
}
// SubscribeByTopicDescriptor lets you subscribe a topic using a pb.TopicDescriptor
// SubscribeByTopicDescriptor lets you subscribe a topic using a pb.TopicDescriptor.
func (p *PubSub) SubscribeByTopicDescriptor(td *pb.TopicDescriptor, opts ...SubOpt) (*Subscription, error) {
if td.GetAuth().GetMode() != pb.TopicDescriptor_AuthOpts_NONE {
return nil, fmt.Errorf("auth mode not yet supported")