synchronization

Documentation

Index

• Variables
• type BlockTracker
  • func NewBlockTracker(parent log.Logger, startingHeight uint64, graceDist uint16) *BlockTracker
  • func (t *BlockTracker) IncrementTo(height primitives.BlockHeight)
  • func (t *BlockTracker) WaitForBlock(ctx context.Context, requestedHeight primitives.BlockHeight) error
• type NopHeightReporter
  • func (_ NopHeightReporter) IncrementTo(height primitives.BlockHeight)
• type PeriodicalTrigger
  • func NewPeriodicalTrigger(ctx context.Context, name string, ticker Ticker, logger logfields.Errorer, ...) *PeriodicalTrigger
  • func (t *PeriodicalTrigger) Stop()
• type Ticker
  • func NewTimeTicker(d time.Duration) Ticker
• type Timer
  • func NewTimer(d time.Duration) *Timer
  • func NewTimerWithManualTick() *Timer
  • func (t *Timer) GetTimer() *time.Timer
  • func (t *Timer) ManualTick()
  • func (t *Timer) Reset(d time.Duration) bool
  • func (t *Timer) Stop() bool

Variables

var LogTag = log.Service("block-tracker")

Types

type BlockTracker

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

func NewBlockTracker

func NewBlockTracker(parent log.Logger, startingHeight uint64, graceDist uint16) *BlockTracker

func (*BlockTracker) IncrementTo

func (t *BlockTracker) IncrementTo(height primitives.BlockHeight)

func (*BlockTracker) WaitForBlock

func (t *BlockTracker) WaitForBlock(ctx context.Context, requestedHeight primitives.BlockHeight) error

waits until we reach a block at the specified height, or until the context is closed to wait until some timeout, pass a child context with a deadline

type NopHeightReporter

type NopHeightReporter struct{}

shim for BlockWriter

func (NopHeightReporter) IncrementTo

func (_ NopHeightReporter) IncrementTo(height primitives.BlockHeight)

type PeriodicalTrigger

type PeriodicalTrigger struct {
	govnr.TreeSupervisor

	Closed govnr.ContextEndedChan
	// contains filtered or unexported fields
}

the trigger is coupled with supervized package, this feels okay for now

func NewPeriodicalTrigger

func NewPeriodicalTrigger(ctx context.Context, name string, ticker Ticker, logger logfields.Errorer, trigger func(), onStop func()) *PeriodicalTrigger

func (*PeriodicalTrigger) Stop

func (t *PeriodicalTrigger) Stop()

type Ticker

type Ticker interface {
	// The channel on which the ticks are delivered.
	C() <-chan time.Time
	// Stop turns off a ticker. After Stop, no more ticks will be sent.
	// Stop does not close the channel, to prevent a concurrent goroutine
	// reading from the channel from seeing an erroneous "tick".
	Stop()
}

proxy interface for time.Ticker

func NewTimeTicker

func NewTimeTicker(d time.Duration) Ticker

type Timer

type Timer struct {
	C <-chan time.Time
	// contains filtered or unexported fields
}

This struct comes to work around the timer channel issue: https://github.com/golang/go/issues/11513 Google couldn't break the API or behavior, so they documented it https://github.com/golang/go/issues/14383 we just wrap the timer so we can reset and stop as expected without the workaround of the channel issue.

func NewTimer

func NewTimer(d time.Duration) *Timer

func NewTimerWithManualTick

func NewTimerWithManualTick() *Timer

used primarily for tests

func (*Timer) GetTimer

func (t *Timer) GetTimer() *time.Timer

func (*Timer) ManualTick

func (t *Timer) ManualTick()

used primarily for tests

func (*Timer) Reset

func (t *Timer) Reset(d time.Duration) bool

func (*Timer) Stop

func (t *Timer) Stop() bool