state

Documentation

Index

• type HeightView
  • func NewHeightView(h primitives.BlockHeight, v primitives.View) *HeightView
  • func (hv *HeightView) Height() primitives.BlockHeight
  • func (hv *HeightView) OlderThan(otherHv *HeightView) bool
  • func (hv *HeightView) String() string
  • func (hv *HeightView) View() primitives.View
• type State
  • func NewState() *State
  • func (s *State) GcOldContexts()
  • func (s *State) Height() primitives.BlockHeight
  • func (s *State) HeightView() *HeightView
  • func (s *State) SetHeightAndResetView(newHeight primitives.BlockHeight) (*HeightView, error)
  • func (s *State) SetHeightView(ctx context.Context, newHeight primitives.BlockHeight, newView primitives.View) (*HeightView, error)
  • func (s *State) SetView(newView primitives.View) (*HeightView, error)
  • func (s *State) View() primitives.View
• type ViewContexts
  • func NewViewContexts() *ViewContexts
  • func (w *ViewContexts) CancelOlderThan(hv *HeightView)
  • func (w *ViewContexts) For(hv *HeightView) (context.Context, error)
  • func (w *ViewContexts) Shutdown()

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) OlderThan

func (hv *HeightView) OlderThan(otherHv *HeightView) bool

func (*HeightView) String

func (hv *HeightView) String() string

func (*HeightView) View

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

type State

type State struct {
	sync.RWMutex

	Contexts *ViewContexts
	// contains filtered or unexported fields
}

Mutable, goroutine-safe State object

func NewState

func NewState() *State

func (*State) GcOldContexts

func (s *State) GcOldContexts()

func (*State) Height

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

func (*State) HeightView

func (s *State) HeightView() *HeightView

func (*State) SetHeightAndResetView

func (s *State) SetHeightAndResetView(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(newView primitives.View) (*HeightView, error)

func (*State) View

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

type ViewContexts

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

func NewViewContexts

func NewViewContexts() *ViewContexts

func (*ViewContexts) CancelOlderThan

func (w *ViewContexts) CancelOlderThan(hv *HeightView)

func (*ViewContexts) For

func (w *ViewContexts) For(hv *HeightView) (context.Context, error)

func (*ViewContexts) Shutdown

func (w *ViewContexts) Shutdown()