StreamSubscriptionHandle<T> Methods

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

Markdown

Handle representing this subscription. Consumer may serialize and store the handle in order to unsubscribe later, for example in another activation on this grain.

Equals(StreamSubscriptionHandle<T>)

abstract

public abstract bool Equals(StreamSubscriptionHandle<T> other)

Indicates whether the current object is equal to another object of the same type.

Parameters

otherStreamSubscriptionHandle<T>

An object to compare with this object.

Returns

true if the current object is equal to the other parameter; otherwise, false.

ResumeAsync(IAsyncBatchObserver<T>, StreamSequenceToken)

abstract

public abstract Task<StreamSubscriptionHandle<T>> ResumeAsync(IAsyncBatchObserver<T> observer, StreamSequenceToken token = null)

Resume batch consumption from a subscription to a stream.

Parameters

observerIAsyncBatchObserver<T>

The batcj bserver object.

tokenStreamSequenceToken

The stream sequence to be used as an offset to start the subscription from.

Returns

The new stream subscription handle.

ResumeAsync(IAsyncObserver<T>, StreamSequenceToken)

abstract

public abstract Task<StreamSubscriptionHandle<T>> ResumeAsync(IAsyncObserver<T> observer, StreamSequenceToken token = null)

Resumed consumption from a subscription to a stream.

Parameters

observerIAsyncObserver<T>

The observer object.

tokenStreamSequenceToken

The stream sequence to be used as an offset to start the subscription from.

Returns

The new stream subscription handle.

UnsubscribeAsync

abstract

public abstract Task UnsubscribeAsync()

Unsubscribe a stream consumer from this observable.

Returns

A System.Threading.Tasks.Task representing the operation.