Package org.apache.pekko.stream.scaladsl
Interface SourceQueue<T>
- 
- All Known Subinterfaces:
- SourceQueueWithComplete<T>
 
 public interface SourceQueue<T>This trait allows to have a queue as a data source for some stream.
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description scala.concurrent.Future<QueueOfferResult>offer(T elem)Offers an element to a stream and returns aFuturethat: - completes withEnqueuedif the element is consumed by a stream - completes withDroppedwhen the stream dropped the offered element - completes withQueueClosedwhen the stream is completed whilst theFutureis active - completes withFailure(f)in case of failure to enqueue element from upstream - fails when stream is already completedscala.concurrent.Future<Done>watchCompletion()Returns aFuturethat will be completed if this operator completes, or will be failed when the operator faces an internal failure.
 
- 
- 
- 
Method Detail- 
offerscala.concurrent.Future<QueueOfferResult> offer(T elem) Offers an element to a stream and returns aFuturethat: - completes withEnqueuedif the element is consumed by a stream - completes withDroppedwhen the stream dropped the offered element - completes withQueueClosedwhen the stream is completed whilst theFutureis active - completes withFailure(f)in case of failure to enqueue element from upstream - fails when stream is already completedAdditionally when using the backpressure overflowStrategy: - If the buffer is full the Futurewon't be completed until there is space in the buffer - Calling offer before theFutureis completed, in this case it will return a failedFuture- Parameters:
- elem- element to send to a stream
 
 - 
watchCompletionscala.concurrent.Future<Done> watchCompletion() Returns aFuturethat 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. 
 
- 
 
-