pubsubManager

Documentation

Index

• Constants
• Variables
• func TopicToCid(topic *Topic) cid.Cid
• type PubsubManager
  • func NewGossipSubManager(ctx context.Context, h host.Host) (*PubsubManager, error)
  • func (g *PubsubManager) Broadcast(location common.Location, data interface{}) error
  • func (g *PubsubManager) GetGenesis() common.Hash
  • func (g *PubsubManager) PeersForTopic(t *Topic) ([]peer.ID, error)
  • func (g *PubsubManager) SetQuaiBackend(consensus quai.ConsensusAPI)
  • func (g *PubsubManager) SetReceiveHandler(receiveCb func(peer.ID, string, string, interface{}, common.Location))
  • func (g *PubsubManager) Stop() error
  • func (g *PubsubManager) Subscribe(topicSub *Topic, location common.Location, datatype interface{}) error
  • func (g *PubsubManager) SubscribeAndRegisterValidator(location common.Location, datatype interface{}, ...) error
  • func (g *PubsubManager) Unsubscribe(location common.Location, datatype interface{}) error
  • func (g *PubsubManager) UnsubscribeAll()
  • func (g *PubsubManager) ValidatorFunc() ...
• type Topic
  • func NewTopic(genesis common.Hash, location common.Location, data interface{}) (*Topic, error)
  • func TopicFromString(topic string) (*Topic, error)
  • func (t *Topic) GetLocation() common.Location
  • func (t *Topic) GetRequestDegree() int
  • func (t *Topic) GetTopicType() interface{}
  • func (t *Topic) String() string

Constants

const (
	// Data types for gossipsub topics
	C_workObjectType                    = "blocks"
	C_transactionType                   = "transactions"
	C_headerType                        = "headers"
	C_workObjectShareType               = "worksharev2"
	C_workObjectRequestDegree           = 3
	C_workObjectHeaderTypeRequestDegree = 3
	C_defaultRequestDegree              = 3
)

Variables

var (
	ErrConsensusNotSet     = errors.New("consensus backend not set")
	ErrValidatorFuncNotSet = errors.New("validator function cannot be initialized")
	ErrNoTopic             = errors.New("no topic for requested data")
	ErrUnsupportedType     = errors.New("data type not supported")
)

Functions

func TopicToCid

func TopicToCid(topic *Topic) cid.Cid

Creates a Cid from a location to be used as DHT key

Types

type PubsubManager

type PubsubManager struct {
	*pubsub.PubSub
	// contains filtered or unexported fields
}

func NewGossipSubManager

func NewGossipSubManager(ctx context.Context, h host.Host) (*PubsubManager, error)

creates a new gossipsub instance TODO: what options do we need for quai network? See: See https://pkg.go.dev/github.com/libp2p/go-libp2p-pubsub@v0.10.0#Option

func (*PubsubManager) Broadcast

func (g *PubsubManager) Broadcast(location common.Location, data interface{}) error

broadcasts data to subscribing peers

func (*PubsubManager) GetGenesis

func (g *PubsubManager) GetGenesis() common.Hash

func (*PubsubManager) PeersForTopic

func (g *PubsubManager) PeersForTopic(t *Topic) ([]peer.ID, error)

lists our peers which provide the associated topic

func (*PubsubManager) SetQuaiBackend

func (g *PubsubManager) SetQuaiBackend(consensus quai.ConsensusAPI)

func (*PubsubManager) SetReceiveHandler

func (g *PubsubManager) SetReceiveHandler(receiveCb func(peer.ID, string, string, interface{}, common.Location))

func (*PubsubManager) Stop

func (g *PubsubManager) Stop() error

func (*PubsubManager) Subscribe

func (g *PubsubManager) Subscribe(topicSub *Topic, location common.Location, datatype interface{}) error

subscribe to broadcasts of the given type of data

func (*PubsubManager) SubscribeAndRegisterValidator

func (g *PubsubManager) SubscribeAndRegisterValidator(location common.Location, datatype interface{}, validatorFunc pubsub.ValidatorEx) error

func (*PubsubManager) Unsubscribe

func (g *PubsubManager) Unsubscribe(location common.Location, datatype interface{}) error

unsubscribe from broadcasts of the given type of data

func (*PubsubManager) UnsubscribeAll

func (g *PubsubManager) UnsubscribeAll()

func (*PubsubManager) ValidatorFunc

func (g *PubsubManager) ValidatorFunc() func(ctx context.Context, id p2p.PeerID, msg *pubsub.Message) pubsub.ValidationResult

type Topic

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

func NewTopic

func NewTopic(genesis common.Hash, location common.Location, data interface{}) (*Topic, error)

gets the name of the topic for the given type of data

func TopicFromString

func TopicFromString(topic string) (*Topic, error)

func (*Topic) GetLocation

func (t *Topic) GetLocation() common.Location

func (*Topic) GetRequestDegree

func (t *Topic) GetRequestDegree() int

func (*Topic) GetTopicType

func (t *Topic) GetTopicType() interface{}

func (*Topic) String

func (t *Topic) String() string