akka.typed

Class ScalaDSL.Tap<T>

java.lang.Object

akka.typed.Behavior<T>

akka.typed.ScalaDSL.Tap<T>

All Implemented Interfaces:

java.io.Serializable, scala.Equals, scala.Product

Enclosing class:

ScalaDSL

public static final class ScalaDSL.Tap<T>
extends Behavior<T>
implements scala.Product, scala.Serializable

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.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class akka.typed.Behavior

Behavior.emptyBehavior$, Behavior.ignoreBehavior$, Behavior.sameBehavior$, Behavior.stoppedBehavior$, Behavior.unhandledBehavior$

Constructor Summary

Constructors

Constructor and Description
Tap(scala.PartialFunction<ScalaDSL.MessageOrSignal<T>,scala.runtime.BoxedUnit> f, Behavior<T> behavior)

Method Summary

Modifier and Type	Method and Description
Behavior<T>	behavior()
scala.PartialFunction<ScalaDSL.MessageOrSignal<T>,scala.runtime.BoxedUnit>	f()
Behavior<T>	management(ActorContext<T> ctx, Signal msg) Process an incoming Signal and return the next behavior.
Behavior<T>	message(ActorContext<T> ctx, T msg) Process an incoming message and return the next behavior.
java.lang.String	toString()

Methods inherited from class akka.typed.Behavior

canonicalize, isAlive, isUnhandled, narrow, preStart, validateAsInitial

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface scala.Product

$init$, productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

Tap

public Tap(scala.PartialFunction<ScalaDSL.MessageOrSignal<T>,scala.runtime.BoxedUnit> f,
           Behavior<T> behavior)

Method Detail

f

public scala.PartialFunction<ScalaDSL.MessageOrSignal<T>,scala.runtime.BoxedUnit> f()

behavior

public Behavior<T> behavior()

management

public Behavior<T> management(ActorContext<T> ctx,
                              Signal msg)

Description copied from class: 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.

Specified by:

management in class Behavior<T>

Parameters:

ctx - (undocumented)

msg - (undocumented)

Returns:

(undocumented)

message

public Behavior<T> message(ActorContext<T> ctx,
                           T msg)

Description copied from class: 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.

Specified by:

message in class Behavior<T>

Parameters:

ctx - (undocumented)

msg - (undocumented)

Returns:

(undocumented)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object