Behaviors

Type Members

trait Receive[T] extends ExtensibleBehavior[T]

Immutable behavior that exposes additional fluent DSL methods to further change the message or signal reception behavior.
Immutable behavior that exposes additional fluent DSL methods to further change the message or signal reception behavior.

Annotations
@DoNotInherit()
final class Supervise[T] extends AnyVal

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def empty[T]: Behavior[T]

A behavior that treats every incoming message as unhandled.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def ignore[T]: Behavior[T]

A behavior that ignores every incoming message and returns “same”.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def monitor[T](monitor: ActorRef[T], behavior: Behavior[T])(implicit arg0: ClassTag[T]): Behavior[T]

Behavior decorator that copies all received message to the designated monitor akka.actor.typed.ActorRef before invoking the wrapped behavior.
Behavior decorator that copies all received message to the designated monitor akka.actor.typed.ActorRef before invoking the wrapped behavior. The wrapped behavior can evolve (i.e. return different behavior) without needing to be wrapped in a monitor call again.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def receive[T](onMessage: (ActorContext[T], T) ⇒ Behavior[T]): Receive[T]

Construct an actor behavior that can react to both incoming messages and lifecycle signals.
Construct an actor behavior that can react to both incoming messages and lifecycle signals. After spawning this actor from another actor (or as the guardian of an akka.actor.typed.ActorSystem) it will be executed within an ActorContext that allows access to the system, spawning and watching other actors, etc.
This constructor is called immutable because the behavior instance does not need and in fact should not use (close over) mutable variables, but instead return a potentially different behavior encapsulating any state changes.
def receiveMessage[T](onMessage: (T) ⇒ Behavior[T]): Receive[T]

Simplified version of Receive with only a single argument - the message to be handled.
Simplified version of Receive with only a single argument - the message to be handled. Useful for when the context is already accessible by other means, like being wrapped in an setup or similar.
Construct an actor behavior that can react to both incoming messages and lifecycle signals. After spawning this actor from another actor (or as the guardian of an akka.actor.typed.ActorSystem) it will be executed within an ActorContext that allows access to the system, spawning and watching other actors, etc.
This constructor is called immutable because the behavior instance does not need and in fact should not use (close over) mutable variables, but instead return a potentially different behavior encapsulating any state changes.
def receiveMessagePartial[T](onMessage: PartialFunction[T, Behavior[T]]): Receive[T]

Construct an immutable actor behavior from a partial message handler which treats undefined messages as unhandled.
Construct an immutable actor behavior from a partial message handler which treats undefined messages as unhandled.
Behaviors can also be composed with Behavior#orElse.
def receivePartial[T](onMessage: PartialFunction[(ActorContext[T], T), Behavior[T]]): Receive[T]

Construct an immutable actor behavior from a partial message handler which treats undefined messages as unhandled.
Construct an immutable actor behavior from a partial message handler which treats undefined messages as unhandled.
Behaviors can also be composed with Behavior#orElse.
def receiveSignal[T](handler: PartialFunction[(ActorContext[T], Signal), Behavior[T]]): Behavior[T]

Construct an actor behavior that can react to lifecycle signals only.
def same[T]: Behavior[T]

Return this behavior from message processing in order to advise the system to reuse the previous behavior.
Return this behavior from message processing in order to advise the system to reuse the previous behavior. This is provided in order to avoid the allocation overhead of recreating the current behavior where that is not necessary.
def setup[T](factory: (ActorContext[T]) ⇒ Behavior[T]): Behavior[T]

setup is a factory for a behavior.
setup is a factory for a behavior. Creation of the behavior instance is deferred until the actor is started, as opposed to Behaviors.receive that creates the behavior instance immediately before the actor is running. The factory function pass the ActorContext as parameter and that can for example be used for spawning child actors.
setup is typically used as the outer most behavior when spawning an actor, but it can also be returned as the next behavior when processing a message or signal. In that case it will be started immediately after it is returned, i.e. next message will be processed by the started behavior.
def stopped[T](postStop: Behavior[T]): Behavior[T]

Return this behavior from message processing to signal that this actor shall terminate voluntarily.
Return this behavior from message processing to signal that this actor shall terminate voluntarily. If this actor has created child actors then these will be stopped as part of the shutdown procedure.
The PostStop signal that results from stopping this actor will be passed to the given postStop behavior. All other messages and signals will effectively be ignored.
def stopped[T]: Behavior[T]

Return this behavior from message processing to signal that this actor shall terminate voluntarily.
Return this behavior from message processing to signal that this actor shall terminate voluntarily. If this actor has created child actors then these will be stopped as part of the shutdown procedure.
The PostStop signal that results from stopping this actor will be passed to the current behavior. All other messages and signals will effectively be ignored.
def supervise[T](wrapped: Behavior[T]): Supervise[T]

Wrap the given behavior with the given SupervisorStrategy for the given exception.
Wrap the given behavior with the given SupervisorStrategy for the given exception. Exceptions that are not subtypes of Thr will not be caught and thus lead to the termination of the actor.
It is possible to specify different supervisor strategies, such as restart, resume, backoff.
Note that only scala.util.control.NonFatal throwables will trigger the supervision strategy.
Example:
```
val dbConnector: Behavior[DbCommand] = ...

val dbRestarts =
   Behaviors.supervise(dbConnector)
     .onFailure(SupervisorStrategy.restart) // handle all NonFatal exceptions

val dbSpecificResumes =
   Behaviors.supervise(dbConnector)
     .onFailure[IndexOutOfBoundsException](SupervisorStrategy.resume) // resume for IndexOutOfBoundsException exceptions
```
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def tap[T](behavior: Behavior[T])(onMessage: (ActorContext[T], T) ⇒ Unit, onSignal: (ActorContext[T], Signal) ⇒ Unit)(implicit arg0: ClassTag[T]): Behavior[T]

