IStreamPubSub

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

interface

Namespace: Orleans.Streams

NuGetSourceMarkdown

Provides the stream provider pub/sub control plane for registering producers and consumers and querying subscription state.

public interface IStreamPubSub

Methods

• ConsumerCount(QualifiedStreamId) Gets the number of registered consumers for a stream.
• ConsumerCount(QualifiedStreamId, CancellationToken) Gets the number of consumers registered for a stream.
• CreateSubscriptionId(QualifiedStreamId, GrainId) Creates a subscription identifier for a stream consumer.
• FaultSubscription(QualifiedStreamId, GuidId) Marks a subscription as faulted.
• FaultSubscription(QualifiedStreamId, GuidId, CancellationToken) Marks a subscription as faulted.
• GetAllSubscriptions(QualifiedStreamId, GrainId) Gets active subscriptions for a stream, optionally restricted to a specific consumer.
• GetAllSubscriptions(QualifiedStreamId, GrainId, CancellationToken) Gets the subscriptions for a stream.
• ProducerCount(QualifiedStreamId) Gets the number of registered producers for a stream.
• ProducerCount(QualifiedStreamId, CancellationToken) Gets the number of producers registered for a stream.
• RegisterConsumer(GuidId, QualifiedStreamId, GrainId, string?) Registers a consumer subscription for a stream.
• RegisterConsumer(GuidId, QualifiedStreamId, GrainId, string?, CancellationToken) Registers a stream consumer.
• RegisterProducer(QualifiedStreamId, GrainId) Registers a producer for a stream and returns the active consumer registrations which the producer should connect to.
• RegisterProducer(QualifiedStreamId, GrainId, CancellationToken) Registers a stream producer.
• UnregisterConsumer(GuidId, QualifiedStreamId) Unregisters a consumer subscription from a stream.
• UnregisterConsumer(GuidId, QualifiedStreamId, CancellationToken) Unregisters a stream consumer.
• UnregisterProducer(QualifiedStreamId, GrainId) Unregisters a producer from a stream.
• UnregisterProducer(QualifiedStreamId, GrainId, CancellationToken) Unregisters a stream producer.