IAsyncBatchProducer<T> Interface

Definition

Namespace:

Orleans.Streams

Assembly:

Orleans.Streaming.dll

Package:

Microsoft.Orleans.Streaming v8.0.0

This interface generalizes the IAsyncObserver interface to allow production of batches of items.

Note that this interface is invoked (used) by item producers.

public interface IAsyncBatchProducer<T> : Orleans.Streams.IAsyncObserver<T>

type IAsyncBatchProducer<'T> = interface
    interface IAsyncObserver<'T>

Public Interface IAsyncBatchProducer(Of T)
Implements IAsyncObserver(Of T)

Type Parameters

T

The type of object consumed by the observer.

Derived

Orleans.Streams.IAsyncStream<T>

Implements

IAsyncObserver<T>

Methods

OnCompletedAsync()	Notifies the consumer that the stream was completed. The Task returned from this method should be completed when the consumer is done processing the stream closure. (Inherited from IAsyncObserver<T>)
OnErrorAsync(Exception)	Notifies the consumer that the stream had an error. The Task returned from this method should be completed when the consumer is done processing the stream closure. (Inherited from IAsyncObserver<T>)
OnNextAsync(T, StreamSequenceToken)	Passes the next item to the consumer. The Task returned from this method should be completed when the item's processing has been sufficiently processed by the consumer to meet any behavioral guarantees. When the consumer is the (producer endpoint of) a stream, the Task is completed when the stream implementation has accepted responsibility for the item and is assured of meeting its delivery guarantees. For instance, a stream based on a durable queue would complete the Task when the item has been durably saved. A stream that provides best-effort at most once delivery would return a Task that is already complete. When the producer is the (consumer endpoint of) a stream, the Task should be completed by the consumer code when it has accepted responsibility for the item. In particular, if the stream provider guarantees at-least-once delivery, then the item should not be considered delivered until the Task returned by the consumer has been completed. (Inherited from IAsyncObserver<T>)
OnNextBatchAsync(IEnumerable<T>, StreamSequenceToken)	Passes the next batch of items to the consumer. The Task returned from this method should be completed when all items in the batch have been sufficiently processed by the consumer to meet any behavioral guarantees. That is, the semantics of the returned Task is the same as for OnNextAsync(T, StreamSequenceToken), extended for all items in the batch.