poll

Documentation

Index

• type Factory
  • func NewEarlyTermNoTraversalFactory(alpha int) Factory
  • func NewNoEarlyTermFactory() Factory
• type Poll
• type Set
  • func NewSet(factory Factory, log logging.Logger, namespace string, ...) Set

Types

type Factory

type Factory interface {
	New(vdrs ids.ShortBag) Poll
}

Factory creates a new Poll

func NewEarlyTermNoTraversalFactory

func NewEarlyTermNoTraversalFactory(alpha int) Factory

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

func NewNoEarlyTermFactory

func NewNoEarlyTermFactory() Factory

NewNoEarlyTermFactory returns a factory that returns polls with no early termination

type Poll

type Poll interface {
	fmt.Stringer
	PrefixedString(string) string

	Vote(vdr ids.ShortID, vote ids.ID)
	Drop(vdr ids.ShortID)
	Finished() bool
	Result() ids.Bag
}

Poll is an outstanding poll

type Set

type Set interface {
	fmt.Stringer

	Add(requestID uint32, vdrs ids.ShortBag) bool
	Vote(requestID uint32, vdr ids.ShortID, vote ids.ID) (ids.Bag, bool)
	Drop(requestID uint32, vdr ids.ShortID) (ids.Bag, bool)
	Len() int
}

Set is a collection of polls

func NewSet

func NewSet(
	factory Factory,
	log logging.Logger,
	namespace string,
	registerer prometheus.Registerer,
) Set

NewSet returns a new empty set of polls