Class StreamSubscriptionHandle<T>

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

Inheritance
System.Object
StreamSubscriptionHandle<T>
Namespace: Orleans.Streams
Assembly: Orleans.Core.Abstractions.dll
Syntax
public abstract class StreamSubscriptionHandle<T> : IEquatable<StreamSubscriptionHandle<T>>
Type Parameters
Name Description
T

Properties

| Improve this Doc View Source

HandleId

Unique identifier for this StreamSubscriptionHandle

Declaration
public abstract Guid HandleId { get; }
Property Value
Type Description
Guid
| Improve this Doc View Source

ProviderName

Declaration
public abstract string ProviderName { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

StreamIdentity

Declaration
public abstract IStreamIdentity StreamIdentity { get; }
Property Value
Type Description
IStreamIdentity

Methods

| Improve this Doc View Source

Equals(StreamSubscriptionHandle<T>)

Declaration
public abstract bool Equals(StreamSubscriptionHandle<T> other)
Parameters
Type Name Description
StreamSubscriptionHandle<T> other
Returns
Type Description
System.Boolean
| Improve this Doc View Source

ResumeAsync(IAsyncObserver<T>, StreamSequenceToken)

Resumed consumption from a subscription to a stream.

Declaration
public abstract Task<StreamSubscriptionHandle<T>> ResumeAsync(IAsyncObserver<T> observer, StreamSequenceToken token = null)
Parameters
Type Name Description
IAsyncObserver<T> observer

The Observer object.
StreamSequenceToken token

The stream sequence to be used as an offset to start the subscription from.
Returns
Type Description
Task<StreamSubscriptionHandle<T>>

A promise with an updates subscription handle.
| Improve this Doc View Source

UnsubscribeAsync()

Unsubscribe a stream consumer from this observable.

Declaration
public abstract Task UnsubscribeAsync()
Returns
Type Description
Task

A promise to unsubscription action.

Extension Methods