This type of Behavior wraps another Behavior while allowing you to perform some action upon each received message or signal.
This type of Behavior wraps another Behavior while allowing you to perform some action upon each received message or signal. It is most commonly used for logging or tracing what a certain Actor does.
def toString(): String

Definition Classes
AnyRef → Any
def unhandled[T]: Behavior[T]

Return this behavior from message processing in order to advise the system to reuse the previous behavior, including the hint that the message has not been handled.
Return this behavior from message processing in order to advise the system to reuse the previous behavior, including the hint that the message has not been handled. This hint may be used by composite behaviors that delegate (partial) handling to other behaviors.
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def withMdc[T](staticMdc: Map[String, Any], mdcForMessage: (T) ⇒ Map[String, Any])(behavior: Behavior[T]): Behavior[T]

Combination of static and per message MDC (Mapped Diagnostic Context).
Combination of static and per message MDC (Mapped Diagnostic Context).
Each message will get the static MDC plus the MDC returned for the message. If the same key are in both the static and the per message MDC the per message one overwrites the static one in the resulting log entries.
The staticMdc or mdcForMessage may be empty.
staticMdc
A static MDC applied for each message
mdcForMessage
Is invoked before each message is handled, allowing to setup MDC, MDC is cleared after each message processing by the inner behavior is done.
behavior
The actual behavior handling the messages, the MDC is used for the log entries logged through ActorContext.log See also akka.actor.typed.Logger.withMdc
def withMdc[T](staticMdc: Map[String, Any])(behavior: Behavior[T]): Behavior[T]

Static MDC (Mapped Diagnostic Context)
Static MDC (Mapped Diagnostic Context)
staticMdc
This MDC is setup in the logging context for every message
behavior
The actual behavior handling the messages, the MDC is used for the log entries logged through ActorContext.log See also akka.actor.typed.Logger.withMdc
def withMdc[T](mdcForMessage: (T) ⇒ Map[String, Any])(behavior: Behavior[T]): Behavior[T]

Per message MDC (Mapped Diagnostic Context) logging.
Per message MDC (Mapped Diagnostic Context) logging.
mdcForMessage
Is invoked before each message is handled, allowing to setup MDC, MDC is cleared after each message processing by the inner behavior is done.
behavior
The actual behavior handling the messages, the MDC is used for the log entries logged through ActorContext.log See also akka.actor.typed.Logger.withMdc
def withTimers[T](factory: (TimerScheduler[T]) ⇒ Behavior[T]): Behavior[T]

Support for scheduled self messages in an actor.
Support for scheduled self messages in an actor. It takes care of the lifecycle of the timers such as cancelling them when the actor is restarted or stopped.

See also
TimerScheduler

Deprecated Value Members

def tap[T](onMessage: Function2[ActorContext[T], T, _], onSignal: Function2[ActorContext[T], Signal, _], behavior: Behavior[T])(implicit arg0: ClassTag[T]): Behavior[T]

This type of Behavior wraps another Behavior while allowing you to perform some action upon each received message or signal.
This type of Behavior wraps another Behavior while allowing you to perform some action upon each received message or signal. It is most commonly used for logging or tracing what a certain Actor does.

Annotations
@deprecated
Deprecated
(Since version 2.5.13) Use overloaded tap

Related Doc: package scaladsl

object Behaviors

Type Members

trait Receive[T] extends ExtensibleBehavior[T]

final class Supervise[T] extends AnyVal

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def empty[T]: Behavior[T]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

def ignore[T]: Behavior[T]

final def isInstanceOf[T0]: Boolean

def monitor[T](monitor: ActorRef[T], behavior: Behavior[T])(implicit arg0: ClassTag[T]): Behavior[T]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def receive[T](onMessage: (ActorContext[T], T) ⇒ Behavior[T]): Receive[T]

def receiveMessage[T](onMessage: (T) ⇒ Behavior[T]): Receive[T]

def receiveMessagePartial[T](onMessage: PartialFunction[T, Behavior[T]]): Receive[T]

def receivePartial[T](onMessage: PartialFunction[(ActorContext[T], T), Behavior[T]]): Receive[T]

def receiveSignal[T](handler: PartialFunction[(ActorContext[T], Signal), Behavior[T]]): Behavior[T]

def same[T]: Behavior[T]

def setup[T](factory: (ActorContext[T]) ⇒ Behavior[T]): Behavior[T]

def stopped[T](postStop: Behavior[T]): Behavior[T]

def stopped[T]: Behavior[T]

def supervise[T](wrapped: Behavior[T]): Supervise[T]

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

def tap[T](behavior: Behavior[T])(onMessage: (ActorContext[T], T) ⇒ Unit, onSignal: (ActorContext[T], Signal) ⇒ Unit)(implicit arg0: ClassTag[T]): Behavior[T]

def toString(): String

def unhandled[T]: Behavior[T]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withMdc[T](staticMdc: Map[String, Any], mdcForMessage: (T) ⇒ Map[String, Any])(behavior: Behavior[T]): Behavior[T]

def withMdc[T](staticMdc: Map[String, Any])(behavior: Behavior[T]): Behavior[T]

def withMdc[T](mdcForMessage: (T) ⇒ Map[String, Any])(behavior: Behavior[T]): Behavior[T]

def withTimers[T](factory: (TimerScheduler[T]) ⇒ Behavior[T]): Behavior[T]

Deprecated Value Members

def tap[T](onMessage: Function2[ActorContext[T], T, _], onSignal: Function2[ActorContext[T], Signal, _], behavior: Behavior[T])(implicit arg0: ClassTag[T]): Behavior[T]

Inherited from AnyRef

Inherited from Any

Ungrouped