Packages

trait SinkRef[In] extends AnyRef

A SinkRef allows sharing a "reference" to a Sink with others, with the main purpose of crossing a network boundary. Usually obtaining a SinkRef would be done via Actor messaging, in which one system asks a remote one, to accept some data from it, and the remote one decides to accept the request to send data in a back-pressured streaming fashion -- using a sink ref.

To create a SinkRef you have to materialize the Sink that you want to obtain a reference to by attaching it to a StreamRefs.sinkRef().

Stream refs can be seen as Reactive Streams over network boundaries. See also akka.stream.SourceRef which is the dual of a SinkRef.

For additional configuration see reference.conf as well as akka.stream.StreamRefAttributes.

Source
StreamRefs.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SinkRef
  2. AnyRef
  3. Any
Implicitly
  1. by convertRefToSink
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def sink(): Sink[In, NotUsed]

    Scala API: Get Sink underlying to this source ref.

Concrete 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 SinkRef[In] to any2stringadd[SinkRef[In]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (SinkRef[In], B)
    Implicit
    This member is added by an implicit conversion from SinkRef[In] to ArrowAssoc[SinkRef[In]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def addAttributes(attr: Attributes): Sink[In, NotUsed]

    Add the given attributes to this Sink.

    Add the given attributes to this Sink. If the specific attribute was already present on this graph this means the added attribute will be more specific than the existing one. If this Sink is a composite of multiple graphs, new attributes on the composite will be less specific than attributes set directly on the individual graphs of the composite.

    Implicit
    This member is added by an implicit conversion from SinkRef[In] to Sink[In, NotUsed] performed by method convertRefToSink in akka.stream.SinkRef.
    Definition Classes
    SinkGraph
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def asJava[JIn <: In]: Sink[JIn, NotUsed]

    Converts this Scala DSL element to it's Java DSL counterpart.

    Converts this Scala DSL element to it's Java DSL counterpart.

    Implicit
    This member is added by an implicit conversion from SinkRef[In] to Sink[In, NotUsed] performed by method convertRefToSink in akka.stream.SinkRef.
    Definition Classes
    Sink
  9. def async(dispatcher: String, inputBufferSize: Int): Sink[In, NotUsed]

    Put an asynchronous boundary around this Graph

    Put an asynchronous boundary around this Graph

    dispatcher

    Run the graph on this dispatcher

    inputBufferSize

    Set the input buffer to this size for the graph

    Implicit
    This member is added by an implicit conversion from SinkRef[In] to Sink[In, NotUsed] performed by method convertRefToSink in akka.stream.SinkRef.
    Definition Classes
    SinkGraph
  10. def async(dispatcher: String): Sink[In, NotUsed]

    Put an asynchronous boundary around this Graph

    Put an asynchronous boundary around this Graph

    dispatcher

    Run the graph on this dispatcher

    Implicit
    This member is added by an implicit conversion from SinkRef[In] to Sink[In, NotUsed] performed by method convertRefToSink in akka.stream.SinkRef.
    Definition Classes
    SinkGraph
  11. def async: Sink[In, NotUsed]

    Put an asynchronous boundary around this Source

    Put an asynchronous boundary around this Source

    Implicit
    This member is added by an implicit conversion from SinkRef[In] to Sink[In, NotUsed] performed by method convertRefToSink in akka.stream.SinkRef.
    Definition Classes
    SinkGraph
  12. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  13. def contramap[In2](f: (In2) ⇒ In): Sink[In2, NotUsed]

    Transform this Sink by applying a function to each *incoming* upstream element before it is passed to the Sink

    Transform this Sink by applying a function to each *incoming* upstream element before it is passed to the Sink

    Backpressures when original Sink backpressures

    Cancels when original Sink cancels

    Implicit
    This member is added by an implicit conversion from SinkRef[In] to Sink[In, NotUsed] performed by method convertRefToSink in akka.stream.SinkRef.
    Definition Classes
    Sink
  14. def ensuring(cond: (SinkRef[In]) ⇒ Boolean, msg: ⇒ Any): SinkRef[In]
    Implicit
    This member is added by an implicit conversion from SinkRef[In] to Ensuring[SinkRef[In]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: (SinkRef[In]) ⇒ Boolean): SinkRef[In]
    Implicit
    This member is added by an implicit conversion from SinkRef[In] to Ensuring[SinkRef[In]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean, msg: ⇒ Any): SinkRef[In]
    Implicit
    This member is added by an implicit conversion from SinkRef[In] to Ensuring[SinkRef[In]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean): SinkRef[In]
    Implicit
    This member is added by an implicit conversion from SinkRef[In] to Ensuring[SinkRef[In]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  20. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from SinkRef[In] to StringFormat[SinkRef[In]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  21. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def getSink(): Sink[In, NotUsed]

    Java API: Get javadsl.Sink underlying to this source ref.

  23. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. def mapMaterializedValue[Mat2](f: (NotUsed) ⇒ Mat2): Sink[In, Mat2]

    Transform only the materialized value of this Sink, leaving all other properties as they were.

    Transform only the materialized value of this Sink, leaving all other properties as they were.

    Implicit
    This member is added by an implicit conversion from SinkRef[In] to Sink[In, NotUsed] performed by method convertRefToSink in akka.stream.SinkRef.
    Definition Classes
    Sink
  26. def named(name: String): Sink[In, NotUsed]

    Add a name attribute to this Sink.

    Add a name attribute to this Sink.

    Implicit
    This member is added by an implicit conversion from SinkRef[In] to Sink[In, NotUsed] performed by method convertRefToSink in akka.stream.SinkRef.
    Definition Classes
    SinkGraph
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  30. def preMaterialize()(implicit materializer: Materializer): (NotUsed, Sink[In, NotUsed])

    Materializes this Sink, immediately returning (1) its materialized value, and (2) a new Sink that can be consume elements 'into' the pre-materialized one.

    Materializes this Sink, immediately returning (1) its materialized value, and (2) a new Sink that can be consume elements 'into' the pre-materialized one.

    Useful for when you need a materialized value of a Sink when handing it out to someone to materialize it for you.

    Implicit
    This member is added by an implicit conversion from SinkRef[In] to Sink[In, NotUsed] performed by method convertRefToSink in akka.stream.SinkRef.
    Definition Classes
    Sink
  31. def runWith[Mat2](source: Graph[SourceShape[In], Mat2])(implicit materializer: Materializer): Mat2

    Connect this Sink to a Source and run it.

    Connect this Sink to a Source and run it. The returned value is the materialized value of the Source, e.g. the Subscriber of a Source#subscriber.

    Implicit
    This member is added by an implicit conversion from SinkRef[In] to Sink[In, NotUsed] performed by method convertRefToSink in akka.stream.SinkRef.
    Definition Classes
    Sink
  32. val shape: SinkShape[In]

    The shape of a graph is all that is externally visible: its inlets and outlets.

    The shape of a graph is all that is externally visible: its inlets and outlets.

    Implicit
    This member is added by an implicit conversion from SinkRef[In] to Sink[In, NotUsed] performed by method convertRefToSink in akka.stream.SinkRef.
    Definition Classes
    SinkGraph
  33. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  34. def toString(): String
    Definition Classes
    AnyRef → Any
  35. val traversalBuilder: LinearTraversalBuilder

    INTERNAL API.

    INTERNAL API.

    Every materializable element must be backed by a stream layout module

    Implicit
    This member is added by an implicit conversion from SinkRef[In] to Sink[In, NotUsed] performed by method convertRefToSink in akka.stream.SinkRef.
    Definition Classes
    SinkGraph
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. def withAttributes(attr: Attributes): Sink[In, NotUsed]

    Replace the attributes of this Sink with the given ones.

    Replace the attributes of this Sink with the given ones. If this Sink is a composite of multiple graphs, new attributes on the composite will be less specific than attributes set directly on the individual graphs of the composite.

    Implicit
    This member is added by an implicit conversion from SinkRef[In] to Sink[In, NotUsed] performed by method convertRefToSink in akka.stream.SinkRef.
    Definition Classes
    SinkGraph
  40. def [B](y: B): (SinkRef[In], B)
    Implicit
    This member is added by an implicit conversion from SinkRef[In] to ArrowAssoc[SinkRef[In]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. def toString(): String
    Implicit
    This member is added by an implicit conversion from SinkRef[In] to Sink[In, NotUsed] performed by method convertRefToSink in akka.stream.SinkRef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (sinkRef: Sink[In, NotUsed]).toString()
    Definition Classes
    Sink → AnyRef → Any

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion convertRefToSink from SinkRef[In] to Sink[In, NotUsed]

Inherited by implicit conversion any2stringadd from SinkRef[In] to any2stringadd[SinkRef[In]]

Inherited by implicit conversion StringFormat from SinkRef[In] to StringFormat[SinkRef[In]]

Inherited by implicit conversion Ensuring from SinkRef[In] to Ensuring[SinkRef[In]]

Inherited by implicit conversion ArrowAssoc from SinkRef[In] to ArrowAssoc[SinkRef[In]]

Ungrouped