Class StreamRefs


  • public class StreamRefs
    extends java.lang.Object
    API MAY CHANGE: The functionality of stream refs is working, however it is expected that the materialized value will eventually be able to remove the Future wrapping the stream references. For this reason the API is now marked as API may change. See ticket https://github.com/akka/akka/issues/24372 for more details.

    Factories for creating stream refs.

    • Constructor Summary

      Constructors 
      Constructor Description
      StreamRefs()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static <T> Source<T,​scala.concurrent.Future<SinkRef<T>>> sinkRef()
      A local Source which materializes a SinkRef which can be used by other streams (including remote ones), to publish data to this local stream, as if they were attached directly in place of the local Source.
      static <T> Sink<T,​scala.concurrent.Future<SourceRef<T>>> sourceRef()
      A local Sink which materializes a SourceRef which can be used by other streams (including remote ones), to consume data from this local stream, as if they were attached directly in place of the local Sink.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • StreamRefs

        public StreamRefs()
    • Method Detail

      • sourceRef

        public static <T> Sink<T,​scala.concurrent.Future<SourceRef<T>>> sourceRef()
        A local Sink which materializes a SourceRef which can be used by other streams (including remote ones), to consume data from this local stream, as if they were attached directly in place of the local Sink.

        Adheres to StreamRefAttributes.

        See more detailed documentation on SourceRef.

        Returns:
        (undocumented)
      • sinkRef

        public static <T> Source<T,​scala.concurrent.Future<SinkRef<T>>> sinkRef()
        A local Source which materializes a SinkRef which can be used by other streams (including remote ones), to publish data to this local stream, as if they were attached directly in place of the local Source.

        Adheres to StreamRefAttributes.

        See more detailed documentation on SinkRef.

        Returns:
        (undocumented)