state

Documentation

Index

• type HeightView
  • func NewHeightView(h primitives.BlockHeight, v primitives.View) *HeightView
  • func (hv *HeightView) Height() primitives.BlockHeight
  • func (hv *HeightView) String() string
  • func (hv *HeightView) View() primitives.View
• type State
  • func NewState() *State
  • func (s *State) CancelContextIfHeightViewUnchanged(cancel context.CancelFunc, height primitives.BlockHeight, view primitives.View) (*HeightView, bool)
  • func (s *State) CompareWithEffectiveHeightAndCancel(cancel context.CancelFunc, lastUpdated primitives.BlockHeight, ...) (*HeightView, bool)
  • func (s *State) Height() primitives.BlockHeight
  • func (s *State) HeightView() *HeightView
  • func (s *State) SetHeightAndResetView(ctx context.Context, newHeight primitives.BlockHeight) (*HeightView, error)
  • func (s *State) SetHeightView(ctx context.Context, newHeight primitives.BlockHeight, newView primitives.View) (*HeightView, error)
  • func (s *State) SetView(ctx context.Context, newView primitives.View) (*HeightView, error)
  • func (s *State) View() primitives.View

Types

type HeightView

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

Immutable instance of height+view

func NewHeightView

func NewHeightView(h primitives.BlockHeight, v primitives.View) *HeightView

func (*HeightView) Height

func (hv *HeightView) Height() primitives.BlockHeight

func (*HeightView) String

func (hv *HeightView) String() string

func (*HeightView) View

func (hv *HeightView) View() primitives.View

type State

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

Mutable, goroutine-safe State object

func NewState

func NewState() *State

func (*State) CancelContextIfHeightViewUnchanged

func (s *State) CancelContextIfHeightViewUnchanged(cancel context.CancelFunc, height primitives.BlockHeight, view primitives.View) (*HeightView, bool)

func (*State) CompareWithEffectiveHeightAndCancel

func (s *State) CompareWithEffectiveHeightAndCancel(cancel context.CancelFunc, lastUpdated primitives.BlockHeight, height primitives.BlockHeight) (*HeightView, bool)

func (*State) Height

func (s *State) Height() primitives.BlockHeight

func (*State) HeightView

func (s *State) HeightView() *HeightView

func (*State) SetHeightAndResetView

func (s *State) SetHeightAndResetView(ctx context.Context, newHeight primitives.BlockHeight) (*HeightView, error)

func (*State) SetHeightView

func (s *State) SetHeightView(ctx context.Context, newHeight primitives.BlockHeight, newView primitives.View) (*HeightView, error)

TODO For testing only, so perhaps move it away

func (*State) SetView

func (s *State) SetView(ctx context.Context, newView primitives.View) (*HeightView, error)

func (*State) View

func (s *State) View() primitives.View