Package org.apache.pekko.cluster.sharding.typed.delivery

Class ShardingConsumerController

java.lang.Object

org.apache.pekko.cluster.sharding.typed.delivery.ShardingConsumerController

public class ShardingConsumerController
extends Object

ShardingConsumerController is used together with ShardingProducerController. See the description in that class or the Pekko 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 pekko.actor.typed.delivery.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 pekko.actor.typed.delivery.ConsumerController.Delivery to the protocol of the consumer actor.

Received messages from the producer are wrapped in pekko.actor.typed.delivery.ConsumerController.Delivery when sent to the consumer, which is supposed to reply with pekko.actor.typed.delivery.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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ShardingConsumerController.Settings
static class	ShardingConsumerController.Settings$

Constructor Summary

Constructors

Constructor	Description
ShardingConsumerController()

Method Summary

Modifier and Type	Method	Description
static <A, B> Behavior<ConsumerController.SequencedMessage<A>>	apply(scala.Function1<ActorRef<ConsumerController.Start<A>>,Behavior<B>> consumerBehavior)	The Behavior of the entity that is to be initialized in ClusterSharding.
static <A, B> Behavior<ConsumerController.SequencedMessage<A>>	create(Function<ActorRef<ConsumerController.Start<A>>,Behavior<B>> consumerBehavior)	Java API: The Behavior of the entity that is to be initialized in ClusterSharding.
static <A, B> Behavior<ConsumerController.SequencedMessage<A>>	create(Function<ActorRef<ConsumerController.Start<A>>,Behavior<B>> consumerBehavior, ShardingConsumerController.Settings settings)	Java API: The Behavior of the entity that is to be initialized in ClusterSharding.
static <A> Class<ConsumerController.SequencedMessage<A>>	entityTypeKeyClass()	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>>.
static <A, B> Behavior<ConsumerController.SequencedMessage<A>>	withSettings(ShardingConsumerController.Settings settings, scala.Function1<ActorRef<ConsumerController.Start<A>>,Behavior<B>> consumerBehavior)	The Behavior of the entity that is to be initialized in ClusterSharding.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ShardingConsumerController

public ShardingConsumerController()

Method Details

apply

public static <A,
B>
Behavior<ConsumerController.SequencedMessage<A>> apply(scala.Function1<ActorRef<ConsumerController.Start<A>>,Behavior<B>> consumerBehavior)

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.

withSettings

public static <A,
B>
Behavior<ConsumerController.SequencedMessage<A>> withSettings(ShardingConsumerController.Settings settings,
 scala.Function1<ActorRef<ConsumerController.Start<A>>,Behavior<B>> consumerBehavior)

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.

create

public static <A,
B>
Behavior<ConsumerController.SequencedMessage<A>> create(Function<ActorRef<ConsumerController.Start<A>>,Behavior<B>> consumerBehavior)

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.

create

public static <A,
B>
Behavior<ConsumerController.SequencedMessage<A>> create(Function<ActorRef<ConsumerController.Start<A>>,Behavior<B>> consumerBehavior,
 ShardingConsumerController.Settings settings)

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.

entityTypeKeyClass

public static <A>
Class<ConsumerController.SequencedMessage<A>> entityTypeKeyClass()

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>>.