clock

Documentation

Index

• type Clock
  • func New(opt ...Option) *Clock
  • func (c *Clock) Advance(t time.Time)
  • func (c *Clock) After(d time.Duration, callback func()) (cancel func())
  • func (c *Clock) Ticker(d time.Duration, callback func()) (cancel func())
  • func (c *Clock) Timestep() time.Duration
• type Option
  • func WithTick(d time.Duration) Option

Types

type Clock

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

func New

func New(opt ...Option) *Clock

func (*Clock) Advance

func (c *Clock) Advance(t time.Time)

func (*Clock) After

func (c *Clock) After(d time.Duration, callback func()) (cancel func())

func (*Clock) Ticker

func (c *Clock) Ticker(d time.Duration, callback func()) (cancel func())

func (*Clock) Timestep

func (c *Clock) Timestep() time.Duration

type Option

type Option func(c *Clock)

func WithTick

func WithTick(d time.Duration) Option

WithTick sets the time-step for thes simulation clock. This is effectively precision with which the resulting clock is able to measure time. A smaller time-step is more CPU-efficient. If d < 0, defaults to millisecond precision.

There is a trade-off between performance and precision such that a larger tick interval will reduce the load on the CPU when there are many events in the clock, at the expense of a