kicker

Documentation

Index

• type Config
• type Kickable
• type Kicker
• type PollingKicker
  • func (cfg *PollingKicker) NewKicker() Kicker

Types

type Config

type Config interface {
	NewKicker() Kicker
}

Config is a builder of a Kicker.

type Kickable

type Kickable interface {
	Kick()
}

Kickable is an interface of something kickable.

type Kicker

type Kicker interface {
	Start(kickable Kickable)
	Stop() <-chan struct{}
	Ping()
	PollingInterval() uint
}

Kicker is an interface to control frequency of kicking a Kickable object.

type PollingKicker

type PollingKicker struct {
	Interval uint
}

PollingKicker is a builder of a Kicker which kicks a Kickable repeatedly on some interval.

func (*PollingKicker) NewKicker

func (cfg *PollingKicker) NewKicker() Kicker

NewKicker creates a new polling kicker instance.