poll

Documentation

Index

• type Factory
  • func NewEarlyTermNoTraversalFactory(alphaPreference int, alphaConfidence int, reg prometheus.Registerer) (Factory, error)
• type Poll
• type Set
  • func NewSet(factory Factory, log logging.Logger, reg prometheus.Registerer) (Set, error)

Types

type Factory

type Factory interface {
	New(vdrs bag.Bag[ids.NodeID]) Poll
}

Factory creates a new Poll

func NewEarlyTermNoTraversalFactory

func NewEarlyTermNoTraversalFactory(
	alphaPreference int,
	alphaConfidence int,
	reg prometheus.Registerer,
) (Factory, error)

NewEarlyTermNoTraversalFactory returns a factory that returns polls with early termination, without doing DAG traversals

type Poll

type Poll interface {
	formatting.PrefixedStringer

	Vote(vdr ids.NodeID, vote ids.ID)
	Drop(vdr ids.NodeID)
	Finished() bool
	Result() bag.Bag[ids.ID]
}

Poll is an outstanding poll

type Set

type Set interface {
	fmt.Stringer

	Add(requestID uint32, vdrs bag.Bag[ids.NodeID]) bool
	Vote(requestID uint32, vdr ids.NodeID, vote ids.ID) []bag.Bag[ids.ID]
	Drop(requestID uint32, vdr ids.NodeID) []bag.Bag[ids.ID]
	Len() int
}

Set is a collection of polls

func NewSet

func NewSet(
	factory Factory,
	log logging.Logger,
	reg prometheus.Registerer,
) (Set, error)

NewSet returns a new empty set of polls