c

akka.actor.typed

ExtensibleBehavior

abstract class ExtensibleBehavior[T] extends Behavior[T]

Extension point for implementing custom behaviors in addition to the existing set of behaviors available through the DSLs in akka.actor.typed.scaladsl.Behaviors and akka.actor.typed.javadsl.Behaviors

Note that behaviors that keep an inner behavior, and intercepts messages for it should not be implemented as an extensible behavior but should instead use the BehaviorInterceptor

Source
Behavior.scala
Linear Supertypes
Behavior[T], AnyRef, Any
Known Subclasses
AbstractBehavior, Receive, AbstractBehavior
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ExtensibleBehavior
  2. Behavior
  3. AnyRef
  4. 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 ExtensibleBehavior()

Abstract Value Members

  1. abstract 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 * 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.

    Annotations
    @throws( classOf[Exception] )
  2. abstract def receiveSignal(ctx: TypedActorContext[T], msg: 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 * 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.

    Annotations
    @throws( classOf[Exception] )

Concrete Value Members

  1. val behavior: Behavior[T]
    Implicit
    This member is added by an implicit conversion from ExtensibleBehavior[T] to BehaviorDecorators[T] performed by method BehaviorDecorators in akka.actor.typed.Behavior.
    Definition Classes
    BehaviorDecorators
  2. 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
  3. final def orElse(that: Behavior[T]): Behavior[T]

    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
  4. def widen[U](matcher: PartialFunction[U, T]): Behavior[U]

    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
    This member is added by an implicit conversion from ExtensibleBehavior[T] to BehaviorDecorators[T] performed by method BehaviorDecorators in akka.actor.typed.Behavior.
    Definition Classes
    BehaviorDecorators