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
- Alphabetic
- By Inheritance
- BehaviorInterceptor
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
BehaviorInterceptor()(implicit interceptMessageClassTag: ClassTag[Outer])
Scala API: The
ClassTag
forOuter
ensures that only messages of this class or a subclass thereof will be intercepted.Scala API: The
ClassTag
forOuter
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. -
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
-
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
, returnBehaviors.same
without invokingtarget
to filter out the message.- returns
The behavior for next message or signal
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from BehaviorInterceptor[Outer, Inner] to any2stringadd[BehaviorInterceptor[Outer, Inner]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (BehaviorInterceptor[Outer, Inner], B)
- Implicit
- This member is added by an implicit conversion from BehaviorInterceptor[Outer, Inner] to ArrowAssoc[BehaviorInterceptor[Outer, Inner]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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
-
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.
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
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] to Ensuring[BehaviorInterceptor[Outer, Inner]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (BehaviorInterceptor[Outer, Inner]) ⇒ Boolean): BehaviorInterceptor[Outer, Inner]
- Implicit
- This member is added by an implicit conversion from BehaviorInterceptor[Outer, Inner] to Ensuring[BehaviorInterceptor[Outer, Inner]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): BehaviorInterceptor[Outer, Inner]
- Implicit
- This member is added by an implicit conversion from BehaviorInterceptor[Outer, Inner] to Ensuring[BehaviorInterceptor[Outer, Inner]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): BehaviorInterceptor[Outer, Inner]
- Implicit
- This member is added by an implicit conversion from BehaviorInterceptor[Outer, Inner] to Ensuring[BehaviorInterceptor[Outer, Inner]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from BehaviorInterceptor[Outer, Inner] to StringFormat[BehaviorInterceptor[Outer, Inner]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val interceptMessageClass: Class[Outer]
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
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.
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
→[B](y: B): (BehaviorInterceptor[Outer, Inner], B)
- Implicit
- This member is added by an implicit conversion from BehaviorInterceptor[Outer, Inner] to ArrowAssoc[BehaviorInterceptor[Outer, Inner]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc