c

akka.stream.stage

AbstractInOutHandler

abstract class AbstractInOutHandler extends InHandler with OutHandler

Java API: callback combination for output and input ports where termination logic is predefined (completing when upstream completes, failing when upstream fails, completing when downstream cancels).

Source
GraphStage.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AbstractInOutHandler
  2. OutHandler
  3. InHandler
  4. AnyRef
  5. 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 AbstractInOutHandler()

Abstract Value Members

  1. abstract def onPull(): Unit

    Called when the output port has received a pull, and therefore ready to emit an element, i.e.

    Called when the output port has received a pull, and therefore ready to emit an element, i.e. GraphStageLogic.push is now allowed to be called on this port.

    Definition Classes
    OutHandler
    Annotations
    @throws(classOf[Exception])
  2. abstract def onPush(): Unit

    Called when the input port has a new element available.

    Called when the input port has a new element available. The actual element can be retrieved via the GraphStageLogic.grab method.

    Definition Classes
    InHandler
    Annotations
    @throws(classOf[Exception])

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from AbstractInOutHandler toany2stringadd[AbstractInOutHandler] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (AbstractInOutHandler, B)
    Implicit
    This member is added by an implicit conversion from AbstractInOutHandler toArrowAssoc[AbstractInOutHandler] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (AbstractInOutHandler) => Boolean, msg: => Any): AbstractInOutHandler
    Implicit
    This member is added by an implicit conversion from AbstractInOutHandler toEnsuring[AbstractInOutHandler] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (AbstractInOutHandler) => Boolean): AbstractInOutHandler
    Implicit
    This member is added by an implicit conversion from AbstractInOutHandler toEnsuring[AbstractInOutHandler] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): AbstractInOutHandler
    Implicit
    This member is added by an implicit conversion from AbstractInOutHandler toEnsuring[AbstractInOutHandler] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): AbstractInOutHandler
    Implicit
    This member is added by an implicit conversion from AbstractInOutHandler toEnsuring[AbstractInOutHandler] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from AbstractInOutHandler toStringFormat[AbstractInOutHandler] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def onDownstreamFinish(cause: Throwable): Unit

    Called when the output port will no longer accept any new elements.

    Called when the output port will no longer accept any new elements. After this callback no other callbacks will be called for this port.

    Definition Classes
    OutHandler
    Annotations
    @throws(classOf[Exception])
  22. def onUpstreamFailure(ex: Throwable): Unit

    Called when the input port has failed.

    Called when the input port has failed. After this callback no other callbacks will be called for this port.

    Definition Classes
    InHandler
    Annotations
    @throws(classOf[Exception])
  23. def onUpstreamFinish(): Unit

    Called when the input port is finished.

    Called when the input port is finished. After this callback no other callbacks will be called for this port.

    Definition Classes
    InHandler
    Annotations
    @throws(classOf[Exception])
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  2. def onDownstreamFinish(): Unit

    Called when the output port will no longer accept any new elements.

    Called when the output port will no longer accept any new elements. After this callback no other callbacks will be called for this port.

    Definition Classes
    OutHandler
    Annotations
    @throws(classOf[Exception]) @deprecatedOverriding("Override `def onDownstreamFinish(cause: Throwable)`, instead.", "2.6.0") @deprecated
    Deprecated

    (Since version 2.6.0) Call onDownstreamFinish with a cancellation cause.

  3. def [B](y: B): (AbstractInOutHandler, B)
    Implicit
    This member is added by an implicit conversion from AbstractInOutHandler toArrowAssoc[AbstractInOutHandler] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from OutHandler

Inherited from InHandler

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromAbstractInOutHandler to any2stringadd[AbstractInOutHandler]

Inherited by implicit conversion StringFormat fromAbstractInOutHandler to StringFormat[AbstractInOutHandler]

Inherited by implicit conversion Ensuring fromAbstractInOutHandler to Ensuring[AbstractInOutHandler]

Inherited by implicit conversion ArrowAssoc fromAbstractInOutHandler to ArrowAssoc[AbstractInOutHandler]

Ungrouped