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.Streamer, addressbook addressbook.GetPutter, networkID uint64, ...) *Service
  • func (s *Service) BroadcastPeers(ctx context.Context, addressee penguin.Address, peers ...penguin.Address) error
  • func (s *Service) Metrics() []prometheus.Collector
  • func (s *Service) Protocol() p2p.ProtocolSpec
  • func (s *Service) SetAddPeersHandler(h func(addr ...penguin.Address))

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.Streamer, addressbook addressbook.GetPutter, networkID uint64, logger logging.Logger) *Service

func (*Service) BroadcastPeers

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

func (*Service) Metrics

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

func (*Service) Protocol

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

func (*Service) SetAddPeersHandler

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