gossip

Documentation

Index

• Variables
• func ResetBloomFilterIfNeeded(bloomFilter *BloomFilter, falsePositiveProbability float64) (bool, error)
• type BloomFilter
  • func NewBloomFilter(maxExpectedElements uint64, falsePositiveProbability float64) (*BloomFilter, error)
  • func (b *BloomFilter) Add(gossipable Gossipable)
  • func (b *BloomFilter) Has(gossipable Gossipable) bool
• type Config
• type Gossipable
• type GossipableAny
• type Gossiper
  • func NewGossiper[T any, U GossipableAny[T]](config Config, log logging.Logger, set Set[U], client *p2p.Client) *Gossiper[T, U]
  • func (g *Gossiper[_, _]) Gossip(ctx context.Context)
• type Handler
  • func NewHandler[T Gossipable](set Set[T], maxResponseSize int) *Handler[T]
  • func (h Handler[T]) AppRequest(_ context.Context, _ ids.NodeID, _ time.Time, requestBytes []byte) ([]byte, error)
• type Set

Variables

var (
	ErrInvalidID = errors.New("invalid id")
)

Functions

func ResetBloomFilterIfNeeded

func ResetBloomFilterIfNeeded(
	bloomFilter *BloomFilter,
	falsePositiveProbability float64,
) (bool, error)

ResetBloomFilterIfNeeded resets a bloom filter if it breaches a target false positive probability. Returns true if the bloom filter was reset.

Types

type BloomFilter

type BloomFilter struct {
	Bloom *bloomfilter.Filter
	// Salt is provided to eventually unblock collisions in Bloom. It's possible
	// that conflicting Gossipable items collide in the bloom filter, so a salt
	// is generated to eventually resolve collisions.
	Salt ids.ID
}

func NewBloomFilter

func NewBloomFilter(
	maxExpectedElements uint64,
	falsePositiveProbability float64,
) (*BloomFilter, error)

NewBloomFilter returns a new instance of a bloom filter with at most [maxExpectedElements] elements anticipated at any moment, and a false positive probability of [falsePositiveProbability].

func (*BloomFilter) Add

func (b *BloomFilter) Add(gossipable Gossipable)

func (*BloomFilter) Has

func (b *BloomFilter) Has(gossipable Gossipable) bool

type Config

type Config struct {
	Frequency time.Duration
	PollSize  int
}

type Gossipable

type Gossipable interface {
	GetID() ids.ID
	Marshal() ([]byte, error)
	Unmarshal(bytes []byte) error
}

Gossipable is an item that can be gossiped across the network

type GossipableAny

type GossipableAny[T any] interface {
	*T
	Gossipable
}

GossipableAny exists to help create non-nil pointers to a concrete Gossipable ref: https://stackoverflow.com/questions/69573113/how-can-i-instantiate-a-non-nil-pointer-of-type-argument-with-generic-go

type Gossiper

type Gossiper[T any, U GossipableAny[T]] struct {
	// contains filtered or unexported fields
}

func NewGossiper

func NewGossiper[T any, U GossipableAny[T]](
	config Config,
	log logging.Logger,
	set Set[U],
	client *p2p.Client,
) *Gossiper[T, U]

func (*Gossiper[_, _]) Gossip

func (g *Gossiper[_, _]) Gossip(ctx context.Context)

type Handler

type Handler[T Gossipable] struct {
	p2p.Handler
	// contains filtered or unexported fields
}

func NewHandler

func NewHandler[T Gossipable](set Set[T], maxResponseSize int) *Handler[T]

func (Handler[T]) AppRequest

func (h Handler[T]) AppRequest(_ context.Context, _ ids.NodeID, _ time.Time, requestBytes []byte) ([]byte, error)

type Set

type Set[T Gossipable] interface {
	// Add adds a Gossipable to the set
	Add(gossipable T) error
	// Iterate iterates over elements until [f] returns false
	Iterate(f func(gossipable T) bool)
	// GetFilter returns the byte representation of bloom filter and its
	// corresponding salt.
	GetFilter() (bloom []byte, salt []byte, err error)
}

Set holds a set of known Gossipable items