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
- Alphabetic
- By Inheritance
- AbstractInOutHandler
- OutHandler
- InHandler
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new AbstractInOutHandler()
Abstract Value Members
- 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])
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- 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
- 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()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- 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
- 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
- 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
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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])
- 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])
- 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])
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- 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 finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
- Deprecated
- 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
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- 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() @deprecated
- Deprecated
(Since version 2.6.0) Call onDownstreamFinish with a cancellation cause.
- 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.