io.dylemma.spac.handlers

ParallelTransformerHandler

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 any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ParallelTransformerHandler(downstream: Handler[A, Out], toMerge: List[Transformer[In, A]])

    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]

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

    Attributes
    protected

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from ParallelTransformerHandler[In, A, Out] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (ParallelTransformerHandler[In, A, Out], B)

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

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. object IgnoredEnd

    Attributes
    protected
  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. def clone(): AnyRef

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

    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
  12. def ensuring(cond: (ParallelTransformerHandler[In, A, Out]) ⇒ Boolean, msg: ⇒ Any): ParallelTransformerHandler[In, A, Out]

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

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

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

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

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

    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from ParallelTransformerHandler[In, A, Out] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  20. final def getClass(): Class[_]

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

    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
  22. def handleError(error: Throwable): Option[Out]

    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
  23. def handleInput(input: In): Option[Out]

    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
  24. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  25. def isFinished: Boolean

    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
  26. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  27. val members: List[Member]

    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
  28. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  29. final def notify(): Unit

    Definition Classes
    AnyRef
  30. final def notifyAll(): Unit

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

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

    Definition Classes
    AnyRef
  33. def toString(): String

    Definition Classes
    AnyRef → Any
  34. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. def [B](y: B): (ParallelTransformerHandler[In, A, Out], B)

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

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from ParallelTransformerHandler[In, A, Out] to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (parallelTransformerHandler: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from ParallelTransformerHandler[In, A, Out] to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (parallelTransformerHandler: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: ParallelTransformerHandler[In, A, Out]

    Implicit information
    This member is added by an implicit conversion from ParallelTransformerHandler[In, A, Out] to ArrowAssoc[ParallelTransformerHandler[In, A, Out]] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (parallelTransformerHandler: ArrowAssoc[ParallelTransformerHandler[In, A, Out]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: ParallelTransformerHandler[In, A, Out]

    Implicit information
    This member is added by an implicit conversion from ParallelTransformerHandler[In, A, Out] to Ensuring[ParallelTransformerHandler[In, A, Out]] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (parallelTransformerHandler: Ensuring[ParallelTransformerHandler[In, A, Out]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Handler[In, Out]

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped