Skip to content
Orleans logoMicrosoft Orleans

ConsulGatewayListProvider Methods

Provides Orleans gateway addresses from Consul cluster membership.

GetGateways

View source
public Task<IList<Uri>> 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.

Returns

The list of gateway endpoints.

GetGatewaysAsync(CancellationToken)

View source
public Task<IList<Uri>> GetGatewaysAsync(CancellationToken cancellationToken = default(CancellationToken))
Gets the gateway endpoints which clients can use to connect to the cluster.

Parameters

cancellationTokenCancellationToken
The token used to cancel gateway discovery.

Returns

The list of gateway endpoints.

InitializeGatewayListProvider

View source
public Task InitializeGatewayListProvider()
Initializes the provider, will be called before all other methods.

Returns

A System.Threading.Tasks.Task representing the work performed.

InitializeGatewayListProviderAsync(CancellationToken)

View source
public Task InitializeGatewayListProviderAsync(CancellationToken cancellationToken = default(CancellationToken))
Initializes the provider before gateway discovery begins.

Parameters

cancellationTokenCancellationToken
The token used to cancel initialization.

Returns

A task representing the initialization operation.