Class

akka.stream.stage.GraphStageLogic

SubSourceOutlet

Related Doc: package GraphStageLogic

Permalink

class SubSourceOutlet[T] extends AnyRef

INTERNAL API

This 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). Care needs to be taken to complete this Outlet when the operator shuts down lest the corresponding Sink be left hanging. It is good practice to use the timeout method to cancel this Outlet in case the corresponding Source is not materialized within a given time limit, see e.g. ActorMaterializerSettings.

Source
GraphStage.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SubSourceOutlet
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SubSourceOutlet(name: String)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from SubSourceOutlet[T] to any2stringadd[SubSourceOutlet[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (SubSourceOutlet[T], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from SubSourceOutlet[T] to ArrowAssoc[SubSourceOutlet[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def complete(): Unit

    Permalink

    Complete this output port.

  9. def ensuring(cond: (SubSourceOutlet[T]) ⇒ Boolean, msg: ⇒ Any): SubSourceOutlet[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from SubSourceOutlet[T] to Ensuring[SubSourceOutlet[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: (SubSourceOutlet[T]) ⇒ Boolean): SubSourceOutlet[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from SubSourceOutlet[T] to Ensuring[SubSourceOutlet[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean, msg: ⇒ Any): SubSourceOutlet[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from SubSourceOutlet[T] to Ensuring[SubSourceOutlet[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: Boolean): SubSourceOutlet[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from SubSourceOutlet[T] to Ensuring[SubSourceOutlet[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  15. def fail(ex: Throwable): Unit

    Permalink

    Fail this output port.

  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  17. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from SubSourceOutlet[T] to StringFormat[SubSourceOutlet[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  18. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  19. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  20. def isAvailable: Boolean

    Permalink

    Returns true if this output port can be pushed.

  21. def isClosed: Boolean

    Permalink

    Returns true if this output port is closed, but caution THIS WORKS DIFFERENTLY THAN THE NORMAL isClosed(out).

    Returns true if this output port is closed, but caution THIS WORKS DIFFERENTLY THAN THE NORMAL isClosed(out). Due to possibly asynchronous shutdown it may not return true immediately after complete() or fail() have returned.

  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  23. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  24. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  25. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  26. def push(elem: T): Unit

    Permalink

    Push to this output port.

  27. def setHandler(handler: OutHandler): Unit

    Permalink

    Set OutHandler for this dynamic output port; this needs to be done before the first substream callback can arrive.

  28. def source: Graph[SourceShape[T], NotUsed]

    Permalink

    Get the Source for this dynamic output port.

  29. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  30. def timeout(d: FiniteDuration): Unit

    Permalink

    Set the source into timed-out mode if it has not yet been materialized.

  31. def toString(): String

    Permalink
    Definition Classes
    SubSourceOutlet → AnyRef → Any

  32. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  33. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  34. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  35. def →[B](y: B): (SubSourceOutlet[T], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from SubSourceOutlet[T] to ArrowAssoc[SubSourceOutlet[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from SubSourceOutlet[T] to any2stringadd[SubSourceOutlet[T]]

Inherited by implicit conversion StringFormat from SubSourceOutlet[T] to StringFormat[SubSourceOutlet[T]]

Inherited by implicit conversion Ensuring from SubSourceOutlet[T] to Ensuring[SubSourceOutlet[T]]

Inherited by implicit conversion ArrowAssoc from SubSourceOutlet[T] to ArrowAssoc[SubSourceOutlet[T]]

Ungrouped