abstract class Receive[T] extends ExtensibleBehavior[T]

A specialized "receive" behavior that is implemented using message matching builders, such as ReceiveBuilder, from AbstractBehavior.

Annotations
@DoNotInherit()
Source
Receive.scala
Linear Supertypes
ExtensibleBehavior[T], Behavior[T], AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Receive
  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. Protected

Instance Constructors

  1. new Receive()

Abstract Value Members

  1. abstract def receiveMessage(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

    Annotations
    @throws(classOf[Exception])
  2. abstract def receiveSignal(sig: Signal): Behavior[T]

    Process an incoming akka.actor.typed.Signal and return the next behavior.

    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 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. val behavior: Behavior[T]
    Implicit
    This member is added by an implicit conversion from Receive[T] toBehaviorDecorators[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 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.

    Definition Classes
    → ExtensibleBehavior
    Annotations
    @throws(classOf[Exception])
  4. final def receiveSignal(ctx: TypedActorContext[T], sig: 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.

    Definition Classes
    → ExtensibleBehavior
    Annotations
    @throws(classOf[Exception])
  5. 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 Receive[T] toBehaviorDecorators[T] performed by method BehaviorDecorators in akka.actor.typed.Behavior.
    Definition Classes
    BehaviorDecorators