floodsub

Documentation

Index

• Constants
• type FloodSubRouter
  • func (fs *FloodSubRouter) AddPeer(peer.ID, protocol.ID)
  • func (fs *FloodSubRouter) Attach(p *PubSub)
  • func (fs *FloodSubRouter) HandleRPC(rpc *RPC)
  • func (fs *FloodSubRouter) Protocols() []protocol.ID
  • func (fs *FloodSubRouter) Publish(from peer.ID, msg *pb.Message)
  • func (fs *FloodSubRouter) RemovePeer(peer.ID)
• type Message
  • func (m *Message) GetFrom() peer.ID
• type Option
  • func WithValidateThrottle(n int) Option
• type PubSub
  • func NewFloodSub(ctx context.Context, h host.Host, opts ...Option) (*PubSub, error)
  • func NewPubSub(ctx context.Context, h host.Host, rt PubSubRouter, opts ...Option) (*PubSub, error)
  • func (p *PubSub) GetTopics() []string
  • func (p *PubSub) ListPeers(topic string) []peer.ID
  • func (p *PubSub) Publish(topic string, data []byte) error
  • func (p *PubSub) RegisterTopicValidator(topic string, val Validator, opts ...ValidatorOpt) error
  • func (p *PubSub) Subscribe(topic string, opts ...SubOpt) (*Subscription, error)
  • func (p *PubSub) SubscribeByTopicDescriptor(td *pb.TopicDescriptor, opts ...SubOpt) (*Subscription, error)
• type PubSubNotif
  • func (p *PubSubNotif) ClosedStream(n inet.Network, s inet.Stream)
  • func (p *PubSubNotif) Connected(n inet.Network, c inet.Conn)
  • func (p *PubSubNotif) Disconnected(n inet.Network, c inet.Conn)
  • func (p *PubSubNotif) Listen(n inet.Network, _ ma.Multiaddr)
  • func (p *PubSubNotif) ListenClose(n inet.Network, _ ma.Multiaddr)
  • func (p *PubSubNotif) OpenedStream(n inet.Network, s inet.Stream)
• type PubSubRouter
• type RPC
• type SubOpt
• type Subscription
  • func (sub *Subscription) Cancel()
  • func (sub *Subscription) Next(ctx context.Context) (*Message, error)
  • func (sub *Subscription) Topic() string
• type Validator
• type ValidatorOpt
  • func WithValidatorConcurrency(n int) ValidatorOpt
  • func WithValidatorTimeout(timeout time.Duration) ValidatorOpt

Constants

const (
	FloodSubID = protocol.ID("/floodsub/1.0.0")
)

Types

type FloodSubRouter

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

func (*FloodSubRouter) AddPeer

func (fs *FloodSubRouter) AddPeer(peer.ID, protocol.ID)

func (*FloodSubRouter) Attach

func (fs *FloodSubRouter) Attach(p *PubSub)

func (*FloodSubRouter) HandleRPC

func (fs *FloodSubRouter) HandleRPC(rpc *RPC)

func (*FloodSubRouter) Protocols

func (fs *FloodSubRouter) Protocols() []protocol.ID

func (*FloodSubRouter) Publish

func (fs *FloodSubRouter) Publish(from peer.ID, msg *pb.Message)

func (*FloodSubRouter) RemovePeer

func (fs *FloodSubRouter) RemovePeer(peer.ID)

type Message

type Message struct {
	*pb.Message
}

func (*Message) GetFrom

func (m *Message) GetFrom() peer.ID

type Option

type Option func(*PubSub) error

func WithValidateThrottle

func WithValidateThrottle(n int) Option

type PubSub

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

func NewFloodSub

func NewFloodSub(ctx context.Context, h host.Host, opts ...Option) (*PubSub, error)

NewFloodSub returns a new PubSub object using the FloodSubRouter

func NewPubSub

func NewPubSub(ctx context.Context, h host.Host, rt PubSubRouter, opts ...Option) (*PubSub, error)

NewFloodSub returns a new PubSub management object

func (*PubSub) GetTopics

func (p *PubSub) GetTopics() []string

GetTopics returns the topics this node is subscribed to

func (*PubSub) ListPeers

func (p *PubSub) ListPeers(topic string) []peer.ID

ListPeers returns a list of peers we are connected to.

func (*PubSub) Publish

func (p *PubSub) Publish(topic string, data []byte) error

Publish publishes data under the given topic

func (*PubSub) RegisterTopicValidator

func (p *PubSub) RegisterTopicValidator(topic string, val Validator, opts ...ValidatorOpt) error

RegisterTopicValidator registers a validator for topic

func (*PubSub) Subscribe

func (p *PubSub) Subscribe(topic string, opts ...SubOpt) (*Subscription, error)

Subscribe returns a new Subscription for the given topic

func (*PubSub) SubscribeByTopicDescriptor

func (p *PubSub) SubscribeByTopicDescriptor(td *pb.TopicDescriptor, opts ...SubOpt) (*Subscription, error)

SubscribeByTopicDescriptor lets you subscribe a topic using a pb.TopicDescriptor

type PubSubNotif

type PubSubNotif PubSub

func (*PubSubNotif) ClosedStream

func (p *PubSubNotif) ClosedStream(n inet.Network, s inet.Stream)

func (*PubSubNotif) Connected

func (p *PubSubNotif) Connected(n inet.Network, c inet.Conn)

func (*PubSubNotif) Disconnected

func (p *PubSubNotif) Disconnected(n inet.Network, c inet.Conn)

func (*PubSubNotif) Listen

func (p *PubSubNotif) Listen(n inet.Network, _ ma.Multiaddr)

func (*PubSubNotif) ListenClose

func (p *PubSubNotif) ListenClose(n inet.Network, _ ma.Multiaddr)

func (*PubSubNotif) OpenedStream

func (p *PubSubNotif) OpenedStream(n inet.Network, s inet.Stream)

type PubSubRouter

type PubSubRouter interface {
	Protocols() []protocol.ID
	Attach(*PubSub)
	AddPeer(peer.ID, protocol.ID)
	RemovePeer(peer.ID)
	HandleRPC(*RPC)
	Publish(peer.ID, *pb.Message)
}

PubSubRouter is the message router component of PubSub

type RPC

type RPC struct {
	pb.RPC
	// contains filtered or unexported fields
}

type SubOpt

type SubOpt func(sub *Subscription) error

type Subscription

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

func (*Subscription) Cancel

func (sub *Subscription) Cancel()

func (*Subscription) Next

func (sub *Subscription) Next(ctx context.Context) (*Message, error)

func (*Subscription) Topic

func (sub *Subscription) Topic() string

type Validator

type Validator func(context.Context, *Message) bool

Validator is a function that validates a message

type ValidatorOpt

type ValidatorOpt func(addVal *addValReq) error

ValidatorOpt is an option for RegisterTopicValidator

func WithValidatorConcurrency

func WithValidatorConcurrency(n int) ValidatorOpt

WithValidatorConcurrency is an option that sets topic validator throttle

func WithValidatorTimeout

func WithValidatorTimeout(timeout time.Duration) ValidatorOpt

WithValidatorTimeout is an option that sets the topic validator timeout