abstract class BehaviorInterceptor[Outer, Inner] extends AnyRef

A behavior interceptor allows for intercepting message and signal reception and perform arbitrary logic - transform, filter, send to a side channel etc. It is the core API for decoration of behaviors.

The BehaviorInterceptor API is considered a low level tool for building other features and shouldn't be used for "normal" application logic. Several built-in intercepting behaviors are provided through factories in the respective Behaviors.

If the interceptor does keep mutable state care must be taken to create a new instance from the factory function of Behaviors.intercept so that a new instance is created per spawned actor rather than shared among actor instance.

Outer

The outer message type – the type of messages the intercepting behavior will accept

Inner

The inner message type - the type of message the wrapped behavior accepts

Source
BehaviorInterceptor.scala
See also

BehaviorSignalInterceptor

Linear Supertypes
AnyRef, Any
Known Subclasses
BehaviorSignalInterceptor
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BehaviorInterceptor
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new BehaviorInterceptor()(implicit interceptMessageClassTag: ClassTag[Outer])

    Scala API: The ClassTag for Outer ensures that only messages of this class or a subclass thereof will be intercepted.

    Scala API: The ClassTag for Outer ensures that only messages of this class or a subclass thereof will be intercepted. Other message types (e.g. a private protocol) will bypass the interceptor and be continue to the inner behavior untouched.

  2. new BehaviorInterceptor(interceptMessageClass: Class[Outer])

    interceptMessageClass

    Ensures that the interceptor will only receive O message types. If the message is not of this class or a subclass thereof (e.g. a private protocol) will bypass the interceptor and be continue to the inner behavior untouched.

Abstract Value Members

  1. abstract def aroundReceive(ctx: TypedActorContext[Outer], msg: Outer, target: ReceiveTarget[Inner]): Behavior[Inner]

    Intercept a message sent to the running actor.

    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.

    returns

    The behavior for next message or signal

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from BehaviorInterceptor[Outer, Inner] toany2stringadd[BehaviorInterceptor[Outer, Inner]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (BehaviorInterceptor[Outer, Inner], B)
    Implicit
    This member is added by an implicit conversion from BehaviorInterceptor[Outer, Inner] toArrowAssoc[BehaviorInterceptor[Outer, Inner]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def aroundSignal(ctx: TypedActorContext[Outer], signal: Signal, target: SignalTarget[Inner]): Behavior[Inner]

    Override to intercept a signal sent to the running actor.

    Override to 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.

    returns

    The behavior for next message or signal

    See also

    BehaviorSignalInterceptor

  7. def aroundStart(ctx: TypedActorContext[Outer], target: PreStartTarget[Inner]): Behavior[Inner]

    Override to intercept actor startup.

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

    returns

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

  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  10. def ensuring(cond: (BehaviorInterceptor[Outer, Inner]) => Boolean, msg: => Any): BehaviorInterceptor[Outer, Inner]
    Implicit
    This member is added by an implicit conversion from BehaviorInterceptor[Outer, Inner] toEnsuring[BehaviorInterceptor[Outer, Inner]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (BehaviorInterceptor[Outer, Inner]) => Boolean): BehaviorInterceptor[Outer, Inner]
    Implicit
    This member is added by an implicit conversion from BehaviorInterceptor[Outer, Inner] toEnsuring[BehaviorInterceptor[Outer, Inner]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): BehaviorInterceptor[Outer, Inner]
    Implicit
    This member is added by an implicit conversion from BehaviorInterceptor[Outer, Inner] toEnsuring[BehaviorInterceptor[Outer, Inner]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): BehaviorInterceptor[Outer, Inner]
    Implicit
    This member is added by an implicit conversion from BehaviorInterceptor[Outer, Inner] toEnsuring[BehaviorInterceptor[Outer, Inner]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  18. val interceptMessageClass: Class[Outer]
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def isSame(other: BehaviorInterceptor[Any, Any]): Boolean

    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.

  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from BehaviorInterceptor[Outer, Inner] toStringFormat[BehaviorInterceptor[Outer, Inner]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (BehaviorInterceptor[Outer, Inner], B)
    Implicit
    This member is added by an implicit conversion from BehaviorInterceptor[Outer, Inner] toArrowAssoc[BehaviorInterceptor[Outer, Inner]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromBehaviorInterceptor[Outer, Inner] to any2stringadd[BehaviorInterceptor[Outer, Inner]]

Inherited by implicit conversion StringFormat fromBehaviorInterceptor[Outer, Inner] to StringFormat[BehaviorInterceptor[Outer, Inner]]

Inherited by implicit conversion Ensuring fromBehaviorInterceptor[Outer, Inner] to Ensuring[BehaviorInterceptor[Outer, Inner]]

Inherited by implicit conversion ArrowAssoc fromBehaviorInterceptor[Outer, Inner] to ArrowAssoc[BehaviorInterceptor[Outer, Inner]]

Ungrouped