o

akka.cluster.sharding.typed.delivery

ShardingConsumerController

object ShardingConsumerController

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.

Annotations
@ApiMayChange()
Source
ShardingConsumerController.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ShardingConsumerController
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. final class Settings extends AnyRef

Value Members

  1. def apply[A, B](consumerBehavior: ([Start[A]]) => Behavior[B]): [SequencedMessage[A]]

    The Behavior of the entity that is to be initialized in ClusterSharding.

    The Behavior of the entity that is to be initialized in ClusterSharding. It will manage the lifecycle and message delivery to the destination consumer actor.

  2. def create[A, B](consumerBehavior: [[Start[A]], Behavior[B]], settings: Settings): [SequencedMessage[A]]

    Java API: The Behavior of the entity that is to be initialized in ClusterSharding.

    Java API: The Behavior of the entity that is to be initialized in ClusterSharding. It will manage the lifecycle and message delivery to the destination consumer actor.

  3. def create[A, B](consumerBehavior: [[Start[A]], Behavior[B]]): [SequencedMessage[A]]

    Java API: The Behavior of the entity that is to be initialized in ClusterSharding.

    Java API: The Behavior of the entity that is to be initialized in ClusterSharding. It will manage the lifecycle and message delivery to the destination consumer actor.

  4. def entityTypeKeyClass[A]: Class[SequencedMessage[A]]

    Java API: The generic Class type for ConsumerController.SequencedMessage that can be used when creating an EntityTypeKey for the ShardedConsumerController with Class<EntityTypeKey<ConsumerController.SequencedMessage<MessageType>>>.

  5. def withSettings[A, B](settings: Settings)(consumerBehavior: ([Start[A]]) => Behavior[B]): [SequencedMessage[A]]

    The Behavior of the entity that is to be initialized in ClusterSharding.

    The Behavior of the entity that is to be initialized in ClusterSharding. It will manage the lifecycle and message delivery to the destination consumer actor.

  6. object Settings