timer

Documentation

Index

• Constants
• func ValidateAndCapTimer(delay *durationpb.Duration) error
• type Gate
• type LocalGate
  • func NewLocalGate(timeSource clock.TimeSource) LocalGate
• type LocalGateImpl
  • func (lg *LocalGateImpl) Close()
  • func (lg *LocalGateImpl) FireAfter(now time.Time) bool
  • func (lg *LocalGateImpl) FireCh() <-chan struct{}
  • func (lg *LocalGateImpl) Update(nextTime time.Time) bool
• type RemoteGate
  • func NewRemoteGate() RemoteGate
• type RemoteGateImpl
  • func (rg *RemoteGateImpl) Close()
  • func (rg *RemoteGateImpl) FireAfter(now time.Time) bool
  • func (rg *RemoteGateImpl) FireCh() <-chan struct{}
  • func (rg *RemoteGateImpl) SetCurrentTime(currentTime time.Time) bool
  • func (rg *RemoteGateImpl) Update(nextTime time.Time) bool

Constants

const (
	// MaxAllowedTimer is the maximum allowed timer duration in the system
	// exported for integration tests
	MaxAllowedTimer = 100 * 365 * 24 * time.Hour
)

Functions

func ValidateAndCapTimer

func ValidateAndCapTimer(delay *durationpb.Duration) error

Types

type Gate

type Gate interface {
	// FireCh return the channel which will be fired when time is up
	FireCh() <-chan struct{}
	// FireAfter check will the timer get fired after a certain time
	FireAfter(now time.Time) bool
	// Update the timer gate, return true if update is a success.
	// Success means timer is idle or timer is set with a sooner time to fire
	Update(nextTime time.Time) bool
	// Close shutdown the timer
	Close()
}

Gate interface

type LocalGate

type LocalGate interface {
	Gate
}

func NewLocalGate

func NewLocalGate(timeSource clock.TimeSource) LocalGate

NewLocalGate create a new timer gate instance

type LocalGateImpl

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

func (*LocalGateImpl) Close

func (lg *LocalGateImpl) Close()

Close shutdown the timer

func (*LocalGateImpl) FireAfter

func (lg *LocalGateImpl) FireAfter(now time.Time) bool

FireAfter check will the timer get fired after a certain time

func (*LocalGateImpl) FireCh

func (lg *LocalGateImpl) FireCh() <-chan struct{}

FireCh return the channel which will be fired when time is up

func (*LocalGateImpl) Update

func (lg *LocalGateImpl) Update(nextTime time.Time) bool

Update the timer gate, return true if update is a success. Success means timer is idle or timer is set with a sooner time to fire

type RemoteGate

type RemoteGate interface {
	Gate
	// SetCurrentTime set the current time, and additionally fire the fire chan
	// if new "current" time is after the next wakeup time, return true if
	// "current" is actually updated
	SetCurrentTime(nextTime time.Time) bool
}

func NewRemoteGate

func NewRemoteGate() RemoteGate

NewRemoteGate create a new timer gate instance

type RemoteGateImpl

type RemoteGateImpl struct {

	// lock for timer and next wakeup time
	sync.Mutex
	// contains filtered or unexported fields
}

func (*RemoteGateImpl) Close

func (rg *RemoteGateImpl) Close()

Close shutdown the timer

func (*RemoteGateImpl) FireAfter

func (rg *RemoteGateImpl) FireAfter(now time.Time) bool

FireAfter check will the timer get fired after a certain time

func (*RemoteGateImpl) FireCh

func (rg *RemoteGateImpl) FireCh() <-chan struct{}

FireCh return the channel which will be fired when time is up

func (*RemoteGateImpl) SetCurrentTime

func (rg *RemoteGateImpl) SetCurrentTime(currentTime time.Time) bool

SetCurrentTime set the current time, and additionally fire the fire chan if new "current" time is after the next wake-up time, return true if "current" is actually updated

func (*RemoteGateImpl) Update

func (rg *RemoteGateImpl) Update(nextTime time.Time) bool

Update the timer gate, return true if update is a success. Success means timer is idle or timer is set with a sooner time to fire