Package akka.stream.stage
Class GraphStageLogic.SubSourceOutlet<T>
- java.lang.Object
-
- akka.stream.stage.GraphStageLogic.SubSourceOutlet<T>
-
- Enclosing class:
- GraphStageLogic
public class GraphStageLogic.SubSourceOutlet<T> extends java.lang.ObjectINTERNAL APIThis allows the dynamic creation of an Outlet for a GraphStage which is connected to a Source that is available for materialization (e.g. using the
subFusingMaterializer). Completion, cancellation and failure of the parent operator is automatically delegated to instances ofSubSourceOutletto avoid resource leaks.Even so it is good practice to use the
timeoutmethod to cancel this Outlet in case the corresponding Source is not materialized within a given time limit, see e.g. ActorMaterializerSettings.To be thread safe this method must only be called from either the constructor of the graph operator during materialization or one of the methods invoked by the graph operator machinery, such as
onPushandonPull.
-
-
Constructor Summary
Constructors Constructor Description SubSourceOutlet(java.lang.String name)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcomplete()Complete this output port.voidfail(java.lang.Throwable ex)Fail this output port.booleanisAvailable()Returnstrueif this output port can be pushed.booleanisClosed()Returnstrueif this output port is closed, but caution THIS WORKS DIFFERENTLY THAN THE NORMAL isClosed(out).voidpush(T elem)Push to this output port.voidsetHandler(OutHandler handler)Set OutHandler for this dynamic output port; this needs to be done before the first substream callback can arrive.Graph<SourceShape<T>,NotUsed>source()Get the Source for this dynamic output port.voidtimeout(scala.concurrent.duration.FiniteDuration d)Set the source into timed-out mode if it has not yet been materialized.java.lang.StringtoString()
-
-
-
Method Detail
-
complete
public void complete()
Complete this output port.
-
fail
public void fail(java.lang.Throwable ex)
Fail this output port.
-
isAvailable
public boolean isAvailable()
Returnstrueif this output port can be pushed.
-
isClosed
public boolean isClosed()
Returnstrueif this output port is closed, but caution THIS WORKS DIFFERENTLY THAN THE NORMAL isClosed(out). Due to possibly asynchronous shutdown it may not returntrueimmediately aftercomplete()orfail()have returned.
-
push
public void push(T elem)
Push to this output port.
-
setHandler
public void setHandler(OutHandler handler)
Set OutHandler for this dynamic output port; this needs to be done before the first substream callback can arrive.
-
source
public Graph<SourceShape<T>,NotUsed> source()
Get the Source for this dynamic output port.
-
timeout
public void timeout(scala.concurrent.duration.FiniteDuration d)
Set the source into timed-out mode if it has not yet been materialized.
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
-