trigger

Documentation

Index

• type Callback
• type Trigger
  • func NewPulseTrigger(delay time.Duration, callback Callback) (Trigger, error)
  • func NewRecurringTrigger(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 {
	io.Closer
	Timer() time.Duration
	IsStopped() bool
	Stop() error
}

Trigger defines the interface of a trigger instance

func NewPulseTrigger

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

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

func NewRecurringTrigger

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

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