pubsub

Documentation

Index

• type Message
• type Subscription
• type Topic
  • func NewTopic(topic *libp2p.Topic) *Topic
  • func (t *Topic) Publish(ctx context.Context, data []byte) error
  • func (t *Topic) Subscribe() (Subscription, error)

Types

type Message

type Message interface {
	GetSource() peer.ID
	GetSender() peer.ID
	GetData() []byte
}

Message defines the common interface for go-filecoin message consumers. It's a subset of the go-libp2p-pubsub/pubsub.go Message type.

type Subscription

type Subscription interface {
	// Topic returns this subscription's topic name
	Topic() string
	// Next returns the next message from this subscription
	Next(ctx context.Context) (Message, error)
	// Cancel cancels this subscription
	Cancel()
}

Subscription is a handle to a pubsub subscription. This matches part of the interface to a libp2p.pubsub.Subscription.

type Topic

type Topic struct {
	// contains filtered or unexported fields
}

Topic publishes and subscribes to a libp2p pubsub topic

func NewTopic

func NewTopic(topic *libp2p.Topic) *Topic

NewTopic builds a new topic.

func (*Topic) Publish

func (t *Topic) Publish(ctx context.Context, data []byte) error

Publish publishes to a pubsub topic. It blocks until there is at least one peer on the mesh that can receive the publish.

func (*Topic) Subscribe

func (t *Topic) Subscribe() (Subscription, error)

Subscribe subscribes to a pubsub topic