pinger

Documentation

Index

• func Register(registry facade.FacadeRegistry)
• type API
  • func NewAPI(pinger Pinger) *API
  • func (a API) Ping(ctx context.Context)
  • func (a API) Stop(ctx context.Context) error
• type Pinger

Functions

func Register

func Register(registry facade.FacadeRegistry)

Register is called to expose a package of facades onto a given registry.

Types

type API

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

API serves pinger-specific API methods.

func NewAPI

func NewAPI(pinger Pinger) *API

NewAPI builds a new facade for the given backend.

func (API) Ping

func (a API) Ping(ctx context.Context)

Ping is used by the client heartbeat monitor and resets.

func (API) Stop

func (a API) Stop(ctx context.Context) error

Stop stops the pinger.

type Pinger

type Pinger interface {
	worker.Worker
	Ping()
}

Pinger describes a resource that can be pinged and stopped.