up

Documentation

Overview

Package up is used to run a function for some duration. If a new function is added while a previous run is still ongoing, nothing new will be executed.

Index

• type Func
• type Probe
  • func New() *Probe
  • func (p *Probe) Do(f Func)
  • func (p *Probe) SetInterval(interval time.Duration)
  • func (p *Probe) Start(interval time.Duration)
  • func (p *Probe) Stop()

Types

type Func

type Func func() error

Func is used to determine if a target is alive. If so this function must return nil.

type Probe

type Probe struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Probe is used to run a single Func until it returns true (indicating a target is healthy). If an Func is already in progress no new one will be added, i.e. there is always a maximum of 1 checks in flight.

func New

func New() *Probe

New returns a pointer to an initialized Probe.

func (*Probe) Do

func (p *Probe) Do(f Func)

Do will probe target, if a probe is already in progress this is a noop.

func (*Probe) SetInterval

func (p *Probe) SetInterval(interval time.Duration)

SetInterval sets the probing interval to be used by upcoming probes initiated with Do.

func (*Probe) Start

func (p *Probe) Start(interval time.Duration)

Start will initialize the probe manager, after which probes can be initiated with Do.

func (*Probe) Stop

func (p *Probe) Stop()

Stop stops the probing.