Packages

  • package root
    Definition Classes
    root
  • package akka
    Definition Classes
    root
  • package cluster
    Definition Classes
    akka
  • package sharding
    Definition Classes
    cluster
  • package typed
    Definition Classes
    sharding
  • package delivery
    Definition Classes
    typed
  • object ShardingConsumerController

    ShardingConsumerController is used together with ShardingProducerController.

    ShardingConsumerController is used together with ShardingProducerController. See the description in that class or the Akka reference documentation for how they are intended to be used.

    ShardingConsumerController is the entity that is initialized in ClusterSharding. It will manage the lifecycle and message delivery to the destination consumer actor.

    The destination consumer actor will start the flow by sending an initial ConsumerController.Start message via the ActorRef provided in the factory function of the consumer Behavior. The ActorRef in the Start message is typically constructed as a message adapter to map the ConsumerController.Delivery to the protocol of the consumer actor.

    Received messages from the producer are wrapped in ConsumerController.Delivery when sent to the consumer, which is supposed to reply with ConsumerController.Confirmed when it has processed the message. Next message from a specific producer is not delivered until the previous is confirmed. However, since there can be several producers, e.g. one per node, sending to the same destination entity there can be several Delivery in flight at the same time. More messages from a specific producer that arrive while waiting for the confirmation are stashed by the ConsumerController and delivered when previous message was confirmed.

    Definition Classes
    delivery
    Annotations
    @ApiMayChange()
  • Settings

final class Settings extends AnyRef

Source
ShardingConsumerController.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Settings
  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

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 Settings toany2stringadd[Settings] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Settings, B)
    Implicit
    This member is added by an implicit conversion from Settings toArrowAssoc[Settings] 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. val bufferSize: Int
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  9. val consumerControllerSettings: actor.typed.delivery.ConsumerController.Settings
  10. def ensuring(cond: (Settings) => Boolean, msg: => Any): Settings
    Implicit
    This member is added by an implicit conversion from Settings toEnsuring[Settings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (Settings) => Boolean): Settings
    Implicit
    This member is added by an implicit conversion from Settings toEnsuring[Settings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): Settings
    Implicit
    This member is added by an implicit conversion from Settings toEnsuring[Settings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): Settings
    Implicit
    This member is added by an implicit conversion from Settings toEnsuring[Settings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    Settings → AnyRef → Any
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. def withBufferSize(newBufferSize: Int): Settings
  28. def withConsumerControllerSettings(newConsumerControllerSettings: actor.typed.delivery.ConsumerController.Settings): Settings

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 Settings toStringFormat[Settings] 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): (Settings, B)
    Implicit
    This member is added by an implicit conversion from Settings toArrowAssoc[Settings] 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 AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromSettings to any2stringadd[Settings]

Inherited by implicit conversion StringFormat fromSettings to StringFormat[Settings]

Inherited by implicit conversion Ensuring fromSettings to Ensuring[Settings]

Inherited by implicit conversion ArrowAssoc fromSettings to ArrowAssoc[Settings]

Ungrouped