trigger

Documentation

Index

• type Callback
• type Trigger
  • func NewPulse(delay time.Duration, callback Callback) (Trigger, error)
  • func NewRecurring(period time.Duration, callback Callback) (Trigger, error)

Types

type Callback

type Callback func() error

Callback used as a trigger execution process.

type Trigger

type Trigger interface {
	Close()
	Timer() time.Duration
	IsStopped() bool
	Stop()
}

Trigger defines the interface of a trigger instance

func NewPulse

func NewPulse(delay time.Duration, callback Callback) (Trigger, error)

NewPulse instantiate a new pulse trigger that will execute a callback method after a determined amount of time.

func NewRecurring

func NewRecurring(period time.Duration, callback Callback) (Trigger, error)

NewRecurring instantiate a new trigger that will execute a callback method recurrently with a defined periodicity.