Package akka.actor.typed

Class BehaviorInterceptor<O,I>

java.lang.Object

akka.actor.typed.BehaviorInterceptor<O,I>

Direct Known Subclasses:

AbstractSupervisor, LogMessagesInterceptor, MonitorInterceptor, PoisonPillInterceptor, WidenedInterceptor, WithMdcBehaviorInterceptor

public abstract class BehaviorInterceptor<O,I>
extends java.lang.Object

Allows for applying the interceptor only to certain message types. Useful if the official protocol and the actual protocol of an actor causes problems, for example class cast exceptions for a message not of type O that the actor still knows how to deal with. Note that this is only possible to use when O and I are the same type.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BehaviorInterceptor.PreStartTarget<T>
static interface	BehaviorInterceptor.ReceiveTarget<T>
static interface	BehaviorInterceptor.SignalTarget<T>

Constructor Summary

Constructors

Constructor	Description
BehaviorInterceptor()

Method Summary

Modifier and Type	Method	Description
abstract Behavior<I>	aroundReceive(TypedActorContext<O> ctx, O msg, BehaviorInterceptor.ReceiveTarget<I> target)	Intercept a message sent to the running actor.
abstract Behavior<I>	aroundSignal(TypedActorContext<O> ctx, Signal signal, BehaviorInterceptor.SignalTarget<I> target)	Intercept a signal sent to the running actor.
Behavior<I>	aroundStart(TypedActorContext<O> ctx, BehaviorInterceptor.PreStartTarget<I> target)	Override to intercept actor startup.
java.lang.Class<? extends O>	interceptMessageType()
boolean	isSame(BehaviorInterceptor<java.lang.Object,java.lang.Object> other)

Methods inherited from class java.lang.Object

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

Constructor Detail

BehaviorInterceptor

public BehaviorInterceptor()

Method Detail

interceptMessageType

public java.lang.Class<? extends O> interceptMessageType()

aroundStart

public Behavior<I> aroundStart(TypedActorContext<O> ctx,
                               BehaviorInterceptor.PreStartTarget<I> target)

Override to intercept actor startup. To trigger startup of the next behavior in the stack, call target.start().

Parameters:

ctx - (undocumented)

target - (undocumented)

Returns:

The returned behavior will be the "started" behavior of the actor used to accept the next message or signal.

aroundReceive

public abstract Behavior<I> aroundReceive(TypedActorContext<O> ctx,
                                          O msg,
                                          BehaviorInterceptor.ReceiveTarget<I> target)

Intercept a message sent to the running actor. Pass the message on to the next behavior in the stack by passing it to target.apply, return Behaviors.same without invoking target to filter out the message.

Parameters:

ctx - (undocumented)

msg - (undocumented)

target - (undocumented)

Returns:

The behavior for next message or signal

aroundSignal

public abstract Behavior<I> aroundSignal(TypedActorContext<O> ctx,
                                         Signal signal,
                                         BehaviorInterceptor.SignalTarget<I> target)

Intercept a signal sent to the running actor. Pass the signal on to the next behavior in the stack by passing it to target.apply.

Parameters:

ctx - (undocumented)

signal - (undocumented)

target - (undocumented)

Returns:

The behavior for next message or signal

isSame

public boolean isSame(BehaviorInterceptor<java.lang.Object,java.lang.Object> other)

Parameters:

other - (undocumented)

Returns:

true if this behavior logically the same as another behavior interceptor and can therefore be eliminated (to avoid building infinitely growing stacks of behaviors)? Default implementation is based on instance equality. Override to provide use case specific logic.