heart

Documentation

Overview

Package heart implements a general purpose pacemaker.

Index

• Variables
• type AtomicTime
  • func (t *AtomicTime) Get() int64
  • func (t *AtomicTime) Set(time time.Time)
  • func (t *AtomicTime) Time() time.Time
• type Pacemaker
  • func NewPacemaker(heartrate time.Duration, pacer func() error) *Pacemaker
  • func (p *Pacemaker) Dead() bool
  • func (p *Pacemaker) Echo()
  • func (p *Pacemaker) StartAsync(wg *sync.WaitGroup) (death chan error)
  • func (p *Pacemaker) Stop()

Variables

var Debug = func(v ...interface{}) {}

Debug is the default logger that Pacemaker uses.

var ErrDead = errors.New("no heartbeat replied")

Types

type AtomicTime

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

AtomicTime is a thread-safe UnixNano timestamp guarded by atomic.

func (*AtomicTime) Get

func (t *AtomicTime) Get() int64

func (*AtomicTime) Set

func (t *AtomicTime) Set(time time.Time)

func (*AtomicTime) Time

func (t *AtomicTime) Time() time.Time

type Pacemaker

type Pacemaker struct {
	// Heartrate is the received duration between heartbeats.
	Heartrate time.Duration

	// Time in nanoseconds, guarded by atomic read/writes.
	SentBeat AtomicTime
	EchoBeat AtomicTime

	// Any callback that returns an error will stop the pacer.
	Pace func() error
	// contains filtered or unexported fields
}

func NewPacemaker

func NewPacemaker(heartrate time.Duration, pacer func() error) *Pacemaker

func (*Pacemaker) Dead

func (p *Pacemaker) Dead() bool

Dead, if true, will have Pace return an ErrDead.

func (*Pacemaker) Echo

func (p *Pacemaker) Echo()

func (*Pacemaker) StartAsync

func (p *Pacemaker) StartAsync(wg *sync.WaitGroup) (death chan error)

StartAsync starts the pacemaker asynchronously. The WaitGroup is optional.

func (*Pacemaker) Stop

func (p *Pacemaker) Stop()