timers

Documentation

Index

• Constants
• type NewEpochTick
  • func (NewEpochTick) MorphEvent()
• type Params
• type Timers
  • func New(p *Params) *Timers
  • func (t *Timers) RegisterHandler(h event.HandlerInfo) error
  • func (t *Timers) ResetEpochTimer()
  • func (t *Timers) Start(ctx context.Context)

Constants

const (
	// EpochTimer is a type for HandlerInfo structure.
	EpochTimer = "EpochTimer"
)

Types

type NewEpochTick

type NewEpochTick struct{}

NewEpochTick is a new epoch local ticker event.

func (NewEpochTick) MorphEvent

func (NewEpochTick) MorphEvent()

MorphEvent implements Event interface.

type Params

type Params struct {
	Log           *zap.Logger
	EpochDuration time.Duration
}

Params for timers instance constructor.

type Timers

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

Timers is a component for local inner ring timers to produce local events.

func New

func New(p *Params) *Timers

New creates instance of timers component.

func (*Timers) RegisterHandler

func (t *Timers) RegisterHandler(h event.HandlerInfo) error

RegisterHandler of local timers events.

func (*Timers) ResetEpochTimer

func (t *Timers) ResetEpochTimer()

ResetEpochTimer to start it again when event has been processed.

func (*Timers) Start

func (t *Timers) Start(ctx context.Context)

Start runs all available local timers.