Class ReconnectionHealthPolicy

Hierarchy

BaseConnectionHealthPolicy
- ReconnectionHealthPolicy

Implements

ConnectionHealthPolicy

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ReconnectionHealthPolicy(logger: Logger, configuration: ConnectionHealthPolicyConfiguration, data: ConnectionHealthData): ReconnectionHealthPolicy

Overrides BaseConnectionHealthPolicy.constructor
- Defined in src/connectionhealthpolicy/ReconnectionHealthPolicy.ts:19
Parameters
- logger: Logger
- configuration: ConnectionHealthPolicyConfiguration
- data: ConnectionHealthData
Returns ReconnectionHealthPolicy

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

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

health

health(): number

Implementation of ConnectionHealthPolicy.health

Overrides BaseConnectionHealthPolicy.health
- Defined in src/connectionhealthpolicy/ReconnectionHealthPolicy.ts:36
The current value per this policy for the given connection health data.

Returns number

healthIfChanged

healthIfChanged(): number

Implementation of ConnectionHealthPolicy.healthIfChanged

Inherited from BaseConnectionHealthPolicy.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

Inherited from BaseConnectionHealthPolicy.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

Inherited from BaseConnectionHealthPolicy.maximumHealth
- Defined in src/connectionhealthpolicy/BaseConnectionHealthPolicy.ts:31
The maximum possible value.

Returns number

minimumHealth

minimumHealth(): number

Implementation of ConnectionHealthPolicy.minimumHealth

Inherited from BaseConnectionHealthPolicy.minimumHealth
- Defined in src/connectionhealthpolicy/BaseConnectionHealthPolicy.ts:27
The minimum possible value.

Returns number

update

update(connectionHealthData: ConnectionHealthData): void

Implementation of ConnectionHealthPolicy.update

Inherited from BaseConnectionHealthPolicy.update
- Defined in src/connectionhealthpolicy/BaseConnectionHealthPolicy.ts:39
Updates the policy with the latest data.

Parameters
- connectionHealthData: ConnectionHealthData
Returns void

Generated using TypeDoc