PubSubSubscriptionState

1. Documentation
2. API reference
3. Microsoft.Orleans.Streaming
4. PubSubSubscriptionState

class

Namespace: Orleans.Streams

NuGetSourceMarkdown

Represents the pub/sub registration state for a stream subscription.

[Orleans.GenerateSerializer]
public sealed class PubSubSubscriptionState : IEquatable<PubSubSubscriptionState?>, IJsonOnDeserialized

Constructors

• PubSubSubscriptionState(GuidId, QualifiedStreamId, GrainId, string?, SubscriptionStates) Initializes a stream subscription registration.
• PubSubSubscriptionState(GuidId, QualifiedStreamId, GrainId) Initializes an active stream subscription registration.

Properties

• IsFaulted Gets a value indicating whether the subscription is faulted.

Methods

• AddFilter(string?) Sets the serialized filter data associated with the subscription.
• Equals(GuidId?) Determines whether this subscription has the specified identifier.
• Equals(PubSubSubscriptionState?)Indicates whether the current object is equal to another object of the same type.
• Equals(object?)Determines whether the specified object is equal to the current object.
• Fault Marks the subscription as faulted.
• GetHashCodeServes as the default hash function.
• ToStringReturns a string that represents the current object.
• operator ==(PubSubSubscriptionState?, PubSubSubscriptionState?) Compares two subscription states for equality by subscription identifier.
• operator !=(PubSubSubscriptionState?, PubSubSubscriptionState?) Compares two subscription states for inequality by subscription identifier.

Fields

• Consumer The identifier of the grain which consumes the stream.
• FilterData The serialized filter data associated with the subscription.
• Stream The qualified identifier of the subscribed stream.
• SubscriptionId The subscription identifier.
• state The lifecycle state of the subscription.