Class HeartbeatSender

Sends the agent heartbeat in a loop and keeps the interval of the answers.

Example

const sender = new HeartbeatSender({
  build: () => buildHeartbeat("online", { details: { protocol_version: 1 } }),
  send: restHeartbeatSend(api),
});
sender.start();
// ...
await sender.stop();

Index

Constructors

constructor

new HeartbeatSender(options: HeartbeatSenderOptions): HeartbeatSender
Creates the sender; nothing is sent before HeartbeatSender.start or HeartbeatSender.beatOnce.
Parameters
- options: HeartbeatSenderOptions
  The build and send callbacks, clock, settings and logger.
Returns HeartbeatSender

Accessors

intervalMs

get intervalMs(): number
The wait between two heartbeats in milliseconds: the last interval_ms of the server.

Returns number

Methods

beatOnce

beatOnce(): Promise<boolean>
Builds and sends one heartbeat now and keeps the interval of the answer.

Returns Promise<boolean>
Whether a heartbeat was sent and accepted; false when build skipped it, or build or the send failed (logged, never thrown).

start

start(): void
Starts the loop: one heartbeat now, then one per interval; a second call does nothing.

Returns void

stop

stop(): Promise<void>
Stops the loop after the heartbeat in flight, if any.

Returns Promise<void>
When the loop has ended.

Class HeartbeatSender

Example

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns HeartbeatSender

Accessors

intervalMs

Returns number

Methods

beatOnce

Returns Promise<boolean>

start

Returns void

stop

Returns Promise<void>

Settings

On This Page