ConsulGatewayListProvider

1. Documentation
2. API reference
3. Microsoft.Orleans.Clustering.Consul
4. ConsulGatewayListProvider

class

Namespace: Orleans.Runtime.Membership

NuGetSourceMarkdown

Provides Orleans gateway addresses from Consul cluster membership.

public class ConsulGatewayListProvider : IGatewayListProvider

Constructors

• ConsulGatewayListProvider(ILogger<ConsulGatewayListProvider>, IOptions<ConsulClusteringOptions>, IOptions<GatewayOptions>, IOptions<ClusterOptions>) Initializes a new instance of the ConsulGatewayListProvider class.

Properties

• IsUpdatable Gets a value indicating whether this IGatewayListProvider ever refreshes its returned information, or always returns the same gateway list.
• MaxStaleness Gets the period of time between refreshes.

Methods

• GetGateways Returns the list of gateways (silos) that can be used by a client to connect to Orleans cluster. The Uri is in the form of: "gwy.tcp://IP:port/Generation". See Utils.ToGatewayUri and Utils.ToSiloAddress for more details about Uri format.
• GetGatewaysAsync(CancellationToken) Gets the gateway endpoints which clients can use to connect to the cluster.
• InitializeGatewayListProvider Initializes the provider, will be called before all other methods.
• InitializeGatewayListProviderAsync(CancellationToken) Initializes the provider before gateway discovery begins.