object Sink
- Source
- Sink.scala
- Alphabetic
- By Inheritance
- Sink
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
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
- def actorRef[T](ref: ActorRef, onCompleteMessage: Any, onFailureMessage: (Throwable) => Any): Sink[T, NotUsed]
INTERNAL API
INTERNAL API
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 givenonCompleteMessage
will be sent to the destination actor. When the stream is completed with failure theonFailureMessage
will be invoked and its result will be 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 zeromailbox-push-timeout-time
or use a rate limiting operator in front of thisSink
. - def actorRefWithBackpressure[T](ref: ActorRef, onInitMessage: Any, onCompleteMessage: Any, onFailureMessage: (Throwable) => Any): Sink[T, NotUsed]
Sends the elements of the stream to the given
ActorRef
that sends back back-pressure signal.Sends the elements of the stream to the given
ActorRef
that sends back back-pressure signal. First element is alwaysonInitMessage
, then stream is waiting for acknowledgement message from the given actor which means that it is ready to process elements. It also requires an ack message after each stream element to make backpressure work. This variant will consider any message as ack message.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 ofonFailureMessage(throwable)
function will be sent to the destination actor. - def actorRefWithBackpressure[T](ref: ActorRef, onInitMessage: Any, ackMessage: Any, onCompleteMessage: Any, onFailureMessage: (Throwable) => Any): Sink[T, NotUsed]
Sends the elements of the stream to the given
ActorRef
that sends back back-pressure signal.Sends the elements of the stream to the given
ActorRef
that sends back back-pressure signal. First element is alwaysonInitMessage
, then stream is waiting for acknowledgement messageackMessage
from the given actor which means that it is ready to process elements. It also requiresackMessage
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 ofonFailureMessage(throwable)
function will be sent to the destination actor. - final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def asPublisher[T](fanout: Boolean): Sink[T, Publisher[T]]
A
Sink
that materializes into a org.reactivestreams.Publisher.A
Sink
that materializes into a org.reactivestreams.Publisher.If
fanout
istrue
, the materializedPublisher
will support multipleSubscriber
s and the size of theinputBuffer
configured for this operator becomes the maximum number of elements that the fastest org.reactivestreams.Subscriber can be ahead of the slowest one before slowing the processing down due to back pressure.If
fanout
isfalse
then the materializedPublisher
will only support a singleSubscriber
and reject any additionalSubscriber
s. - def cancelled[T]: Sink[T, NotUsed]
A
Sink
that immediately cancels its upstream after materialization. - def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- def collection[T, That](implicit cbf: Factory[T, That with Iterable[_]]): Sink[T, Future[That]]
A
Sink
that keeps on collecting incoming elements until upstream terminates.A
Sink
that keeps on collecting incoming elements until upstream terminates. As upstream may be unbounded,Flow[T].take
or the stricterFlow[T].limit
(and their variants) may be used to ensure boundedness. Materializes into aFuture
ofThat[T]
containing all the collected elements.That[T]
is limited to the limitations of the CanBuildFrom associated with it. For example,Seq
is limited toInt.MaxValue
elements. See [The Architecture of Scala 2.13's Collections](https://docs.scala-lang.org/overviews/core/architecture-of-scala-213-collections.html) for more info. This Sink will cancel the stream after having received that many elements.See also Flow.limit, Flow.limitWeighted, Flow.take, Flow.takeWithin, Flow.takeWhile
- def combine[T, U, M](sinks: Seq[Graph[SinkShape[U], M]])(fanOutStrategy: (Int) => Graph[UniformFanOutShape[T, U], NotUsed]): Sink[T, Seq[M]]
Combine several sinks with fan-out strategy like
Broadcast
orBalance
and returnsSink
.Combine several sinks with fan-out strategy like
Broadcast
orBalance
and returnsSink
. The fanoutGraph's outlets size must match the provides sinks'.- Since
1.1.0
- def combine[T, U](first: Sink[U, _], second: Sink[U, _], rest: Sink[U, _]*)(fanOutStrategy: (Int) => Graph[UniformFanOutShape[T, U], NotUsed]): Sink[T, NotUsed]
Combine several sinks with fan-out strategy like
Broadcast
orBalance
and returnsSink
. - def combineMat[T, U, M1, M2, M](first: Sink[U, M1], second: Sink[U, M2])(fanOutStrategy: (Int) => Graph[UniformFanOutShape[T, U], NotUsed])(matF: (M1, M2) => M): Sink[T, M]
Combine two sinks with fan-out strategy like
Broadcast
orBalance
and returnsSink
with 2 outlets.Combine two sinks with fan-out strategy like
Broadcast
orBalance
and returnsSink
with 2 outlets.- Since
1.1.0
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def exists[T](p: (T) => Boolean): Sink[T, Future[Boolean]]
A
Sink
that will test the given predicatep
for every received element andA
Sink
that will test the given predicatep
for every received element and- completes and returns scala.concurrent.Future of
true
if the predicate is true for any element; 2. completes and returns scala.concurrent.Future offalse
if the stream is empty (i.e. completes before signalling any elements); 3. completes and returns scala.concurrent.Future offalse
if the predicate is false for all elements.
The materialized value scala.concurrent.Future will be completed with the value
true
orfalse
when the input stream ends, or completed withFailure
if there is a failure signaled in the stream.Adheres to the ActorAttributes.SupervisionStrategy attribute.
Completes when upstream completes or the predicate
p
returnstrue
Backpressures when the invocation of predicate
p
has not yet completedCancels when predicate
p
returnstrue
- Since
1.1.0
- completes and returns scala.concurrent.Future of
- def fold[U, T](zero: U)(f: (U, T) => U): Sink[T, Future[U]]
A
Sink
that will invoke the given function for every received element, giving it its previous output (or the givenzero
value) and the element as input.A
Sink
that will invoke the given function for every received element, giving it its previous output (or the givenzero
value) and the element as input. The returned scala.concurrent.Future will be completed with value of the final function evaluation when the input stream ends, or completed withFailure
if there is a failure signaled in the stream.- See also
- def foldAsync[U, T](zero: U)(f: (U, T) => Future[U]): Sink[T, Future[U]]
A
Sink
that will invoke the given asynchronous function for every received element, giving it its previous output (or the givenzero
value) and the element as input.A
Sink
that will invoke the given asynchronous function for every received element, giving it its previous output (or the givenzero
value) and the element as input. The returned scala.concurrent.Future will be completed with value of the final function evaluation when the input stream ends, or completed withFailure
if there is a failure signaled in the stream.- See also
- def foldWhile[U, T](zero: U)(p: (U) => Boolean)(f: (U, T) => U): Sink[T, Future[U]]
A
Sink
that will invoke the given function for every received element, giving it its previous output (or the givenzero
value) and the element as input.A
Sink
that will invoke the given function for every received element, giving it its previous output (or the givenzero
value) and the element as input. The returned scala.concurrent.Future will be completed with value of the final function evaluation when the input stream ends, predicatep
returns false, or completed withFailure
if there is a failure signaled in the stream.- Since
1.1.0
- See also
- def forall[T](p: (T) => Boolean): Sink[T, Future[Boolean]]
A
Sink
that will test the given predicatep
for every received element andA
Sink
that will test the given predicatep
for every received element and- completes and returns scala.concurrent.Future of
true
if the predicate is true for all elements; 2. completes and returns scala.concurrent.Future oftrue
if the stream is empty (i.e. completes before signalling any elements); 3. completes and returns scala.concurrent.Future offalse
if the predicate is false for any element.
The materialized value scala.concurrent.Future will be completed with the value
true
orfalse
when the input stream ends, or completed withFailure
if there is a failure signaled in the stream.Adheres to the ActorAttributes.SupervisionStrategy attribute.
Completes when upstream completes or the predicate
p
returnsfalse
Backpressures when the invocation of predicate
p
has not yet completedCancels when predicate
p
returnsfalse
- Since
1.1.0
- completes and returns scala.concurrent.Future of
- def foreach[T](f: (T) => Unit): Sink[T, Future[Done]]
A
Sink
that will invoke the given procedure for each received element.A
Sink
that will invoke the given procedure for each received element. The sink is materialized into a scala.concurrent.Future which will be completed withSuccess
when reaching the normal end of the stream, or completed withFailure
if there is a failure signaled in the stream. - def foreachAsync[T](parallelism: Int)(f: (T) => Future[Unit]): Sink[T, Future[Done]]
A
Sink
that will invoke the given procedure asynchronously for each received element.A
Sink
that will invoke the given procedure asynchronously for each received element. The sink is materialized into a scala.concurrent.Future which will be completed withSuccess
when reaching the normal end of the stream, or completed withFailure
if there is a failure signaled in the stream. - def fromGraph[T, M](g: Graph[SinkShape[T], M]): Sink[T, M]
A graph with the shape of a sink logically is a sink, this method makes it so also in type.
- def fromMaterializer[T, M](factory: (Materializer, Attributes) => Sink[T, M]): Sink[T, Future[M]]
Defers the creation of a Sink until materialization.
Defers the creation of a Sink until materialization. The
factory
function exposes Materializer which is going to be used during materialization and Attributes of the Sink returned by this method. - def fromSubscriber[T](subscriber: Subscriber[T]): Sink[T, NotUsed]
Helper to create Sink from
Subscriber
. - def futureSink[T, M](future: Future[Sink[T, M]]): Sink[T, Future[M]]
Turn a
Future[Sink]
into a Sink that will consume the values of the source when the future completes successfully.Turn a
Future[Sink]
into a Sink that will consume the values of the source when the future completes successfully. If theFuture
is completed with a failure the stream is failed.The materialized future value is completed with the materialized value of the future sink or failed with a NeverMaterializedException if upstream fails or downstream cancels before the future has completed.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def head[T]: Sink[T, Future[T]]
A
Sink
that materializes into aFuture
of the first value received.A
Sink
that materializes into aFuture
of the first value received. If the stream completes before signaling at least a single element, the Future will be failed with a NoSuchElementException. If the stream signals an error errors before signaling at least a single element, the Future will be failed with the streams exception.See also headOption.
- def headOption[T]: Sink[T, Future[Option[T]]]
A
Sink
that materializes into aFuture
of the optional first value received.A
Sink
that materializes into aFuture
of the optional first value received. If the stream completes before signaling at least a single element, the value of the Future will be scala.None. If the stream signals an error errors before signaling at least a single element, the Future will be failed with the streams exception.See also head.
- def ignore: Sink[Any, Future[Done]]
A
Sink
that will consume the stream and discard the elements. - final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def last[T]: Sink[T, Future[T]]
A
Sink
that materializes into aFuture
of the last value received.A
Sink
that materializes into aFuture
of the last value received. If the stream completes before signaling at least a single element, the Future will be failed with a NoSuchElementException. If the stream signals an error, the Future will be failed with the stream's exception.See also lastOption, takeLast.
- def lastOption[T]: Sink[T, Future[Option[T]]]
A
Sink
that materializes into aFuture
of the optional last value received.A
Sink
that materializes into aFuture
of the optional last value received. If the stream completes before signaling at least a single element, the value of the Future will be scala.None. If the stream signals an error, the Future will be failed with the stream's exception. - def lazyFutureSink[T, M](create: () => Future[Sink[T, M]]): Sink[T, Future[M]]
Defers invoking the
create
function to create a future sink until there is a first element passed from upstream.Defers invoking the
create
function to create a future sink until there is a first element passed from upstream.The materialized future value is completed with the materialized value of the created sink when that has successfully been materialized.
If the
create
function throws or returns a future that is failed, or the stream fails to materialize, in this case the materialized future value is failed with a pekko.stream.NeverMaterializedException. - def lazySink[T, M](create: () => Sink[T, M]): Sink[T, Future[M]]
Defers invoking the
create
function to create a sink until there is a first element passed from upstream.Defers invoking the
create
function to create a sink until there is a first element passed from upstream.The materialized future value is completed with the materialized value of the created sink when that has successfully been materialized.
If the
create
function throws or returns or the stream fails to materialize, in this case the materialized future value is failed with a pekko.stream.NeverMaterializedException. - final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def never: Sink[Any, Future[Done]]
A Sink that will always backpressure never cancel and never consume any elements from the stream.
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def onComplete[T](callback: (Try[Done]) => Unit): Sink[T, NotUsed]
A
Sink
that when the flow is completed, either through a failure or normal completion, apply the provided function with scala.util.Success or scala.util.Failure. - def queue[T](): Sink[T, SinkQueueWithCancel[T]]
Creates a
Sink
that is materialized as an pekko.stream.scaladsl.SinkQueueWithCancel.Creates a
Sink
that is materialized as an pekko.stream.scaladsl.SinkQueueWithCancel. pekko.stream.scaladsl.SinkQueueWithCancel.pull method is pulling element from the stream and returns
.Future[Option[T]]
Future
completes when element is available.Before calling pull method second time you need to wait until previous Future completes. Pull returns Failed future with IllegalStateException if previous future has not yet completed.
Sink
will request at most number of elements equal to size ofinputBuffer
from upstream and then stop back pressure. You can configure size of input buffer by using Sink.withAttributes method.For stream completion you need to pull all elements from pekko.stream.scaladsl.SinkQueueWithCancel including last None as completion marker
- def queue[T](maxConcurrentPulls: Int): Sink[T, SinkQueueWithCancel[T]]
Creates a
Sink
that is materialized as an pekko.stream.scaladsl.SinkQueueWithCancel.Creates a
Sink
that is materialized as an pekko.stream.scaladsl.SinkQueueWithCancel. pekko.stream.scaladsl.SinkQueueWithCancel.pull method is pulling element from the stream and returns
.Future[Option[T]
Future
completes when element is available.Before calling pull method second time you need to ensure that number of pending pulls is less then
or wait until some of the previous Futures completes. Pull returns Failed future with IllegalStateException if there will be more thenmaxConcurrentPulls
number of pending pulls.maxConcurrentPulls
Sink
will request at most number of elements equal to size ofinputBuffer
from upstream and then stop back pressure. You can configure size of input buffer by using Sink.withAttributes method.For stream completion you need to pull all elements from pekko.stream.scaladsl.SinkQueueWithCancel including last None as completion marker
- def reduce[T](f: (T, T) => T): Sink[T, Future[T]]
A
Sink
that will invoke the given function for every received element, giving it its previous output (from the second element) and the element as input.A
Sink
that will invoke the given function for every received element, giving it its previous output (from the second element) and the element as input. The returned scala.concurrent.Future will be completed with value of the final function evaluation when the input stream ends, or completed withFailure
if there is a failure signaled in the stream.If the stream is empty (i.e. completes before signalling any elements), the reduce operator will fail its downstream with a NoSuchElementException, which is semantically in-line with that Scala's standard library collections do in such situations.
Adheres to the ActorAttributes.SupervisionStrategy attribute.
- def seq[T]: Sink[T, Future[Seq[T]]]
A
Sink
that keeps on collecting incoming elements until upstream terminates.A
Sink
that keeps on collecting incoming elements until upstream terminates. As upstream may be unbounded,Flow[T].take
or the stricterFlow[T].limit
(and their variants) may be used to ensure boundedness. Materializes into aFuture
ofSeq[T]
containing all the collected elements.Seq
is limited toInt.MaxValue
elements, this Sink will cancel the stream after having received that many elements.See also Flow.limit, Flow.limitWeighted, Flow.take, Flow.takeWithin, Flow.takeWhile
- def shape[T](name: String): SinkShape[T]
INTERNAL API
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def takeLast[T](n: Int): Sink[T, Future[Seq[T]]]
A
Sink
that materializes into aFuture
ofimmutable.Seq[T]
containing the lastn
collected elements.A
Sink
that materializes into aFuture
ofimmutable.Seq[T]
containing the lastn
collected elements.If the stream completes before signaling at least n elements, the
Future
will complete with all elements seen so far. If the stream never completes, theFuture
will never complete. If there is a failure signaled in the stream theFuture
will be completed with failure. - def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def actorRef[T](ref: ActorRef, onCompleteMessage: Any): Sink[T, NotUsed]
Sends the elements of the stream to the given
ActorRef
.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 givenonCompleteMessage
will be sent to the destination actor. When the stream is completed with failure a pekko.actor.Status.Failure message will be 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 zeromailbox-push-timeout-time
or use a rate limiting operator in front of thisSink
.- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.6.0) Use variant accepting both on complete and on failure message
- def actorRefWithAck[T](ref: ActorRef, onInitMessage: Any, ackMessage: Any, onCompleteMessage: Any, onFailureMessage: (Throwable) => Any = Status.Failure.apply): Sink[T, NotUsed]
Sends the elements of the stream to the given
ActorRef
that sends back back-pressure signal.Sends the elements of the stream to the given
ActorRef
that sends back back-pressure signal. First element is alwaysonInitMessage
, then stream is waiting for acknowledgement messageackMessage
from the given actor which means that it is ready to process elements. It also requiresackMessage
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 ofonFailureMessage(throwable)
function will be sent to the destination actor.- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.6.0) Use actorRefWithBackpressure accepting completion and failure matchers instead
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def foreachParallel[T](parallelism: Int)(f: (T) => Unit)(implicit ec: ExecutionContext): Sink[T, Future[Done]]
A
Sink
that will invoke the given function to each of the elements as they pass in.A
Sink
that will invoke the given function to each of the elements as they pass in. The sink is materialized into a scala.concurrent.FutureIf
f
throws an exception and the supervision decision is pekko.stream.Supervision.Stop theFuture
will be completed with failure.If
f
throws an exception and the supervision decision is pekko.stream.Supervision.Resume or pekko.stream.Supervision.Restart the element is dropped and the stream continues.See also Flow.mapAsyncUnordered
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.5.17) Use
foreachAsync
instead, it allows you to choose how to run the procedure, by calling some other API returning a Future or spawning a new Future.
- def lazyInit[T, M](sinkFactory: (T) => Future[Sink[T, M]], fallback: () => M): Sink[T, Future[M]]
Creates a real
Sink
upon receiving the first element.Creates a real
Sink
upon receiving the first element. InternalSink
will not be created if there are no elements, because of completion or error.If upstream completes before an element was received then the
Future
is completed with the value created by fallback. If upstream fails before an element was received,sinkFactory
throws an exception, or materialization of the internal sink fails then theFuture
is completed with the exception. Otherwise theFuture
is completed with the materialized value of the internal sink.- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.6.0) Use 'Sink.lazyFutureSink' in combination with 'Flow.prefixAndTail(1)' instead
- def lazyInitAsync[T, M](sinkFactory: () => Future[Sink[T, M]]): Sink[T, Future[Option[M]]]
Creates a real
Sink
upon receiving the first element.Creates a real
Sink
upon receiving the first element. InternalSink
will not be created if there are no elements, because of completion or error.If upstream completes before an element was received then the
Future
is completed withNone
. If upstream fails before an element was received,sinkFactory
throws an exception, or materialization of the internal sink fails then theFuture
is completed with the exception. Otherwise theFuture
is completed with the materialized value of the internal sink.- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.6.0) Use 'Sink.lazyFutureSink' instead
- def setup[T, M](factory: (ActorMaterializer, Attributes) => Sink[T, M]): Sink[T, Future[M]]
Defers the creation of a Sink until materialization.
Defers the creation of a Sink until materialization. The
factory
function exposes ActorMaterializer which is going to be used during materialization and Attributes of the Sink returned by this method.- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.6.0) Use 'fromMaterializer' instead