heartbeat

Documentation

Overview

Package heartbeat provides a service for sending heartbeats to a server.

Index

• Constants
• func Beat(ctx context.Context, log log.Logger, url string, payload *Payload) error
• type Payload

Constants

const SendInterval = 10 * time.Minute

SendInterval determines the delay between requests. This must be larger than the MinHeartbeatInterval in the server.

Functions

func Beat

func Beat(
	ctx context.Context,
	log log.Logger,
	url string,
	payload *Payload,
) error

Beat sends a heartbeat to the server at the given URL. It will send a heartbeat immediately, and then every SendInterval. Beat spawns a goroutine that will send heartbeats until the context is canceled.

Types

type Payload

type Payload struct {
	Version string `json:"version"`
	Meta    string `json:"meta"`
	Moniker string `json:"moniker"`
	PeerID  string `json:"peerID"`
	ChainID uint64 `json:"chainID"`
}