IAsyncObserver<T> Methods

1. Documentation
2. API reference
3. Microsoft.Orleans.Streaming
4. IAsyncObserver<T>
5. Methods

Markdown

This interface generalizes the standard .NET IObserver interface to allow asynchronous production of items.

Note that this interface is implemented by item consumers and invoked (used) by item producers. This means that the consumer endpoint of a stream implements this interface.

OnCompletedAsync

virtual

View source

public virtual Task 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.

Returns

A Task that is completed when the stream-complete operation has been accepted.

OnErrorAsync(Exception)

abstract

public abstract Task OnErrorAsync(Exception ex)

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.

Parameters

exException

An Exception that describes the error that occurred on the stream.

Returns

A Task that is completed when the close has been accepted.

OnNextAsync(T, StreamSequenceToken?)

abstract

public abstract Task OnNextAsync(T item, StreamSequenceToken? token = null)

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.

Parameters

itemT

The item to be passed.

tokenStreamSequenceToken?

The stream sequence token of this item.

Returns

A Task that is completed when the item has been accepted.