pubsub.go

package iface

import (
	"context"
	"io"

	"github.com/ipfs/interface-go-ipfs-core/options"

	"github.com/libp2p/go-libp2p/core/peer"
)

// PubSubSubscription is an active PubSub subscription
//
// Deprecated: use github.com/ipfs/boxo/coreiface.PubSubSubscription
type PubSubSubscription interface {
	io.Closer

	// Next return the next incoming message
	Next(context.Context) (PubSubMessage, error)
}

// PubSubMessage is a single PubSub message
//
// Deprecated: use github.com/ipfs/boxo/coreiface.PubSubMessage
type PubSubMessage interface {
	// From returns id of a peer from which the message has arrived
	From() peer.ID

	// Data returns the message body
	Data() []byte

	// Seq returns message identifier
	Seq() []byte

	// Topics returns list of topics this message was set to
	Topics() []string
}

// PubSubAPI specifies the interface to PubSub
//
// Deprecated: use github.com/ipfs/boxo/coreiface.PubSubAPI
type PubSubAPI interface {
	// Ls lists subscribed topics by name
	Ls(context.Context) ([]string, error)

	// Peers list peers we are currently pubsubbing with
	Peers(context.Context, ...options.PubSubPeersOption) ([]peer.ID, error)

	// Publish a message to a given pubsub topic
	Publish(context.Context, string, []byte) error

	// Subscribe to messages on a given topic
	Subscribe(context.Context, string, ...options.PubSubSubscribeOption) (PubSubSubscription, error)
}