public class ActorSource extends java.lang.Object
|Constructor and Description|
|Modifier and Type||Method and Description|
public static <T> Source<T,ActorRef<T>> actorRef(java.util.function.Predicate<T> completionMatcher, scala.PartialFunction<T,java.lang.Throwable> failureMatcher, int bufferSize, OverflowStrategy overflowStrategy)
Sourcethat is materialized as an
ActorRef. Messages sent to this actor will be emitted to the stream if there is demand from downstream, otherwise they will be buffered until request for demand is received.
Depending on the defined
OverflowStrategy it might drop elements if
there is no space available in the buffer.
akka.stream.OverflowStrategy.backpressure is not supported, and an
IllegalArgument("Backpressure overflowStrategy not supported") will be thrown if it is passed as argument.
The buffer can be disabled by using
bufferSize of 0 and then received messages are dropped if there is no demand
from downstream. When
bufferSize is 0 the
overflowStrategy does not matter. An async boundary is added after
this Source; as such, it is never safe to assume the downstream will always generate demand.
The stream can be completed successfully by sending the actor reference a
(whose content will be ignored) in which case already buffered elements will be signaled before signaling
completion, or by sending
PoisonPill in which case completion will be signaled immediately.
The stream can be completed with failure by sending a
Status.Failure to the
actor reference. In case the Actor is still draining its internal buffer (after having received
Status.Success) before signaling completion and it receives a
the failure will be signaled downstream immediately (instead of the completion signal).
The actor will be stopped when the stream is completed, failed or canceled from downstream, i.e. you can watch it to get notified when that happens.
bufferSize- The size of the buffer in element count
overflowStrategy- Strategy that is used when incoming elements cannot fit inside the buffer