proposal

Documentation

Index

• type Cache
  • func NewCache(backend Reader) *Cache
  • func (cache *Cache) Backend() Reader
  • func (cache *Cache) Flush(output Writer, backend Reader) error
  • func (cache *Cache) GetProposal(proposalHash []byte) (*payload.Ballot, error)
  • func (cache *Cache) RemoveProposal(proposalHash []byte) error
  • func (cache *Cache) Reset(backend Reader)
  • func (cache *Cache) Sync(state Writer) error
  • func (cache *Cache) UpdateProposal(proposalHash []byte, ballot *payload.Ballot) error
• type Iterable
• type IterableReader
• type IterableReaderWriter
• type ProposalHash
• type ProposalHashArray
  • func (p ProposalHashArray) Len() int
  • func (p ProposalHashArray) Less(i, j int) bool
  • func (p ProposalHashArray) Swap(i, j int)
• type Reader
• type ReaderWriter
• type Writer

Types

type Cache

type Cache struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

The Cache helps prevent unnecessary IAVLTree updates and garbage generation.

func NewCache

func NewCache(backend Reader) *Cache

Returns a Cache that wraps an underlying NameRegCacheGetter to use on a cache miss, can write to an output Writer via Sync. Not goroutine safe, use syncStateCache if you need concurrent access

func (*Cache) Backend

func (cache *Cache) Backend() Reader

func (*Cache) Flush

func (cache *Cache) Flush(output Writer, backend Reader) error

Syncs the Cache and Resets it to use Writer as the backend Reader

func (*Cache) GetProposal

func (cache *Cache) GetProposal(proposalHash []byte) (*payload.Ballot, error)

func (*Cache) RemoveProposal

func (cache *Cache) RemoveProposal(proposalHash []byte) error

func (*Cache) Reset

func (cache *Cache) Reset(backend Reader)

Resets the cache to empty initialising the backing map to the same size as the previous iteration.

func (*Cache) Sync

func (cache *Cache) Sync(state Writer) error

Writes whatever is in the cache to the output Writer state. Does not flush the cache, to do that call Reset() after Sync or use Flusth if your wish to use the output state as your next backend

func (*Cache) UpdateProposal

func (cache *Cache) UpdateProposal(proposalHash []byte, ballot *payload.Ballot) error

type Iterable

type Iterable interface {
	IterateProposals(consumer func(proposalHash []byte, proposal *payload.Ballot) error) (err error)
}

type IterableReader

type IterableReader interface {
	Iterable
	Reader
}

type IterableReaderWriter

type IterableReaderWriter interface {
	Iterable
	ReaderWriter
}

type ProposalHash

type ProposalHash [sha256.Size]byte

type ProposalHashArray

type ProposalHashArray []ProposalHash

func (ProposalHashArray) Len

func (p ProposalHashArray) Len() int

func (ProposalHashArray) Less

func (p ProposalHashArray) Less(i, j int) bool

func (ProposalHashArray) Swap

func (p ProposalHashArray) Swap(i, j int)

type Reader

type Reader interface {
	GetProposal(proposalHash []byte) (*payload.Ballot, error)
}

type ReaderWriter

type ReaderWriter interface {
	Reader
	Writer
}

type Writer

type Writer interface {
	// Updates the name entry creating it if it does not exist
	UpdateProposal(proposalHash []byte, proposal *payload.Ballot) error
	// Remove the name entry
	RemoveProposal(proposalHash []byte) error
}