abstract class ShardedDaemonProcess extends AnyRef

This extension runs a pre set number of actors in a cluster.

The typical use case is when you have a task that can be divided in a number of workers, each doing a sharded part of the work, for example consuming the read side events from Akka Persistence through tagged events where each tag decides which consumer that should consume the event.

Each named set needs to be started on all the nodes of the cluster on start up.

The processes are spread out across the cluster, when the cluster topology changes the processes may be stopped and started anew on a new node to rebalance them.

Not for user extension.

Annotations
@DoNotInherit()
Source
ShardedDaemonProcess.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ShardedDaemonProcess
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ShardedDaemonProcess()

Abstract Value Members

  1. abstract def init[T](messageClass: Class[T], name: String, numberOfInstances: Int, behaviorFactory: [Behavior[T]], settings: ShardedDaemonProcessSettings, stopMessage: Optional[T], shardAllocationStrategy: [ShardAllocationStrategy]): Unit

    Start a specific number of actors, each with a unique numeric id in the set, that is then kept alive in the cluster.

    Start a specific number of actors, each with a unique numeric id in the set, that is then kept alive in the cluster.

    behaviorFactory

    Given a unique id of 0 until numberOfInstance create the behavior for that actor.

    stopMessage

    if defined sent to the actors when they need to stop because of a rebalance across the nodes of the cluster, rescale or cluster shutdown.

    shardAllocationStrategy

    if defined used by entities to control the shard allocation

  2. abstract def init[T](messageClass: Class[T], name: String, numberOfInstances: Int, behaviorFactory: [Behavior[T]], settings: ShardedDaemonProcessSettings, stopMessage: Optional[T]): Unit

    Start a specific number of actors, each with a unique numeric id in the set, that is then kept alive in the cluster.

    Start a specific number of actors, each with a unique numeric id in the set, that is then kept alive in the cluster.

    behaviorFactory

    Given a unique id of 0 until numberOfInstance create the behavior for that actor.

    stopMessage

    if defined sent to the actors when they need to stop because of a rebalance across the nodes of the cluster or cluster shutdown.

  3. abstract def init[T](messageClass: Class[T], name: String, numberOfInstances: Int, behaviorFactory: [Behavior[T]], stopMessage: T): Unit

    Start a specific number of actors that is then kept alive in the cluster.

    Start a specific number of actors that is then kept alive in the cluster.

    behaviorFactory

    Given a unique id of 0 until numberOfInstance create the behavior for that actor.

    stopMessage

    sent to the actors when they need to stop because of a rebalance across the nodes of the cluster or cluster shutdown.

  4. abstract def init[T](messageClass: Class[T], name: String, numberOfInstances: Int, behaviorFactory: [Behavior[T]]): Unit

    Start a specific number of actors that is then kept alive in the cluster.

    Start a specific number of actors that is then kept alive in the cluster.

    behaviorFactory

    Given a unique id of 0 until numberOfInstance create the behavior for that actor.

  5. abstract def initWithContext[T](messageClass: Class[T], name: String, numberOfInstances: Int, behaviorFactory: [, Behavior[T]], settings: ShardedDaemonProcessSettings, stopMessage: Optional[T], shardAllocationStrategy: [ShardAllocationStrategy]): [ShardedDaemonProcessCommand]

    Start a specific number of actors, each with a unique numeric id in the set, that is then kept alive in the cluster.

    Start a specific number of actors, each with a unique numeric id in the set, that is then kept alive in the cluster.

    behaviorFactory

    Given a unique sharded daemon process context containing the total number of workers and the id the specific worker being started, create the behavior for that actor.

    stopMessage

    If defined: sent to the actors when they need to stop because of a rebalance across the nodes of the cluster, rescale or cluster shutdown.

    shardAllocationStrategy

    If defined: used by entities to control the shard allocation

    Annotations
    @ApiMayChange()
  6. abstract def initWithContext[T](messageClass: Class[T], name: String, initialNumberOfInstances: Int, behaviorFactory: [, Behavior[T]], settings: ShardedDaemonProcessSettings, stopMessage: Optional[T]): [ShardedDaemonProcessCommand]

    Start a specific number of actors, each with a unique numeric id in the set, that is then kept alive in the cluster.

    Start a specific number of actors, each with a unique numeric id in the set, that is then kept alive in the cluster. The number of processing actors can be rescaled by interacting with the returned actor.

    behaviorFactory

    Given a unique id of 0 until numberOfInstance and total number of processes, create the behavior for that actor.

    stopMessage

    Sent to the actors when they need to stop because of a rebalance across the nodes of the cluster or cluster shutdown.

    Annotations
    @ApiMayChange()
  7. abstract def initWithContext[T](messageClass: Class[T], name: String, initialNumberOfInstances: Int, behaviorFactory: [, Behavior[T]]): [ShardedDaemonProcessCommand]

    Start a specific number of actors, each with a unique numeric id in the set, that is then kept alive in the cluster.

    Start a specific number of actors, each with a unique numeric id in the set, that is then kept alive in the cluster. The number of processing actors can be rescaled by interacting with the returned actor.

    behaviorFactory

    Given a unique id of 0 until numberOfInstance and total number of processes, create the behavior for that actor.

    Annotations
    @ApiMayChange()