c

akka.stream.impl

CancelSink

final class CancelSink extends SinkModule[Any, NotUsed]

INTERNAL API A sink that immediately cancels its upstream upon materialization.

Source
Sinks.scala
Linear Supertypes
SinkModule[Any, NotUsed], AtomicModule, Module, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CancelSink
  2. SinkModule
  3. AtomicModule
  4. Module
  5. AnyRef
  6. 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 CancelSink(attributes: Attributes, shape: SinkShape[Any])

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 CancelSink to any2stringadd[CancelSink] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (CancelSink, B)
    Implicit
    This member is added by an implicit conversion from CancelSink to ArrowAssoc[CancelSink] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def amendShape(attr: Attributes): SinkShape[Any]
    Attributes
    protected
    Definition Classes
    SinkModule
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. val attributes: Attributes
    Definition Classes
    CancelSink → Module
  9. def carbonCopy: AtomicModule

    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
    SinkModule → Module
  10. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def compose[A, B, C](that: Module, f: (A, B) ⇒ C): Module

    Creates a new Module which is this Module composed with that Module, using the given function f to compose the materialized value of this with the materialized value of that.

    Creates a new Module which is this Module composed with that Module, using the given function f to compose the materialized value of this with the materialized value of that.

    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 and that

    Definition Classes
    Module
  12. def compose(that: Module): Module

    Creates a new Module which is this Module composed with that Module.

    Creates a new Module which is this Module composed with that Module.

    that

    a Module to be composed with (cannot be itself)

    returns

    a Module that represents the composition of this and that

    Definition Classes
    Module
  13. def composeNoMat(that: Module): Module

    Creates a new Module which is this Module composed with that Module.

    Creates a new Module which is this Module composed with that 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-provided that 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 and that

    Definition Classes
    Module
  14. def create(context: MaterializationContext): (Subscriber[Any], NotUsed)

    Create the Subscriber or VirtualPublisher that consumes the incoming stream, plus the materialized value.

    Create the Subscriber or VirtualPublisher that consumes the incoming stream, plus the materialized value. Since Subscriber and VirtualPublisher do not share a common supertype apart from AnyRef this is what the type union devolves into; unfortunately we do not have union types at our disposal at this point.

    Definition Classes
    CancelSink → SinkModule
  15. final def downstreams: Map[OutPort, InPort]
    Definition Classes
    AtomicModule → Module
  16. def ensuring(cond: (CancelSink) ⇒ Boolean, msg: ⇒ Any): CancelSink
    Implicit
    This member is added by an implicit conversion from CancelSink to Ensuring[CancelSink] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: (CancelSink) ⇒ Boolean): CancelSink
    Implicit
    This member is added by an implicit conversion from CancelSink to Ensuring[CancelSink] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean, msg: ⇒ Any): CancelSink
    Implicit
    This member is added by an implicit conversion from CancelSink to Ensuring[CancelSink] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: Boolean): CancelSink
    Implicit
    This member is added by an implicit conversion from CancelSink to Ensuring[CancelSink] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def equals(obj: Any): Boolean
    Definition Classes
    Module → AnyRef → Any
  22. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from CancelSink to StringFormat[CancelSink] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  24. 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 together from and to, transforming the materialized values of this and that using the provided function f

    Fuses this Module to that Module by wiring together from and to, transforming the materialized values of this and that using the provided function f

    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 and that

    Definition Classes
    Module
  25. final def fuse(that: Module, from: OutPort, to: InPort): Module

    Fuses this Module to that Module by wiring together from and to, retaining the materialized value of this in the result

    Fuses this Module to that Module by wiring together from and to, retaining the materialized value of this 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 and that

    Definition Classes
    Module
  26. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  27. final def hashCode(): Int
    Definition Classes
    Module → AnyRef → Any
  28. final lazy val inPorts: Set[InPort]
    Definition Classes
    Module
  29. def isAtomic: Boolean
    Definition Classes
    Module
  30. final def isBidiFlow: Boolean
    Definition Classes
    Module
  31. def isCopied: Boolean
    Definition Classes
    Module
  32. final def isFlow: Boolean
    Definition Classes
    Module
  33. def isFused: Boolean
    Definition Classes
    Module
  34. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  35. def isRunnable: Boolean
    Definition Classes
    Module
  36. final def isSealed: Boolean
    Definition Classes
    Module
  37. final def isSink: Boolean
    Definition Classes
    Module
  38. final def isSource: Boolean
    Definition Classes
    Module
  39. def label: String
    Attributes
    protected
    Definition Classes
    SinkModule
  40. def materializedValueComputation: MaterializedValueNode
    Definition Classes
    Module
  41. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  42. def newInstance(shape: SinkShape[Any]): SinkModule[Any, NotUsed]
    Attributes
    protected
    Definition Classes
    CancelSink → SinkModule
  43. final def notify(): Unit
    Definition Classes
    AnyRef
  44. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  45. final lazy val outPorts: Set[OutPort]
    Definition Classes
    Module
  46. def replaceShape(s: Shape): AtomicModule

    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
    SinkModule → Module
  47. val shape: SinkShape[Any]
    Definition Classes
    SinkModule → Module
  48. final def subModules: Set[Module]
    Definition Classes
    AtomicModule → Module
  49. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  50. final def toString(): String
    Definition Classes
    SinkModule → AnyRef → Any
  51. final def transformMaterializedValue(f: (Any) ⇒ Any): Module
    Definition Classes
    Module
  52. final def upstreams: Map[InPort, OutPort]
    Definition Classes
    AtomicModule → Module
  53. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  54. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  55. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  56. 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
  57. def withAttributes(attr: Attributes): AtomicModule
    Definition Classes
    CancelSink → Module
  58. def →[B](y: B): (CancelSink, B)
    Implicit
    This member is added by an implicit conversion from CancelSink to ArrowAssoc[CancelSink] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from SinkModule[Any, NotUsed]

Inherited from AtomicModule

Inherited from Module

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from CancelSink to any2stringadd[CancelSink]

Inherited by implicit conversion StringFormat from CancelSink to StringFormat[CancelSink]

Inherited by implicit conversion Ensuring from CancelSink to Ensuring[CancelSink]

Inherited by implicit conversion ArrowAssoc from CancelSink to ArrowAssoc[CancelSink]

Ungrouped