Package org.apache.pekko.actor.typed.javadsl

Class Receive<T>

java.lang.Object

org.apache.pekko.actor.typed.Behavior<T>

org.apache.pekko.actor.typed.ExtensibleBehavior<T>

org.apache.pekko.actor.typed.javadsl.Receive<T>

Direct Known Subclasses:

BuiltReceive

public abstract class Receive<T>
extends ExtensibleBehavior<T>

A specialized "receive" behavior that is implemented using message matching builders, such as ReceiveBuilder, from AbstractBehavior.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.pekko.actor.typed.Behavior

Behavior.BehaviorDecorators<Inner>, Behavior.BehaviorDecorators$

Constructor Summary

Constructors

Constructor	Description
Receive()

Method Summary

Modifier and Type	Method	Description
Behavior<T>	receive(TypedActorContext<T> ctx, T msg)	Process an incoming message and return the next behavior.
abstract Behavior<T>	receiveMessage(T msg)	Process an incoming message and return the next behavior.
abstract Behavior<T>	receiveSignal(Signal sig)	Process an incoming pekko.actor.typed.Signal and return the next behavior.
Behavior<T>	receiveSignal(TypedActorContext<T> ctx, Signal sig)	Process an incoming Signal and return the next behavior.

Methods inherited from class org.apache.pekko.actor.typed.Behavior

BehaviorDecorators, canonicalize, existsInStack, interpretMessage, interpretSignal, isAlive, isDeferred, isUnhandled, narrow, start, validateAsInitial

Methods inherited from class java.lang.Object

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

Constructor Detail

Receive

public Receive()

Method Detail

receive

public final Behavior<T> receive(TypedActorContext<T> ctx,
                                 T msg)
                          throws java.lang.Exception

Description copied from class: ExtensibleBehavior

Process an incoming message and return the next behavior.

The returned behavior can in addition to normal behaviors be one of the canned special objects:

* returning stopped will terminate this Behavior * returning same designates to reuse the current Behavior * returning unhandled keeps the same Behavior and signals that the message was not yet handled

Code calling this method should use Behavior$ canonicalize to replace the special objects with real Behaviors.

Specified by:

receive in class ExtensibleBehavior<T>

Throws:

java.lang.Exception

receiveMessage

public abstract Behavior<T> receiveMessage(T msg)
                                    throws java.lang.Exception

Process an incoming message and return the next behavior.

The returned behavior can in addition to normal behaviors be one of the canned special objects:

* returning stopped will terminate this Behavior * returning same designates to reuse the current Behavior * returning unhandled keeps the same Behavior and signals that the message was not yet handled

Throws:

java.lang.Exception

receiveSignal

public abstract Behavior<T> receiveSignal(Signal sig)
                                   throws java.lang.Exception

Process an incoming pekko.actor.typed.Signal and return the next behavior. This means that all lifecycle hooks, ReceiveTimeout, Terminated and Failed messages can initiate a behavior change.

The returned behavior can in addition to normal behaviors be one of the canned special objects:

* returning stopped will terminate this Behavior * returning same designates to reuse the current Behavior * returning unhandled keeps the same Behavior and signals that the message was not yet handled

Throws:

java.lang.Exception

receiveSignal

public final Behavior<T> receiveSignal(TypedActorContext<T> ctx,
                                       Signal sig)
                                throws java.lang.Exception

Description copied from class: ExtensibleBehavior

Process an incoming Signal and return the next behavior. This means that all lifecycle hooks, ReceiveTimeout, Terminated and Failed messages can initiate a behavior change.

The returned behavior can in addition to normal behaviors be one of the canned special objects:

* returning stopped will terminate this Behavior * returning same designates to reuse the current Behavior * returning unhandled keeps the same Behavior and signals that the message was not yet handled

Code calling this method should use Behavior$ canonicalize to replace the special objects with real Behaviors.

Specified by:

receiveSignal in class ExtensibleBehavior<T>

Throws:

java.lang.Exception