Interface ISourceQueue<T>
This interface allows to have the queue as a data source for some stream.
Namespace: Akka.Streams
Assembly: Akka.Streams.dll
Syntax
public interface ISourceQueue<in T>
Type Parameters
Name | Description |
---|---|
T | TBD |
Methods
| Improve this Doc View SourceOfferAsync(T)
Method offers next element to a stream and returns task that:
- competes with QueueOfferResult.Enqueued if element is consumed by a stream
- competes with QueueOfferResult.Dropped when stream dropped offered element
- competes with QueueOfferResult.QueueClosed when stream is completed while task is active
- competes with QueueOfferResult.Failure when failure to enqueue element from upstream
- fails if stream is completed or you cannot call offer in this moment because of implementation rules (like for backpressure mode and full buffer you need to wait for last offer call task completion.
Declaration
Task<IQueueOfferResult> OfferAsync(T element)
Parameters
Type | Name | Description |
---|---|---|
T | element | element to send to a stream |
Returns
Type | Description |
---|---|
Task<IQueueOfferResult> | TBD |
WatchCompletionAsync()
Method returns Task that will be completed if the stream completes, or will be failed when the stage faces an internal failure.
Declaration
Task WatchCompletionAsync()
Returns
Type | Description |
---|---|
Task | TBD |