consensusreference

Documentation

Index

• type ConsensusReference
  • func NewConsensusReference(consensus **external.Consensus) ConsensusReference
  • func (ref ConsensusReference) Consensus() external.Consensus

Types

type ConsensusReference

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

ConsensusReference holds a reference to a consensus object. The consensus object may be swapped with a new one entirely during the IBD process. Before an atomic consensus operation, callers are expected to call Consensus() once and work against that instance throughout.

func NewConsensusReference

func NewConsensusReference(consensus **external.Consensus) ConsensusReference

NewConsensusReference constructs a new ConsensusReference

func (ConsensusReference) Consensus

func (ref ConsensusReference) Consensus() external.Consensus

Consensus returns the underlying consensus