RunnerHealth.ts overview

Since v1.0.0

Exports Grouped by Category

• Constructors
  • make
  • makePing
• layers
  • layer
  • layerNoop
  • layerRpc
• models
  • RunnerHealth (class)

Constructors

make

Signature

declare const make: (options: {
  readonly isAlive: (address: RunnerAddress) => Effect.Effect<boolean>
}) => Effect.Effect<RunnerHealth["Type"], never, Scope.Scope>

Source

Since v1.0.0

makePing

Signature

declare const makePing: Effect.Effect<
  {
    readonly onConnection: (address: RunnerAddress) => Effect.Effect<void, never, Scope.Scope>
    readonly isAlive: (address: RunnerAddress) => Effect.Effect<boolean>
  },
  never,
  Scope.Scope | Runners.Runners
>

Source

Since v1.0.0

layers

layer

A layer which will ping a Runner directly to check if it is healthy.

Signature

declare const layer: Layer.Layer<RunnerHealth, never, Runners.Runners>

Source

Since v1.0.0

layerNoop

A layer which will always consider a Runner healthy.

This is useful for testing.

Signature

declare const layerNoop: Layer.Layer<RunnerHealth, never, never>

Source

Since v1.0.0

layerRpc

A layer which will ping a Runner directly to check if it is healthy.

Signature

declare const layerRpc: Layer.Layer<RunnerHealth, never, ShardingConfig | Runners.RpcClientProtocol>

Source

Since v1.0.0

models

RunnerHealth (class)

Represents the service used to check if a Runner is healthy.

If a Runner is responsive, shards will not be re-assigned because the Runner may still be processing messages. If a Runner is not responsive, then its associated shards can and will be re-assigned to a different Runner.

Signature

declare class RunnerHealth

Source

Since v1.0.0