hive

Documentation

Overview

Package hive exposes the hive protocol implementation which is the discovery protocol used to inform and be informed about other peers in the network. It gossips about all peers by default and performs no specific prioritization about which peers are gossipped to others.

Index

• Variables
• type Service
  • func New(streamer p2p.StreamerPinger, addressbook addressbook.GetPutter, ...) (*Service, error)
  • func (s *Service) BroadcastPeers(ctx context.Context, addressee boson.Address, peers ...boson.Address) error
  • func (s *Service) Close() error
  • func (s *Service) DoFindNode(ctx context.Context, target, peer boson.Address, pos []int32, limit int32) (res chan boson.Address, err error)
  • func (s *Service) IsHive2() bool
  • func (s *Service) IsStart() bool
  • func (s *Service) Metrics() []prometheus.Collector
  • func (s *Service) NotifyDiscoverWork(peers ...boson.Address)
  • func (s *Service) Protocol() p2p.ProtocolSpec
  • func (s *Service) SetAddPeersHandler(h func(addr ...boson.Address))
  • func (s *Service) Start()

Variables

var (
	ErrRateLimitExceeded = errors.New("rate limit exceeded")
)

Types

type Service

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

func New

func New(streamer p2p.StreamerPinger, addressbook addressbook.GetPutter, networkID uint64, bootnode bool, allowPrivateCIDRs bool, logger logging.Logger) (*Service, error)

func (*Service) BroadcastPeers

func (s *Service) BroadcastPeers(ctx context.Context, addressee boson.Address, peers ...boson.Address) error

func (*Service) Close

func (s *Service) Close() error

func (*Service) DoFindNode

func (s *Service) DoFindNode(ctx context.Context, target, peer boson.Address, pos []int32, limit int32) (res chan boson.Address, err error)

func (*Service) IsHive2

func (s *Service) IsHive2() bool

func (*Service) IsStart

func (s *Service) IsStart() bool

func (*Service) Metrics

func (s *Service) Metrics() []prometheus.Collector

func (*Service) NotifyDiscoverWork

func (s *Service) NotifyDiscoverWork(peers ...boson.Address)

func (*Service) Protocol

func (s *Service) Protocol() p2p.ProtocolSpec

func (*Service) SetAddPeersHandler

func (s *Service) SetAddPeersHandler(h func(addr ...boson.Address))

func (*Service) Start

func (s *Service) Start()