final case class ProcessorModule[In, Out, Mat](createProcessor: () ⇒ (Processor[In, Out], Mat), attributes: Attributes = DefaultAttributes.processor) extends AtomicModule with Product with Serializable
- Alphabetic
- By Inheritance
- ProcessorModule
- Serializable
- Serializable
- Product
- Equals
- AtomicModule
- Module
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new ProcessorModule(createProcessor: () ⇒ (Processor[In, Out], Mat), attributes: Attributes = DefaultAttributes.processor)
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 ProcessorModule[In, Out, Mat] to any2stringadd[ProcessorModule[In, Out, Mat]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (ProcessorModule[In, Out, Mat], B)
- Implicit
- This member is added by an implicit conversion from ProcessorModule[In, Out, Mat] to ArrowAssoc[ProcessorModule[In, Out, Mat]] 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
-
val
attributes: Attributes
- Definition Classes
- ProcessorModule → Module
-
def
carbonCopy: Module
The purpose of this method is to create a copy to be included in a larger graph such that port identity clashes are avoided.
The purpose of this method is to create a copy to be included in a larger graph such that port identity clashes are avoided. Where a full copy is not possible or desirable, use a CopiedModule. The shape of the resulting module MUST NOT contain the same ports as this module’s shape.
- Definition Classes
- ProcessorModule → Module
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
compose[A, B, C](that: Module, f: (A, B) ⇒ C): Module
Creates a new Module which is
this
Module composed withthat
Module, using the given functionf
to compose the materialized value ofthis
with the materialized value ofthat
.Creates a new Module which is
this
Module composed withthat
Module, using the given functionf
to compose the materialized value ofthis
with the materialized value ofthat
.- A
the type of the materialized value of
this
- B
the type of the materialized value of
that
- C
the type of the materialized value of the returned Module
- that
a Module to be composed with (cannot be itself)
- f
a function which combines the materialized values
- returns
a Module that represents the composition of
this
andthat
- Definition Classes
- Module
-
def
compose(that: Module): Module
Creates a new Module which is
this
Module composed withthat
Module.Creates a new Module which is
this
Module composed withthat
Module.- that
a Module to be composed with (cannot be itself)
- returns
a Module that represents the composition of
this
andthat
- Definition Classes
- Module
-
def
composeNoMat(that: Module): Module
Creates a new Module which is
this
Module composed withthat
Module.Creates a new Module which is
this
Module composed withthat
Module.The difference to compose(that) is that this version completely ignores the materialized value computation of
that
while the normal version executes the computation and discards its result. This means that this version must not be used for user-providedthat
modules because users may transform materialized values only to achieve some side-effect; it can only be used where we know that there is no meaningful computation to be done (like for MaterializedValueSource).- that
a Module to be composed with (cannot be itself)
- returns
a Module that represents the composition of
this
andthat
- Definition Classes
- Module
- val createProcessor: () ⇒ (Processor[In, Out], Mat)
-
final
def
downstreams: Map[OutPort, InPort]
- Definition Classes
- AtomicModule → Module
-
def
ensuring(cond: (ProcessorModule[In, Out, Mat]) ⇒ Boolean, msg: ⇒ Any): ProcessorModule[In, Out, Mat]
- Implicit
- This member is added by an implicit conversion from ProcessorModule[In, Out, Mat] to Ensuring[ProcessorModule[In, Out, Mat]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (ProcessorModule[In, Out, Mat]) ⇒ Boolean): ProcessorModule[In, Out, Mat]
- Implicit
- This member is added by an implicit conversion from ProcessorModule[In, Out, Mat] to Ensuring[ProcessorModule[In, Out, Mat]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): ProcessorModule[In, Out, Mat]
- Implicit
- This member is added by an implicit conversion from ProcessorModule[In, Out, Mat] to Ensuring[ProcessorModule[In, Out, Mat]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): ProcessorModule[In, Out, Mat]
- Implicit
- This member is added by an implicit conversion from ProcessorModule[In, Out, Mat] to Ensuring[ProcessorModule[In, Out, Mat]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
equals(obj: Any): Boolean
- Definition Classes
- Module → AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from ProcessorModule[In, Out, Mat] to StringFormat[ProcessorModule[In, Out, Mat]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
fuse[A, B, C](that: Module, from: OutPort, to: InPort, f: (A, B) ⇒ C): Module
Fuses this Module to
that
Module by wiring togetherfrom
andto
, transforming the materialized values ofthis
andthat
using the provided functionf
Fuses this Module to
that
Module by wiring togetherfrom
andto
, transforming the materialized values ofthis
andthat
using the provided functionf
- that
a Module to fuse with
- from
the data source to wire
- to
the data sink to wire
- f
the function to apply to the materialized values
- returns
a Module representing the fusion of
this
andthat
- Definition Classes
- Module
-
final
def
fuse(that: Module, from: OutPort, to: InPort): Module
Fuses this Module to
that
Module by wiring togetherfrom
andto
, retaining the materialized value ofthis
in the resultFuses this Module to
that
Module by wiring togetherfrom
andto
, retaining the materialized value ofthis
in the result- that
a Module to fuse with
- from
the data source to wire
- to
the data sink to wire
- returns
a Module representing the fusion of
this
andthat
- Definition Classes
- Module
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
final
def
hashCode(): Int
- Definition Classes
- Module → AnyRef → Any
- val inPort: Inlet[In]
-
final
lazy val
inPorts: Set[InPort]
- Definition Classes
- Module
-
def
isAtomic: Boolean
- Definition Classes
- Module
-
final
def
isBidiFlow: Boolean
- Definition Classes
- Module
-
def
isCopied: Boolean
- Definition Classes
- Module
-
final
def
isFlow: Boolean
- Definition Classes
- Module
-
def
isFused: Boolean
- Definition Classes
- Module
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isRunnable: Boolean
- Definition Classes
- Module
-
final
def
isSealed: Boolean
- Definition Classes
- Module
-
final
def
isSink: Boolean
- Definition Classes
- Module
-
final
def
isSource: Boolean
- Definition Classes
- Module
-
def
materializedValueComputation: MaterializedValueNode
- Definition Classes
- Module
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- val outPort: Outlet[Out]
-
final
lazy val
outPorts: Set[OutPort]
- Definition Classes
- Module
-
def
replaceShape(s: Shape): Module
Verify that the given Shape has the same ports and return a new module with that shape.
Verify that the given Shape has the same ports and return a new module with that shape. Concrete implementations may throw UnsupportedOperationException where applicable.
Please note that this method MUST NOT be implemented using a CopiedModule since the purpose of replaceShape can also be to rearrange the ports (as in BidiFlow.reversed) and that purpose would be defeated.
- Definition Classes
- ProcessorModule → Module
-
val
shape: FlowShape[In, Out]
- Definition Classes
- ProcessorModule → Module
-
final
def
subModules: Set[Module]
- Definition Classes
- AtomicModule → Module
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- ProcessorModule → AnyRef → Any
-
final
def
transformMaterializedValue(f: (Any) ⇒ Any): Module
- Definition Classes
- Module
-
final
def
upstreams: Map[InPort, OutPort]
- Definition Classes
- AtomicModule → Module
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wire(from: OutPort, to: InPort): Module
Creates a new Module based on the current Module but with the given OutPort wired to the given InPort.
Creates a new Module based on the current Module but with the given OutPort wired to the given InPort.
- from
the OutPort to wire
- to
the InPort to wire
- returns
a new Module with the ports wired
- Definition Classes
- Module
-
def
withAttributes(attributes: Attributes): ProcessorModule[In, Out, Mat]
- Definition Classes
- ProcessorModule → Module
-
def
→[B](y: B): (ProcessorModule[In, Out, Mat], B)
- Implicit
- This member is added by an implicit conversion from ProcessorModule[In, Out, Mat] to ArrowAssoc[ProcessorModule[In, Out, Mat]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc