Package org.apache.pekko.actor.typed.delivery

Class ConsumerController

java.lang.Object

org.apache.pekko.actor.typed.delivery.ConsumerController

public class ConsumerController
extends Object

ConsumerController and ProducerController or WorkPullingProducerController are used together. See the descriptions in those classes or the Pekko reference documentation for how they are intended to be used.

The destination consumer actor will start the flow by sending an initial ConsumerController.Start message to the ConsumerController. 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 is not delivered until the previous is confirmed. More messages from the producer that arrive while waiting for the confirmation are stashed by the ConsumerController and delivered when previous message was confirmed.

The consumer and the ConsumerController actors are supposed to be local so that these messages are fast and not lost. This is enforced by a runtime check.

The ConsumerController is automatically stopped when the consumer that registered with the Start message is terminated.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ConsumerController.Command<A>
static interface	ConsumerController.Confirmed
static class	ConsumerController.Confirmed$	When the message has been processed the consumer is supposed to send Confirmed back to the ConsumerController via the confirmTo in the ConsumerController.Delivery message.
static final class	ConsumerController.DeliverThenStop<A>
static class	ConsumerController.DeliverThenStop$
static final class	ConsumerController.Delivery<A>	Received messages from the producer are wrapped in Delivery when sent to the consumer.
static class	ConsumerController.Delivery$
static final class	ConsumerController.RegisterToProducerController<A>	Register the ConsumerController to the given producerController.
static class	ConsumerController.RegisterToProducerController$
static final class	ConsumerController.SequencedMessage<A>
static class	ConsumerController.SequencedMessage$
static final class	ConsumerController.Settings
static class	ConsumerController.Settings$
static final class	ConsumerController.Start<A>	Initial message from the consumer actor.
static class	ConsumerController.Start$

Constructor Summary

Constructors

Constructor	Description
ConsumerController()

Method Summary

Modifier and Type	Method	Description
static <A> Behavior<ConsumerController.Command<A>>	apply()
static <A> Behavior<ConsumerController.Command<A>>	apply(ConsumerController.Settings settings)
static <A> Behavior<ConsumerController.Command<A>>	apply(ServiceKey<ConsumerController.Command<A>> serviceKey)	To be used with WorkPullingProducerController.
static <A> Behavior<ConsumerController.Command<A>>	apply(ServiceKey<ConsumerController.Command<A>> serviceKey, ConsumerController.Settings settings)
static ConsumerController.Confirmed	confirmed()	Java API: the singleton instance of the Confirmed message.
static <A> Behavior<ConsumerController.Command<A>>	create()	Java API
static <A> Behavior<ConsumerController.Command<A>>	create(ConsumerController.Settings settings)	Java API
static <A> Behavior<ConsumerController.Command<A>>	create(ServiceKey<ConsumerController.Command<A>> serviceKey)	Java API: To be used with WorkPullingProducerController.
static <A> Behavior<ConsumerController.Command<A>>	create(ServiceKey<ConsumerController.Command<A>> serviceKey, ConsumerController.Settings settings)	Java API
static <A> Class<ConsumerController.Delivery<A>>	deliveryClass()	Java API: The generic Class type for ConsumerController.Delivery that can be used when creating a messageAdapter for Class<Delivery>.
static <A> Class<ConsumerController.Command<A>>	serviceKeyClass()	Java API: The generic Class type for ConsumerController.Command that can be used when creating a ServiceKey for Class<Command>.

Methods inherited from class java.lang.Object

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

Constructor Details

ConsumerController

public ConsumerController()

Method Details

deliveryClass

public static <A>
Class<ConsumerController.Delivery<A>> deliveryClass()

Java API: The generic Class type for ConsumerController.Delivery that can be used when creating a messageAdapter for Class<Delivery>.

serviceKeyClass

public static <A>
Class<ConsumerController.Command<A>> serviceKeyClass()

Java API: The generic Class type for ConsumerController.Command that can be used when creating a ServiceKey for Class<Command>.

confirmed

public static ConsumerController.Confirmed confirmed()

Java API: the singleton instance of the Confirmed message. When the message has been processed the consumer is supposed to send Confirmed back to the ConsumerController via the confirmTo in the ConsumerController.Delivery message.

apply

public static <A>
Behavior<ConsumerController.Command<A>> apply()

apply

public static <A>
Behavior<ConsumerController.Command<A>> apply(ConsumerController.Settings settings)

apply

public static <A>
Behavior<ConsumerController.Command<A>> apply(ServiceKey<ConsumerController.Command<A>> serviceKey)

To be used with WorkPullingProducerController. It will register itself to the pekko.actor.typed.receptionist.Receptionist with the given serviceKey, and the WorkPullingProducerController subscribes to the same key to find active workers.

apply

public static <A>
Behavior<ConsumerController.Command<A>> apply(ServiceKey<ConsumerController.Command<A>> serviceKey,
 ConsumerController.Settings settings)

create

public static <A>
Behavior<ConsumerController.Command<A>> create()

Java API

create

public static <A>
Behavior<ConsumerController.Command<A>> create(ConsumerController.Settings settings)

Java API

create

public static <A>
Behavior<ConsumerController.Command<A>> create(ServiceKey<ConsumerController.Command<A>> serviceKey)

Java API: To be used with WorkPullingProducerController. It will register itself to the pekko.actor.typed.receptionist.Receptionist with the given serviceKey, and the WorkPullingProducerController subscribes to the same key to find active workers.

create

public static <A>
Behavior<ConsumerController.Command<A>> create(ServiceKey<ConsumerController.Command<A>> serviceKey,
 ConsumerController.Settings settings)

Java API