pinger

Documentation

Index

• type NoopPinger
  • func NewNoopPinger() *NoopPinger
  • func (p *NoopPinger) Kill()
  • func (*NoopPinger) Ping()
  • func (p *NoopPinger) Wait() error
• type Pinger
  • func NewPinger(action func(), clock clock.Clock, timeout time.Duration) *Pinger
  • func (pt *Pinger) Kill()
  • func (pt *Pinger) Ping()
  • func (pt *Pinger) Wait() error

Types

type NoopPinger

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

NoopPinger implements the pinger interface, does nothing but waits for heat death of the universe.

func NewNoopPinger

func NewNoopPinger() *NoopPinger

NewNoopPinger returns a new NoopPinger instance.

func (*NoopPinger) Kill

func (p *NoopPinger) Kill()

Kill implements the worker.Worker interface.

func (*NoopPinger) Ping

func (*NoopPinger) Ping()

Ping implements the pinger.Pinger interface.

func (*NoopPinger) Wait

func (p *NoopPinger) Wait() error

Wait implements the worker.Worker interface.

type Pinger

type Pinger struct {
	worker.Worker
	// contains filtered or unexported fields
}

Pinger listens for pings and will call the passed action in case of a timeout. This way broken or inactive connections can be closed.

func NewPinger

func NewPinger(action func(), clock clock.Clock, timeout time.Duration) *Pinger

NewPinger returns a new Pinger instance that invokes the given action asynchronously if there is more than the given timeout interval between calls to its Ping method.

func (*Pinger) Kill

func (pt *Pinger) Kill()

Kill implements the worker.Worker interface.

func (*Pinger) Ping

func (pt *Pinger) Ping()

Ping is used by the client heartbeat monitor and resets the killer.

func (*Pinger) Wait

func (pt *Pinger) Wait() error

Wait implements the worker.Worker interface.