Skip to main content Link Search Menu Expand Document (external link)

ShardingEvent overview

Added in v1.0.0


Table of contents


constructors

PodHealthChecked

Constructs the event that occurs when the health of a Pod has been checked

Signature

export declare function PodHealthChecked(pod: PodAddress.PodAddress): PodHealthChecked

Added in v1.0.0

PodRegistered

Constructs the event that occurs when a new Pod has registered

Signature

export declare function PodRegistered(pod: PodAddress.PodAddress): PodRegistered

Added in v1.0.0

PodUnregistered

Constructs the event that occurs when a pod has unregistered

Signature

export declare function PodUnregistered(pod: PodAddress.PodAddress): PodUnregistered

Added in v1.0.0

ShardsAssigned

Constructs the event that occurs when new shards are assigned to Pod.

Signature

export declare function ShardsAssigned(
  pod: PodAddress.PodAddress,
  shards: HashSet.HashSet<ShardId.ShardId>
): ShardsAssigned

Added in v1.0.0

ShardsUnassigned

Constructs the event that occurs when shards are unassigned to a Pod

Signature

export declare function ShardsUnassigned(
  pod: PodAddress.PodAddress,
  shards: HashSet.HashSet<ShardId.ShardId>
): ShardsUnassigned

Added in v1.0.0

models

PodHealthChecked (interface)

Signature

export interface PodHealthChecked {
  readonly _tag: "PodHealthChecked"
  readonly pod: PodAddress.PodAddress
}

Added in v1.0.0

PodRegistered (interface)

Signature

export interface PodRegistered {
  readonly _tag: "PodRegistered"
  readonly pod: PodAddress.PodAddress
}

Added in v1.0.0

PodUnregistered (interface)

Signature

export interface PodUnregistered {
  readonly _tag: "PodUnregistered"
  readonly pod: PodAddress.PodAddress
}

Added in v1.0.0

ShardingEvent (type alias)

This are the events that may occur over the ShardManager during its lifetime.

Signature

export type ShardingEvent = ShardsAssigned | ShardsUnassigned | PodHealthChecked | PodRegistered | PodUnregistered

Added in v1.0.0

ShardsAssigned (interface)

Signature

export interface ShardsAssigned {
  readonly _tag: "ShardsAssigned"
  readonly pod: PodAddress.PodAddress
  readonly shards: HashSet.HashSet<ShardId.ShardId>
}

Added in v1.0.0

ShardsUnassigned (interface)

Signature

export interface ShardsUnassigned {
  readonly _tag: "ShardsUnassigned"
  readonly pod: PodAddress.PodAddress
  readonly shards: HashSet.HashSet<ShardId.ShardId>
}

Added in v1.0.0