heartbeat

Documentation

Overview

Package heartbeat implements a remove heartbeat pulse.

Index

• type Heartbeat
  • func New(cfg cfgmodel.HeartbeatConfig, logger *slog.Logger) *Heartbeat
  • func (h *Heartbeat) Start(ctx context.Context)

Types

type Heartbeat

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

Heartbeat can be used to send a request to a URL at a regular interval.

func New

func New(cfg cfgmodel.HeartbeatConfig, logger *slog.Logger) *Heartbeat

New creates a new heartbeat with the given configuration and logger.

func (*Heartbeat) Start

func (h *Heartbeat) Start(ctx context.Context)

Start the heartbeat. It will send a request to the configured URL every interval. This function will block until the context is cancelled.