Class

akka.actor.typed.scaladsl

MutableBehavior

Related Doc: package scaladsl

Permalink

abstract class MutableBehavior[T] extends ExtensibleBehavior[T]

Mutable behavior can be implemented by extending this class and implement the abstract method MutableBehavior#onMessage and optionally override MutableBehavior#onSignal.

Instances of this behavior should be created via Behaviors#setup and if the ActorContext is needed it can be passed as a constructor parameter from the factory function.

Source
MutableBehavior.scala
See also

Behaviors#setup

Linear Supertypes
ExtensibleBehavior[T], Behavior[T], AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MutableBehavior
  2. ExtensibleBehavior
  3. Behavior
  4. AnyRef
  5. 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 MutableBehavior()

    Permalink

Abstract Value Members

  1. abstract def onMessage(msg: T): Behavior[T]

    Permalink

    Implement this method to process an incoming message and return the next behavior.

    Implement this method to 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
    • returning this or same designates to reuse the current Behavior
    • returning unhandled keeps the same Behavior and signals that the message was not yet handled
    Annotations
    @throws( classOf[Exception] )

Concrete 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 MutableBehavior[T] to any2stringadd[MutableBehavior[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (MutableBehavior[T], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from MutableBehavior[T] to ArrowAssoc[MutableBehavior[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 MutableBehavior[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: (MutableBehavior[T]) ⇒ Boolean, msg: ⇒ Any): MutableBehavior[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from MutableBehavior[T] to Ensuring[MutableBehavior[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (MutableBehavior[T]) ⇒ Boolean): MutableBehavior[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from MutableBehavior[T] to Ensuring[MutableBehavior[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: ⇒ Any): MutableBehavior[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from MutableBehavior[T] to Ensuring[MutableBehavior[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): MutableBehavior[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from MutableBehavior[T] to Ensuring[MutableBehavior[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 MutableBehavior[T] to StringFormat[MutableBehavior[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).

    Definition Classes
    Behavior
  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. def onSignal: PartialFunction[Signal, Behavior[T]]

    Permalink

    Override this method to process an incoming akka.actor.typed.Signal and return the next behavior.

    Override this method to process an incoming akka.actor.typed.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 * returning this or same designates to reuse the current Behavior * returning unhandled keeps the same Behavior and signals that the message was not yet handled

    By default, partial function is empty and does not handle any signals.

    Annotations
    @throws( classOf[Exception] )
  25. 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

    Definition Classes
    Behavior
  26. final def receive(ctx: typed.ActorContext[T], msg: T): Behavior[T]

    Permalink

    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 * returning same designates to reuse the current Behavior * returning unhandled keeps the same Behavior and signals that the message was not yet handled

    Code calling this method should use Behavior$ canonicalize to replace the special objects with real Behaviors.

    Definition Classes
    MutableBehaviorExtensibleBehavior
    Annotations
    @throws( classOf[Exception] )
  27. final def receiveSignal(ctx: typed.ActorContext[T], msg: Signal): Behavior[T]

    Permalink

    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 * returning same designates to reuse the current Behavior * returning unhandled keeps the same Behavior and signals that the message was not yet handled

    Code calling this method should use Behavior$ canonicalize to replace the special objects with real Behaviors.

    Definition Classes
    MutableBehaviorExtensibleBehavior
    Annotations
    @throws( classOf[Exception] )
  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  29. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  30. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. 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 MutableBehavior[T] to BehaviorDecorators[T] performed by method BehaviorDecorators in akka.actor.typed.Behavior.
    Definition Classes
    BehaviorDecorators
  34. def [B](y: B): (MutableBehavior[T], B)

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

Inherited from ExtensibleBehavior[T]

Inherited from Behavior[T]

Inherited from AnyRef

Inherited from Any

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

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

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

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

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

Ungrouped