Class Receive<T>

  • Direct Known Subclasses:
    BuiltReceive

    public abstract class Receive<T>
    extends ExtensibleBehavior<T>
    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

    • Constructor Detail

      • Receive

        public Receive()
    • Method Detail

      • receiveMessage

        public abstract Behavior<T> receiveMessage​(T msg)
                                            throws java.lang.Exception
        Throws:
        java.lang.Exception
      • receiveSignal

        public abstract Behavior<T> receiveSignal​(Signal sig)
                                           throws java.lang.Exception
        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

        Parameters:
        sig - (undocumented)
        Returns:
        (undocumented)
        Throws:
        java.lang.Exception
      • receiveSignal

        public final Behavior<T> receiveSignal​(TypedActorContext<T> ctx,
                                               Signal sig)
                                        throws java.lang.Exception
        Description copied from class: ExtensibleBehavior
        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:
        receiveSignal in class ExtensibleBehavior<T>
        Parameters:
        ctx - (undocumented)
        sig - (undocumented)
        Returns:
        (undocumented)
        Throws:
        java.lang.Exception