Packages

trait ShardedDaemonProcess extends Extension

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.

Self Type
ShardedDaemonProcess with javadsl.ShardedDaemonProcess
Annotations
@DoNotInherit()
Source
ShardedDaemonProcess.scala
Linear Supertypes
Extension, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ShardedDaemonProcess
  2. Extension
  3. AnyRef
  4. 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

Abstract Value Members

  1. abstract def init[T](name: String, numberOfInstances: Int, behaviorFactory: (Int) => Behavior[T], settings: ShardedDaemonProcessSettings, stopMessage: Option[T], shardAllocationStrategy: Option[ShardAllocationStrategy])(implicit classTag: ClassTag[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. The number of processing actors can be rescaled by interacting with the returned actor.

    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.

    shardAllocationStrategy

    if defined used by entities to control the shard allocation

  2. abstract def init[T](name: String, numberOfInstances: Int, behaviorFactory: (Int) => Behavior[T], settings: ShardedDaemonProcessSettings, stopMessage: Option[T])(implicit classTag: ClassTag[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. The number of processing actors can be rescaled by interacting with the returned actor.

    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](name: String, numberOfInstances: Int, behaviorFactory: (Int) => Behavior[T], stopMessage: T)(implicit classTag: ClassTag[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. The number of processing actors can be rescaled by interacting with the returned actor.

    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](name: String, numberOfInstances: Int, behaviorFactory: (Int) => Behavior[T])(implicit classTag: ClassTag[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. The number of processing actors can be rescaled by interacting with the returned actor.

    behaviorFactory

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

  5. abstract def initWithContext[T](name: String, initialNumberOfInstances: Int, behaviorFactory: (ShardedDaemonProcessContext) => Behavior[T], settings: ShardedDaemonProcessSettings, stopMessage: Option[T], shardAllocationStrategy: Option[ShardAllocationStrategy])(implicit classTag: ClassTag[T]): ActorRef[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 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 worker resize, re-balance across the nodes of the cluster or cluster shutdown.

    shardAllocationStrategy

    If defined, used by entities to control the shard allocation.

    Annotations
    @ApiMayChange()
  6. abstract def initWithContext[T](name: String, initialNumberOfInstances: Int, behaviorFactory: (ShardedDaemonProcessContext) => Behavior[T], settings: ShardedDaemonProcessSettings, stopMessage: T)(implicit classTag: ClassTag[T]): ActorRef[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 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

    Sent to the actors when they need to stop because of a worker resize, re-balance across the nodes of the cluster or cluster shutdown.

    Annotations
    @ApiMayChange()
  7. abstract def initWithContext[T](name: String, initialNumberOfInstances: Int, behaviorFactory: (ShardedDaemonProcessContext) => Behavior[T])(implicit classTag: ClassTag[T]): ActorRef[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 sharded daemon process context containing the total number of workers and the id the specific worker being started, create the behavior for that actor.

    Annotations
    @ApiMayChange()

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ShardedDaemonProcess toany2stringadd[ShardedDaemonProcess] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ShardedDaemonProcess, B)
    Implicit
    This member is added by an implicit conversion from ShardedDaemonProcess toArrowAssoc[ShardedDaemonProcess] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. def ensuring(cond: (ShardedDaemonProcess) => Boolean, msg: => Any): ShardedDaemonProcess
    Implicit
    This member is added by an implicit conversion from ShardedDaemonProcess toEnsuring[ShardedDaemonProcess] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (ShardedDaemonProcess) => Boolean): ShardedDaemonProcess
    Implicit
    This member is added by an implicit conversion from ShardedDaemonProcess toEnsuring[ShardedDaemonProcess] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): ShardedDaemonProcess
    Implicit
    This member is added by an implicit conversion from ShardedDaemonProcess toEnsuring[ShardedDaemonProcess] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): ShardedDaemonProcess
    Implicit
    This member is added by an implicit conversion from ShardedDaemonProcess toEnsuring[ShardedDaemonProcess] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ShardedDaemonProcess toStringFormat[ShardedDaemonProcess] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (ShardedDaemonProcess, B)
    Implicit
    This member is added by an implicit conversion from ShardedDaemonProcess toArrowAssoc[ShardedDaemonProcess] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Extension

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromShardedDaemonProcess to any2stringadd[ShardedDaemonProcess]

Inherited by implicit conversion StringFormat fromShardedDaemonProcess to StringFormat[ShardedDaemonProcess]

Inherited by implicit conversion Ensuring fromShardedDaemonProcess to Ensuring[ShardedDaemonProcess]

Inherited by implicit conversion ArrowAssoc fromShardedDaemonProcess to ArrowAssoc[ShardedDaemonProcess]

Ungrouped