Class PoisonPillInterceptor<M>

  • public final class PoisonPillInterceptor<M>
    extends BehaviorInterceptor<M,​M>

    Returns Behaviors.stopped for PoisonPill signals unless it has been handled by the target Behavior. Used by Cluster Sharding to automatically stop entities without defining a stop message in the application protocol. Persistent actors handle PoisonPill and run side effects after persist and process stashed messages before stopping.

    • Constructor Detail

      • PoisonPillInterceptor

        public PoisonPillInterceptor()
    • Method Detail

      • aroundReceive

        public Behavior<M> aroundReceive​(TypedActorContext<M> ctx,
                                         M msg,
                                         BehaviorInterceptor.ReceiveTarget<M> target)
        Description copied from class: BehaviorInterceptor
        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.

        Specified by:
        aroundReceive in class BehaviorInterceptor<M,​M>
        ctx - (undocumented)
        msg - (undocumented)
        target - (undocumented)
        The behavior for next message or signal
      • isSame

        public boolean isSame​(BehaviorInterceptor<java.lang.Object,​java.lang.Object> other)
        isSame in class BehaviorInterceptor<M,​M>
        other - (undocumented)
        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.