timesync

Documentation

Index

• type LayerConverter
  • func (lc LayerConverter) LayerToTime(id types.LayerID) time.Time
  • func (lc LayerConverter) TimeToLayer(t time.Time) types.LayerID
• type NodeClock
  • func NewClock(opts ...OptionFunc) (*NodeClock, error)
  • func (t *NodeClock) AwaitLayer(layerID types.LayerID) <-chan struct{}
  • func (t *NodeClock) Close()
  • func (t *NodeClock) CurrentLayer() types.LayerID
  • func (t *NodeClock) GenesisTime() time.Time
• type OptionFunc
  • func WithGenesisTime(genesis time.Time) OptionFunc
  • func WithLayerDuration(d time.Duration) OptionFunc
  • func WithLogger(logger *zap.Logger) OptionFunc
  • func WithTickInterval(d time.Duration) OptionFunc

Types

type LayerConverter

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

LayerConverter is a converter between time to layer ID struct.

func (LayerConverter) LayerToTime

func (lc LayerConverter) LayerToTime(id types.LayerID) time.Time

LayerToTime returns the time of the provided layer.

func (LayerConverter) TimeToLayer

func (lc LayerConverter) TimeToLayer(t time.Time) types.LayerID

TimeToLayer returns the layer of the provided time.

type NodeClock

type NodeClock struct {
	LayerConverter // layer conversions provider
	// contains filtered or unexported fields
}

NodeClock is the struct holding a real clock.

func NewClock

func NewClock(opts ...OptionFunc) (*NodeClock, error)

NewClock return TimeClock struct that notifies tickInterval has passed.

func (*NodeClock) AwaitLayer

func (t *NodeClock) AwaitLayer(layerID types.LayerID) <-chan struct{}

AwaitLayer returns a channel that will be signaled when layer id layerID was ticked by the clock, or if this layer has passed while sleeping. It does so by closing the returned channel.

func (*NodeClock) Close

func (t *NodeClock) Close()

Close closes the clock ticker.

func (*NodeClock) CurrentLayer

func (t *NodeClock) CurrentLayer() types.LayerID

CurrentLayer gets the current layer.

func (*NodeClock) GenesisTime

func (t *NodeClock) GenesisTime() time.Time

GenesisTime returns at which time this clock has started (used to calculate current tick).

type OptionFunc

type OptionFunc func(*option) error

func WithGenesisTime

func WithGenesisTime(genesis time.Time) OptionFunc

WithGenesisTime sets the genesis time for the NodeClock.

func WithLayerDuration

func WithLayerDuration(d time.Duration) OptionFunc

WithLayerDuration sets the layer duration for the NodeClock.

func WithLogger

func WithLogger(logger *zap.Logger) OptionFunc

WithLogger sets the logger for the NodeClock.

func WithTickInterval

func WithTickInterval(d time.Duration) OptionFunc