Class

io.dylemma.spac.handlers

ParallelTransformerHandler

Related Doc: package handlers

Permalink

class ParallelTransformerHandler[In, A, Out] extends Handler[In, Out]

A handler for a collection of transformers that will be run in parallel. Each event passed through this handler will be forwarded to each of the respective handlers for the transformers in toMerge, referred to as "members". If at any point a member finishes, it will no longer receive inputs. If at any point *all* of the members finish, an early end will be passed to the downstream handler. If at any point the downstream handler emits a result, that result will be returned and the members will be deactivated.

In

The input type

A

The common output type of the transformers, and the input type for the downstream handler.

Out

The output type

Source
ParallelTransformerHandler.scala
Linear Supertypes
Handler[In, Out], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ParallelTransformerHandler
  2. Handler
  3. AnyRef
  4. 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 ParallelTransformerHandler(downstream: Handler[A, Out], toMerge: List[Transformer[In, A]])

    Permalink

    downstream

    The receiving handler for the members

    toMerge

    A list of transformers which will be run in parllel, passing outputs to the downstream handler

Type Members

  1. type Member = Handler[In, WrappedResult]

    Permalink
    Attributes
    protected
  2. type WrappedResult = Either[Out, IgnoredEnd.type]

    Permalink
    Attributes
    protected

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 ParallelTransformerHandler[In, A, Out] to any2stringadd[ParallelTransformerHandler[In, A, Out]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ParallelTransformerHandler[In, A, Out], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ParallelTransformerHandler[In, A, Out] to ArrowAssoc[ParallelTransformerHandler[In, A, Out]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. object IgnoredEnd

    Permalink
    Attributes
    protected
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. val endGuardWrapper: Handler[A, WrappedResult] { ... /* 3 definitions in type refinement */ }

    Permalink

    A guard around the downstream handler to prevent the toMerge transformers from directly calling handleEnd on the downstream handler.

    A guard around the downstream handler to prevent the toMerge transformers from directly calling handleEnd on the downstream handler. Transformers like Take(N) - that will feed an End event to the downstream when they've encountered an "early end" scenario - would potentially cause an early end even if other transformers in the merge were still ready to continue.

    Attributes
    protected
  10. def ensuring(cond: (ParallelTransformerHandler[In, A, Out]) ⇒ Boolean, msg: ⇒ Any): ParallelTransformerHandler[In, A, Out]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ParallelTransformerHandler[In, A, Out] to Ensuring[ParallelTransformerHandler[In, A, Out]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (ParallelTransformerHandler[In, A, Out]) ⇒ Boolean): ParallelTransformerHandler[In, A, Out]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ParallelTransformerHandler[In, A, Out] to Ensuring[ParallelTransformerHandler[In, A, Out]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): ParallelTransformerHandler[In, A, Out]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ParallelTransformerHandler[In, A, Out] to Ensuring[ParallelTransformerHandler[In, A, Out]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): ParallelTransformerHandler[In, A, Out]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ParallelTransformerHandler[In, A, Out] to Ensuring[ParallelTransformerHandler[In, A, Out]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  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 ParallelTransformerHandler[In, A, Out] to StringFormat[ParallelTransformerHandler[In, A, Out]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  19. def handleEnd(): Out

    Permalink

    Causes this handler to finalize and produce a result.

    Causes this handler to finalize and produce a result.

    This method should not be called if isFinished is already true.

    returns

    The final output of this parser

    Definition Classes
    ParallelTransformerHandlerHandler
  20. def handleError(error: Throwable): Option[Out]

    Permalink

    Causes this handler to process an error.

    Causes this handler to process an error.

    This method should not be called if isFinished == true

    error

    an error to be processed

    returns

    An option containing the final output if this handler became finished as a result of processing the error, or None if the handler is ready for more input.

    Definition Classes
    ParallelTransformerHandlerHandler
  21. def handleInput(input: In): Option[Out]

    Permalink

    Causes this handler to process an input element.

    Causes this handler to process an input element.

    This method should not be called if isFinished == true

    input

    an element to be processed

    returns

    An option containing the final output if this handler became finished as a result of processing the input, or None if the handler is ready for more input.

    Definition Classes
    ParallelTransformerHandlerHandler
  22. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  23. def isFinished: Boolean

    Permalink

    Tells if this handler is finished.

    Tells if this handler is finished.

    If a handler is finished, its handleX methods should no longer be called. Doing so after the handler finishes will cause undefined behavior. Typically a handler should be discarded once it is finished.

    returns

    whether this handler is finished

    Definition Classes
    ParallelTransformerHandlerHandler
  24. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  25. val members: List[Member]

    Permalink

    Every one of the transformers in toMerge needs to output to the same downstream handler.

    Every one of the transformers in toMerge needs to output to the same downstream handler.

    Attributes
    protected
  26. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  27. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  28. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  29. def runMembers(f: (Member) ⇒ Option[WrappedResult]): Option[Out]

    Permalink
    Attributes
    protected
  30. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  31. def toString(): String

    Permalink
    Definition Classes
    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): (ParallelTransformerHandler[In, A, Out], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ParallelTransformerHandler[In, A, Out] to ArrowAssoc[ParallelTransformerHandler[In, A, Out]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Handler[In, Out]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ParallelTransformerHandler[In, A, Out] to any2stringadd[ParallelTransformerHandler[In, A, Out]]

Inherited by implicit conversion StringFormat from ParallelTransformerHandler[In, A, Out] to StringFormat[ParallelTransformerHandler[In, A, Out]]

Inherited by implicit conversion Ensuring from ParallelTransformerHandler[In, A, Out] to Ensuring[ParallelTransformerHandler[In, A, Out]]

Inherited by implicit conversion ArrowAssoc from ParallelTransformerHandler[In, A, Out] to ArrowAssoc[ParallelTransformerHandler[In, A, Out]]

Ungrouped