Class BaseConnectionHealthPolicy

Hierarchy

BaseConnectionHealthPolicy

Implements

ConnectionHealthPolicy

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BaseConnectionHealthPolicy(configuration: ConnectionHealthPolicyConfiguration, data: ConnectionHealthData, name?: string): BaseConnectionHealthPolicy

- Defined in src/connectionhealthpolicy/BaseConnectionHealthPolicy.ts:13
Parameters
- configuration: ConnectionHealthPolicyConfiguration
- data: ConnectionHealthData
- Optional name: string
Returns BaseConnectionHealthPolicy

Properties

Protected currentData

currentData: ConnectionHealthData

Protected currentHealth

currentHealth: number

Protected maxHealth

maxHealth: number

Protected minHealth

minHealth: number

Optional Readonly name

name: string

A unique readable name for the purpose of logging

Methods

getConnectionHealthData

getConnectionHealthData(): ConnectionHealthData

- Defined in src/connectionhealthpolicy/BaseConnectionHealthPolicy.ts:43
Returns ConnectionHealthData

health

health(): number

Implementation of ConnectionHealthPolicy.health
- Defined in src/connectionhealthpolicy/BaseConnectionHealthPolicy.ts:35
The current value per this policy for the given connection health data.

Returns number

healthIfChanged

healthIfChanged(): number

Implementation of ConnectionHealthPolicy.healthIfChanged
- Defined in src/connectionhealthpolicy/BaseConnectionHealthPolicy.ts:51
The value per this policy or null if it has not changed since the last call.

Returns number

healthy

healthy(): boolean

Implementation of ConnectionHealthPolicy.healthy
- Defined in src/connectionhealthpolicy/BaseConnectionHealthPolicy.ts:47
Whether the current value is considered healthy for the given connection health data.

Returns boolean

maximumHealth

maximumHealth(): number

Implementation of ConnectionHealthPolicy.maximumHealth
- Defined in src/connectionhealthpolicy/BaseConnectionHealthPolicy.ts:31
The maximum possible value.

Returns number

minimumHealth

minimumHealth(): number

Implementation of ConnectionHealthPolicy.minimumHealth
- Defined in src/connectionhealthpolicy/BaseConnectionHealthPolicy.ts:27
The minimum possible value.

Returns number

update

update(connectionHealthData: ConnectionHealthData): void

Implementation of ConnectionHealthPolicy.update
- Defined in src/connectionhealthpolicy/BaseConnectionHealthPolicy.ts:39
Updates the policy with the latest data.

Parameters
- connectionHealthData: ConnectionHealthData
Returns void

Generated using TypeDoc