Package akka.stream.typed.javadsl

Class ActorSink

  • public class ActorSink
extends java.lang.Object
    Sends the elements of the stream to the given ActorRef. If the target actor terminates the stream will be canceled. When the stream is completed successfully the given onCompleteMessage will be sent to the destination actor. When the stream is completed with failure a the throwable that was signaled to the stream is adapted to the Actors protocol using onFailureMessage and then then sent to the destination actor.

    It will request at most maxInputBufferSize number of elements from upstream, but there is no back-pressure signal from the destination actor, i.e. if the actor is not consuming the messages fast enough the mailbox of the actor will grow. For potentially slow consumer actors it is recommended to use a bounded mailbox with zero mailbox-push-timeout-time or use a rate limiting operator in front of this Sink.

    • Constructor Summary

      Constructors 
      Constructor Description
      ActorSink()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static <T> Sink<T,​NotUsed> actorRef​(ActorRef<T> ref, T onCompleteMessage, Function<java.lang.Throwable,​T> onFailureMessage)  
      static <T,​M,​A>
      Sink<T,​NotUsed>      		 actorRefWithAck​(ActorRef<M> ref, Function2<ActorRef<A>,​T,​M> messageAdapter, Function<ActorRef<A>,​M> onInitMessage, A ackMessage, M onCompleteMessage, Function<java.lang.Throwable,​M> onFailureMessage)
      Sends the elements of the stream to the given ActorRef that sends back back-pressure signal.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ActorSink

        public ActorSink()

    • Method Detail

      • actorRef

        public static <T> Sink<T,​NotUsed> actorRef​(ActorRef<T> ref,
                                                 T onCompleteMessage,
                                                 Function<java.lang.Throwable,​T> onFailureMessage)

      • actorRefWithAck

        public static <T,​M,​A> Sink<T,​NotUsed> actorRefWithAck​(ActorRef<M> ref,
                                                                        Function2<ActorRef<A>,​T,​M> messageAdapter,
                                                                        Function<ActorRef<A>,​M> onInitMessage,
                                                                        A ackMessage,
                                                                        M onCompleteMessage,
                                                                        Function<java.lang.Throwable,​M> onFailureMessage)
        Sends the elements of the stream to the given ActorRef that sends back back-pressure signal. First element is always onInitMessage, then stream is waiting for acknowledgement message ackMessage from the given actor which means that it is ready to process elements. It also requires ackMessage message after each stream element to make backpressure work.

        If the target actor terminates the stream will be canceled. When the stream is completed successfully the given onCompleteMessage will be sent to the destination actor. When the stream is completed with failure - result of onFailureMessage(throwable) function will be sent to the destination actor.

        Parameters:
        ref - (undocumented)
        messageAdapter - (undocumented)
        onInitMessage - (undocumented)
        ackMessage - (undocumented)
        onCompleteMessage - (undocumented)
        onFailureMessage - (undocumented)
        Returns:
        (undocumented)