abstract class AbstractOnMessageBehavior[T] extends ExtensibleBehavior[T]
An actor Behavior
can be implemented by extending this class and implementing the abstract
method AbstractOnMessageBehavior#onMessage. Mutable state can be defined as instance
variables of the class.
This is an object-oriented style of defining a Behavior
. A more functional style alternative
is provided by the factory methods in Behaviors, for example Behaviors.receiveMessage.
An alternative object-oriented style is found in AbstractBehavior, which uses builders to
define the Behavior
. In contrast to extending AbstractBehavior, extending this class
should have reduced overhead, though depending on the complexity of the protocol handled by
this actor and on the Java version in use, the onMessage
and onSignal
methods may be overly
complex.
Instances of this behavior should be created via Behaviors.setup and the ActorContext should be passed as a constructor parameter from the factory function. This is important because a new instance should be created when restart supervision is used.
When switching behavior to another behavior which requires a context, the original ActorContext
can
be used or a Behaviors.setup
can be used: either will end up using the same ActorContext
instance.
It must not be created with an ActorContext
of another actor (e.g. the parent actor). Doing so
will be detected at runtime and throw an IllegalStateException
when the first message is received.
- Source
- AbstractOnMessageBehavior.scala
- See also
- Alphabetic
- By Inheritance
- AbstractOnMessageBehavior
- ExtensibleBehavior
- Behavior
- AnyRef
- Any
- by BehaviorDecorators
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new AbstractOnMessageBehavior(context: ActorContext[T])
Abstract Value Members
- abstract def onMessage(message: T): Behavior[T]
Implement this to define how messages are processed.
Implement this to define how messages are processed. To indicate no change in behavior beyond changes due to updating instance variables of this class, one may return either
this
or Behaviors.same.- Annotations
- @throws(classOf[Exception])
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 AbstractOnMessageBehavior[T] toany2stringadd[AbstractOnMessageBehavior[T]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (AbstractOnMessageBehavior[T], B)
- Implicit
- This member is added by an implicit conversion from AbstractOnMessageBehavior[T] toArrowAssoc[AbstractOnMessageBehavior[T]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val behavior: Behavior[T]
- Implicit
- This member is added by an implicit conversion from AbstractOnMessageBehavior[T] toBehaviorDecorators[T] performed by method BehaviorDecorators in akka.actor.typed.Behavior.
- Definition Classes
- BehaviorDecorators
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- def ensuring(cond: (AbstractOnMessageBehavior[T]) => Boolean, msg: => Any): AbstractOnMessageBehavior[T]
- Implicit
- This member is added by an implicit conversion from AbstractOnMessageBehavior[T] toEnsuring[AbstractOnMessageBehavior[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (AbstractOnMessageBehavior[T]) => Boolean): AbstractOnMessageBehavior[T]
- Implicit
- This member is added by an implicit conversion from AbstractOnMessageBehavior[T] toEnsuring[AbstractOnMessageBehavior[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): AbstractOnMessageBehavior[T]
- Implicit
- This member is added by an implicit conversion from AbstractOnMessageBehavior[T] toEnsuring[AbstractOnMessageBehavior[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): AbstractOnMessageBehavior[T]
- Implicit
- This member is added by an implicit conversion from AbstractOnMessageBehavior[T] toEnsuring[AbstractOnMessageBehavior[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def getContext: ActorContext[T]
- Attributes
- protected
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def narrow[U <: T]: Behavior[U]
Narrow the type of this Behavior, which is always a safe operation.
Narrow the type of this Behavior, which is always a safe operation. This method is necessary to implement the contravariant nature of Behavior (which cannot be expressed directly due to type inference problems).
- Definition Classes
- Behavior
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def onSignal(signal: Signal): Behavior[T]
Override this to handle a signal.
Override this to handle a signal. The default implementation handles only
MessageAdaptionFailure
and otherwise ignores the signal.- Annotations
- @throws(classOf[Exception])
- final def receive(ctx: TypedActorContext[T], msg: T): Behavior[T]
Process an incoming message and return the next behavior.
Process an incoming message and return the next behavior.
The returned behavior can in addition to normal behaviors be one of the canned special objects:
* returning
stopped
will terminate this Behavior * returningsame
designates to reuse the current Behavior * returningunhandled
keeps the same Behavior and signals that the message was not yet handledCode calling this method should use Behavior$
canonicalize
to replace the special objects with real Behaviors.- Definition Classes
- AbstractOnMessageBehavior → ExtensibleBehavior
- Annotations
- @throws(classOf[Exception])
- final def receiveSignal(ctx: TypedActorContext[T], signal: Signal): Behavior[T]
Process an incoming Signal and return the next behavior.
Process an incoming Signal and return the next behavior. This means that all lifecycle hooks, ReceiveTimeout, Terminated and Failed messages can initiate a behavior change.
The returned behavior can in addition to normal behaviors be one of the canned special objects:
* returning
stopped
will terminate this Behavior * returningsame
designates to reuse the current Behavior * returningunhandled
keeps the same Behavior and signals that the message was not yet handledCode calling this method should use Behavior$
canonicalize
to replace the special objects with real Behaviors.- Definition Classes
- AbstractOnMessageBehavior → ExtensibleBehavior
- Annotations
- @throws(classOf[Exception])
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def transformMessages[Outer](matcher: PartialFunction[Outer, T])(implicit arg0: ClassTag[Outer]): Behavior[Outer]
Transform the incoming messages by placing a funnel in front of the wrapped
Behavior
: the supplied PartialFunction decides which message to pull in (those that it is defined at) and may transform the incoming message to place them into the wrapped Behavior’s type hierarchy.Transform the incoming messages by placing a funnel in front of the wrapped
Behavior
: the supplied PartialFunction decides which message to pull in (those that it is defined at) and may transform the incoming message to place them into the wrapped Behavior’s type hierarchy. Signals are not transformed.Example:
val b: Behavior[Number] = Behaviors .receive[String] { (ctx, msg) => println(msg) Behaviors.same } .transformMessages[Number] { case b: BigDecimal => s"BigDecimal($b)" case i: BigInt => s"BigInteger($i)" // all other kinds of Number will be `unhandled` }
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.- Implicit
- This member is added by an implicit conversion from AbstractOnMessageBehavior[T] toBehaviorDecorators[T] performed by method BehaviorDecorators in akka.actor.typed.Behavior.
- Definition Classes
- BehaviorDecorators
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from AbstractOnMessageBehavior[T] toStringFormat[AbstractOnMessageBehavior[T]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (AbstractOnMessageBehavior[T], B)
- Implicit
- This member is added by an implicit conversion from AbstractOnMessageBehavior[T] toArrowAssoc[AbstractOnMessageBehavior[T]] 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.