abstract class Behavior[T] extends AnyRef

The behavior of an actor defines how it reacts to the messages that it receives. The message may either be of the type that the Actor declares and which is part of the ActorRef signature, or it may be a system Signal that expresses a lifecycle event of either this actor or one of its child actors.

Behaviors can be formulated in a number of different ways, either by using the DSLs in akka.actor.typed.scaladsl.Behaviors and akka.actor.typed.javadsl.Behaviors or extending the abstract ExtensibleBehavior class.

Closing over ActorContext makes a Behavior immobile: it cannot be moved to another context and executed there, and therefore it cannot be replicated or forked either.

This base class is not meant to be extended by user code. If you do so, you may lose binary compatibility.

Not for user extension.

Self Type
Behavior[T]
Annotations
@DoNotInherit()
Source
Behavior.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Behavior
  2. AnyRef
  3. Any
Implicitly
  1. by BehaviorDecorators
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Behavior(_tag: Int)

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 Behavior[T] toany2stringadd[Behavior[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Behavior[T], B)
    Implicit
    This member is added by an implicit conversion from Behavior[T] toArrowAssoc[Behavior[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val behavior: Behavior[T]
    Implicit
    This member is added by an implicit conversion from Behavior[T] toBehaviorDecorators[T] performed by method BehaviorDecorators in akka.actor.typed.Behavior.
    Definition Classes
    BehaviorDecorators
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. def ensuring(cond: (Behavior[T]) => Boolean, msg: => Any): Behavior[T]
    Implicit
    This member is added by an implicit conversion from Behavior[T] toEnsuring[Behavior[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (Behavior[T]) => Boolean): Behavior[T]
    Implicit
    This member is added by an implicit conversion from Behavior[T] toEnsuring[Behavior[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): Behavior[T]
    Implicit
    This member is added by an implicit conversion from Behavior[T] toEnsuring[Behavior[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): Behavior[T]
    Implicit
    This member is added by an implicit conversion from Behavior[T] toEnsuring[Behavior[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Behavior[T] toStringFormat[Behavior[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. 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).

  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. 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 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.

    Implicit
    This member is added by an implicit conversion from Behavior[T] toBehaviorDecorators[T] performed by method BehaviorDecorators in akka.actor.typed.Behavior.
    Definition Classes
    BehaviorDecorators
  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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  2. def [B](y: B): (Behavior[T], B)
    Implicit
    This member is added by an implicit conversion from Behavior[T] toArrowAssoc[Behavior[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.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion BehaviorDecorators fromBehavior[T] to BehaviorDecorators[T]

Inherited by implicit conversion any2stringadd fromBehavior[T] to any2stringadd[Behavior[T]]

Inherited by implicit conversion StringFormat fromBehavior[T] to StringFormat[Behavior[T]]

Inherited by implicit conversion Ensuring fromBehavior[T] to Ensuring[Behavior[T]]

Inherited by implicit conversion ArrowAssoc fromBehavior[T] to ArrowAssoc[Behavior[T]]

Ungrouped