Class/Object

akka.actor.typed

Behavior

Related Docs: object Behavior | package typed

Permalink

sealed 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
@InternalApi() @DoNotInherit()
Source
Behavior.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
ExtensibleBehavior, MutableBehavior, MutableBehavior, Receive, Receive
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

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Behavior[T] to any2stringadd[Behavior[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (Behavior[T], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Behavior[T] to ArrowAssoc[Behavior[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. val behavior: Behavior[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Behavior[T] to BehaviorDecorators[T] performed by method BehaviorDecorators in akka.actor.typed.Behavior.
    Definition Classes
    BehaviorDecorators

  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  9. def ensuring(cond: (Behavior[T]) ⇒ Boolean, msg: ⇒ Any): Behavior[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Behavior[T] to Ensuring[Behavior[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: (Behavior[T]) ⇒ Boolean): Behavior[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Behavior[T] to Ensuring[Behavior[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean, msg: ⇒ Any): Behavior[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Behavior[T] to Ensuring[Behavior[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: Boolean): Behavior[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Behavior[T] to Ensuring[Behavior[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  16. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Behavior[T] to StringFormat[Behavior[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  18. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  20. final def narrow[U <: T]: Behavior[U]

    Permalink

    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).

  21. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  22. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  24. final def orElse(that: Behavior[T]): Behavior[T]

    Permalink

    Composes this Behavior with a fallback Behavior which is used when this Behavior doesn't handle the message or signal, i.e. when unhandled is returned.

    Composes this Behavior with a fallback Behavior which is used when this Behavior doesn't handle the message or signal, i.e. when unhandled is returned.

    that

    the fallback Behavior

  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  26. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  27. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  28. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  29. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. def widen[U](matcher: PartialFunction[U, T]): Behavior[U]

    Permalink

    Widen the wrapped Behavior by placing a funnel in front of it: 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.

    Widen the wrapped Behavior by placing a funnel in front of it: 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:

    receive[String] { (ctx, msg) => println(msg); same }.widen[Number] {
  case b: BigDecimal => s"BigDecimal($b)"
  case i: BigInteger => s"BigInteger($i)"
  // all other kinds of Number will be `unhandled`
}

    Scheduled messages via akka.actor.typed.scaladsl.TimerScheduler can currently not be used together with widen, see issue #25318.

    Implicit information
    This member is added by an implicit conversion from Behavior[T] to BehaviorDecorators[T] performed by method BehaviorDecorators in akka.actor.typed.Behavior.
    Definition Classes
    BehaviorDecorators

  31. def →[B](y: B): (Behavior[T], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Behavior[T] to ArrowAssoc[Behavior[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion BehaviorDecorators from Behavior[T] to BehaviorDecorators[T]

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

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

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

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

Ungrouped