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

Pods overview

Added in v1.0.0

Table of contents

context

Pods

Signature

export declare const Pods: Context.Tag<Pods, Pods>

Added in v1.0.0

make

Constructs a Pods service from its implementation

Signature

export declare const make: (args: Omit<Pods, typeof PodsTypeId>) => Pods

Added in v1.0.0

layers

noop

A layer that creates a service that does nothing when called. Useful for testing ShardManager or when using Sharding.local.

Signature

export declare const noop: Layer.Layer<Pods>

Added in v1.0.0

models

Pods (interface)

An interface to communicate with remote pods. This is used by the Shard Manager for assigning and unassigning shards. This is also used by pods for internal communication (forward messages to each other).

Signature

export interface Pods {
  /**
   * @since 1.0.0
   */
  readonly [PodsTypeId]: PodsTypeId

  /**
   * Notify a pod that it was assigned a list of shards
   * @since 1.0.0
   */
  readonly assignShards: (
    pod: PodAddress.PodAddress,
    shards: HashSet.HashSet<ShardId.ShardId>
  ) => Effect.Effect<void, ShardingException.PodUnavailableException>

  /**
   * Notify a pod that it was unassigned a list of shards
   * @since 1.0.0
   */
  readonly unassignShards: (
    pod: PodAddress.PodAddress,
    shards: HashSet.HashSet<ShardId.ShardId>
  ) => Effect.Effect<void, ShardingException.PodUnavailableException>

  /**
   * Check that a pod is responsive
   * @since 1.0.0
   */
  readonly ping: (pod: PodAddress.PodAddress) => Effect.Effect<void, ShardingException.PodUnavailableException>

  /**
   * Send a message to a pod and receive its message state
   * @since 1.0.0
   */
  readonly sendAndGetState: (
    pod: PodAddress.PodAddress,
    envelope: SerializedEnvelope.SerializedEnvelope
  ) => Effect.Effect<
    MessageState.MessageState<SerializedMessage.SerializedMessage>,
    ShardingException.ShardingException
  >
}

Added in v1.0.0

symbols

PodsTypeId

Signature

export declare const PodsTypeId: typeof PodsTypeId

Added in v1.0.0

PodsTypeId (type alias)

Signature

export type PodsTypeId = typeof PodsTypeId

Added in v1.0.0