Interface SourceQueue<T>

  • All Known Subinterfaces:
    SourceQueueWithComplete<T>

    public interface SourceQueue<T>
    Method offers next element to a stream and returns future that: - completes with Enqueued if element is consumed by a stream - completes with Dropped when stream dropped offered element - completes with QueueClosed when stream is completed during future is active - completes with Failure(f) when failure to enqueue element from upstream - fails when stream is completed

    Additionally when using the backpressure overflowStrategy: - If the buffer is full the Future won't be completed until there is space in the buffer - Calling offer before the Future is completed in this case will return a failed Future

    param: elem element to send to a stream

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      scala.concurrent.Future<QueueOfferResult> offer​(T elem)
      Method offers next element to a stream and returns future that: - completes with Enqueued if element is consumed by a stream - completes with Dropped when stream dropped offered element - completes with QueueClosed when stream is completed during future is active - completes with Failure(f) when failure to enqueue element from upstream - fails when stream is completed
      scala.concurrent.Future<Done> watchCompletion()
      Method returns a Future that will be completed if this operator completes, or will be failed when the operator faces an internal failure.
    • Method Detail

      • offer

        scala.concurrent.Future<QueueOfferResult> offer​(T elem)
        Method offers next element to a stream and returns future that: - completes with Enqueued if element is consumed by a stream - completes with Dropped when stream dropped offered element - completes with QueueClosed when stream is completed during future is active - completes with Failure(f) when failure to enqueue element from upstream - fails when stream is completed

        Additionally when using the backpressure overflowStrategy: - If the buffer is full the Future won't be completed until there is space in the buffer - Calling offer before the Future is completed in this case will return a failed Future

        Parameters:
        elem - element to send to a stream
        Returns:
        (undocumented)
      • watchCompletion

        scala.concurrent.Future<Done> watchCompletion()
        Method returns a Future that will be completed if this operator completes, or will be failed when the operator faces an internal failure.

        Note that this only means the elements have been passed downstream, not that downstream has successfully processed them.

        Returns:
        (undocumented)