abstract class BehaviorInterceptor[O, I] 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. Many 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 the instance in a setup
block
so that a new instance is created per spawned actor rather than shared among actor instance.
- O
The outer message type – the type of messages the intercepting behavior will accept
- I
The inner message type - the type of message the wrapped behavior accepts
- Alphabetic
- By Inheritance
- BehaviorInterceptor
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new BehaviorInterceptor()
Abstract Value Members
-
abstract
def
aroundReceive(ctx: TypedActorContext[O], msg: O, target: ReceiveTarget[I]): Behavior[I]
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
-
abstract
def
aroundSignal(ctx: TypedActorContext[O], signal: Signal, target: SignalTarget[I]): Behavior[I]
Intercept a signal sent to the running actor.
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
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[O, I] to any2stringadd[BehaviorInterceptor[O, I]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (BehaviorInterceptor[O, I], B)
- Implicit
- This member is added by an implicit conversion from BehaviorInterceptor[O, I] to ArrowAssoc[BehaviorInterceptor[O, I]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
aroundStart(ctx: TypedActorContext[O], target: PreStartTarget[I]): Behavior[I]
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[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
-
def
ensuring(cond: (BehaviorInterceptor[O, I]) ⇒ Boolean, msg: ⇒ Any): BehaviorInterceptor[O, I]
- Implicit
- This member is added by an implicit conversion from BehaviorInterceptor[O, I] to Ensuring[BehaviorInterceptor[O, I]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (BehaviorInterceptor[O, I]) ⇒ Boolean): BehaviorInterceptor[O, I]
- Implicit
- This member is added by an implicit conversion from BehaviorInterceptor[O, I] to Ensuring[BehaviorInterceptor[O, I]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): BehaviorInterceptor[O, I]
- Implicit
- This member is added by an implicit conversion from BehaviorInterceptor[O, I] to Ensuring[BehaviorInterceptor[O, I]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): BehaviorInterceptor[O, I]
- Implicit
- This member is added by an implicit conversion from BehaviorInterceptor[O, I] to Ensuring[BehaviorInterceptor[O, I]] 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[O, I] to StringFormat[BehaviorInterceptor[O, I]] 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()
-
def
interceptMessageType: Class[_ <: O]
Allows for applying the interceptor only to certain message types.
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 whenO
andI
are the same type.- returns
A subtype of
O
that should be intercepted ornull
to intercept allO
s. Subtypes ofO
matching this are passed directly to the inner behavior without interception.
-
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
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
→[B](y: B): (BehaviorInterceptor[O, I], B)
- Implicit
- This member is added by an implicit conversion from BehaviorInterceptor[O, I] to ArrowAssoc[BehaviorInterceptor[O, I]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc