akka.typed

Class Behavior<T>

java.lang.Object

akka.typed.Behavior<T>

Direct Known Subclasses:

Behavior.emptyBehavior$, Behavior.ignoreBehavior$, Behavior.sameBehavior$, Behavior.stoppedBehavior$, Behavior.unhandledBehavior$, Restarter, ScalaDSL.And, ScalaDSL.Deferred, ScalaDSL.Full, ScalaDSL.FullTotal, ScalaDSL.Or, ScalaDSL.Partial, ScalaDSL.Static, ScalaDSL.SynchronousSelf, ScalaDSL.Tap, ScalaDSL.Total, ScalaDSL.Widened

public abstract class Behavior<T>
extends java.lang.Object

The behavior of an actor defines how it reacts to the messages that it receives. The message may either be of the type that the Actor declares and which is part of the ActorRef signature, or it may be a system Signal that expresses a lifecycle event of either this actor or one of its child actors.

Behaviors can be formulated in a number of different ways, either by creating a derived class or by employing factory methods like the ones in the ScalaDSL$ object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Behavior.emptyBehavior$ INTERNAL API.
static class	Behavior.ignoreBehavior$ INTERNAL API.
static class	Behavior.sameBehavior$ INTERNAL API.
static class	Behavior.stoppedBehavior$ INTERNAL API.
static class	Behavior.unhandledBehavior$ INTERNAL API.

Constructor Summary

Constructors

Constructor and Description
Behavior()

Method Summary

Modifier and Type	Method and Description
static <T> Behavior<T>	canonicalize(Behavior<T> behavior, Behavior<T> current) Given a possibly special behavior (same or unhandled) and a &ldquo;current&rdquo; behavior (which defines the meaning of encountering a Same behavior) this method unwraps the behavior such that the innermost behavior is returned, i.e.
static <T> boolean	isAlive(Behavior<T> behavior)
static <T> boolean	isUnhandled(Behavior<T> behavior)
abstract Behavior<T>	management(ActorContext<T> ctx, Signal msg) Process an incoming Signal and return the next behavior.
abstract Behavior<T>	message(ActorContext<T> ctx, T msg) Process an incoming message and return the next behavior.
<U extends T> Behavior<U>	narrow() Narrow the type of this Behavior, which is always a safe operation.
static <T> Behavior<T>	preStart(Behavior<T> behavior, ActorContext<T> ctx)
static <T> Behavior<T>	validateAsInitial(Behavior<T> behavior)

Methods inherited from class java.lang.Object

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

Constructor Detail

Behavior

public Behavior()

Method Detail

canonicalize

public static <T> Behavior<T> canonicalize(Behavior<T> behavior,
                                           Behavior<T> current)

Given a possibly special behavior (same or unhandled) and a &ldquo;current&rdquo; behavior (which defines the meaning of encountering a Same behavior) this method unwraps the behavior such that the innermost behavior is returned, i.e. it removes the decorations.

Parameters:

behavior - (undocumented)

current - (undocumented)

Returns:

(undocumented)

validateAsInitial

public static <T> Behavior<T> validateAsInitial(Behavior<T> behavior)

preStart

public static <T> Behavior<T> preStart(Behavior<T> behavior,
                                       ActorContext<T> ctx)

isAlive

public static <T> boolean isAlive(Behavior<T> behavior)

isUnhandled

public static <T> boolean isUnhandled(Behavior<T> behavior)

management

public abstract Behavior<T> management(ActorContext<T> ctx,
                                       Signal msg)

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.

Parameters:

ctx - (undocumented)

msg - (undocumented)

Returns:

(undocumented)

message

public abstract Behavior<T> message(ActorContext<T> ctx,
                                    T msg)

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.

Parameters:

ctx - (undocumented)

msg - (undocumented)

Returns:

(undocumented)

narrow

public <U extends T> Behavior<U> narrow()

Narrow the type of this Behavior, which is always a safe operation. This method is necessary to implement the contravariant nature of Behavior (which cannot be expressed directly due to type inference problems).

Returns:

(undocumented)