Interface ConnectionHealthPolicy

interface ConnectionHealthPolicy {
    name?: string;
    health(): number;
    healthIfChanged(): number;
    healthy(): boolean;
    maximumHealth(): number;
    minimumHealth(): number;
    update(connectionHealthData: ConnectionHealthData): void;
}

Implemented by

Index

Properties

Methods

health healthIfChanged healthy maximumHealth minimumHealth update

Properties

`Optional` `Readonly`name

name?: string

A unique readable name for the purpose of logging

Methods

health

health(): number
The current value per this policy for the given connection health data.

Returns number
- Defined in src/connectionhealthpolicy/ConnectionHealthPolicy.ts:32

healthIfChanged

healthIfChanged(): number
The value per this policy or null if it has not changed since the last call.

Returns number
- Defined in src/connectionhealthpolicy/ConnectionHealthPolicy.ts:42

healthy

healthy(): boolean
Whether the current value is considered healthy for the given connection health data.

Returns boolean
- Defined in src/connectionhealthpolicy/ConnectionHealthPolicy.ts:37

maximumHealth

maximumHealth(): number
The maximum possible value.

Returns number
- Defined in src/connectionhealthpolicy/ConnectionHealthPolicy.ts:22

minimumHealth

minimumHealth(): number
The minimum possible value.

Returns number
- Defined in src/connectionhealthpolicy/ConnectionHealthPolicy.ts:17

update

update(connectionHealthData: ConnectionHealthData): void
Updates the policy with the latest data.
Parameters
- connectionHealthData: ConnectionHealthData
Returns void
- Defined in src/connectionhealthpolicy/ConnectionHealthPolicy.ts:27