ClientBuilderExtensions Methods

Extension methods for IClientBuilder.

AddActivityPropagation(IClientBuilder)

staticextension

public static IClientBuilder AddActivityPropagation(this IClientBuilder builder)

Add System.Diagnostics.Activity.Current propagation through grain calls. Note: according to System.Diagnostics.ActivitySource.StartActivity activity will be created only when any listener for activity exists System.Diagnostics.ActivitySource.HasListeners and System.Diagnostics.ActivityListener.Sample returns System.Diagnostics.ActivitySamplingResult.PropagationData.

Parameters

builderIClientBuilder: The builder.

Returns

The builder.

AddClusterConnectionLostHandler(IClientBuilder, ConnectionToClusterLostHandler)

staticextension

public static IClientBuilder AddClusterConnectionLostHandler(this IClientBuilder builder, ConnectionToClusterLostHandler handler)

Registers a ConnectionToClusterLostHandler event handler.

Parameters

builderIClientBuilder: The builder.
handlerConnectionToClusterLostHandler: The handler.

Returns

The builder.

AddClusterConnectionLostHandler(IClientBuilder, Func<IServiceProvider, ConnectionToClusterLostHandler>)

staticextension

public static IClientBuilder AddClusterConnectionLostHandler(this IClientBuilder builder, Func<IServiceProvider, ConnectionToClusterLostHandler> handlerFactory)

Registers a ConnectionToClusterLostHandler event handler.

Parameters

builderIClientBuilder: The builder.
handlerFactoryFunc<IServiceProvider, ConnectionToClusterLostHandler>: The handler factory.

Returns

The builder.

AddClusterConnectionStatusObserver(IClientBuilder)

staticextension

public static IClientBuilder AddClusterConnectionStatusObserver<TObserver>(this IClientBuilder builder)

Registers a cluster connection status observer.

Parameters

builderIClientBuilder

AddClusterConnectionStatusObserver(IClientBuilder, TObserver)

staticextension

public static IClientBuilder AddClusterConnectionStatusObserver<TObserver>(this IClientBuilder builder, TObserver observer)

Registers a cluster connection status observer.

Parameters

builderIClientBuilder
observerTObserver

AddGatewayCountChangedHandler(IClientBuilder, Func<IServiceProvider, GatewayCountChangedHandler>)

staticextension

public static IClientBuilder AddGatewayCountChangedHandler(this IClientBuilder builder, Func<IServiceProvider, GatewayCountChangedHandler> handlerFactory)

Registers a GatewayCountChangedHandler event handler.

Parameters

builderIClientBuilder
handlerFactoryFunc<IServiceProvider, GatewayCountChangedHandler>

AddGatewayCountChangedHandler(IClientBuilder, GatewayCountChangedHandler)

staticextension

public static IClientBuilder AddGatewayCountChangedHandler(this IClientBuilder builder, GatewayCountChangedHandler handler)

Registers a GatewayCountChangedHandler event handler.

Parameters

builderIClientBuilder
handlerGatewayCountChangedHandler

Configure(IClientBuilder, Action<TOptions>)

staticextension

public static IClientBuilder Configure<TOptions>(this IClientBuilder builder, Action<TOptions> configureOptions)

Registers an action used to configure a particular type of options.

Parameters

builderIClientBuilder: The host builder.
configureOptionsAction<TOptions>: The action used to configure the options.

Returns

The client builder.

Configure(IClientBuilder, IConfiguration)

staticextension

public static IClientBuilder Configure<TOptions>(this IClientBuilder builder, IConfiguration configuration)

Registers a configuration instance which TOptions will bind against.

Parameters

builderIClientBuilder: The host builder.
configurationIConfiguration: The configuration.

Returns

The client builder.

ConfigureServices(IClientBuilder, Action<IServiceCollection>)

staticextension

public static IClientBuilder ConfigureServices(this IClientBuilder builder, Action<IServiceCollection> configureDelegate)

Adds services to the container. This can be called multiple times and the results will be additive.

Parameters

builderIClientBuilder: The host builder.
configureDelegateAction<IServiceCollection>

Returns

The same instance of the IClientBuilder for chaining.

UseConnectionRetryFilter(IClientBuilder, Func<Exception, CancellationToken, Task<bool>>)

staticextension

public static IClientBuilder UseConnectionRetryFilter(this IClientBuilder builder, Func<Exception, CancellationToken, Task<bool>> connectionRetryFilter)

Configures the provided delegate as a connection retry filter, used to determine whether initial connection to the Orleans cluster should be retried after a failure.

Parameters

builderIClientBuilder: The host builder.
connectionRetryFilterFunc<Exception, CancellationToken, Task<bool>>: The connection retry filter.

Returns

The same instance of the IClientBuilder for chaining.

UseConnectionRetryFilter(IClientBuilder, IClientConnectionRetryFilter)

staticextension

public static IClientBuilder UseConnectionRetryFilter(this IClientBuilder builder, IClientConnectionRetryFilter connectionRetryFilter)

Configures the provided delegate as a connection retry filter, used to determine whether initial connection to the Orleans cluster should be retried after a failure.

Parameters

builderIClientBuilder: The host builder.
connectionRetryFilterIClientConnectionRetryFilter: The connection retry filter.

Returns

The same instance of the IClientBuilder for chaining.

UseConnectionRetryFilter(IClientBuilder)

staticextension

public static IClientBuilder UseConnectionRetryFilter<TConnectionRetryFilter>(this IClientBuilder builder)

Configures the provided TConnectionRetryFilter type as a connection retry filter, used to determine whether initial connection to the Orleans cluster should be retried after a failure.

Parameters

builderIClientBuilder: The host builder.

Returns

The same instance of the IClientBuilder for chaining.

UseLocalhostClustering(IClientBuilder, int, string, string)

staticextension

public static IClientBuilder UseLocalhostClustering(this IClientBuilder builder, int gatewayPort = 30000, string serviceId = "dev", string clusterId = "dev")

Configures the client to connect to a silo on the localhost.

Parameters

builderIClientBuilder: The client builder.
gatewayPortint: The local silo's gateway port.
serviceIdstring: The service id.
clusterIdstring: The cluster id.

Returns

The IClientBuilder.

UseLocalhostClustering(IClientBuilder, int[], string, string)

staticextension

public static IClientBuilder UseLocalhostClustering(this IClientBuilder builder, int[] gatewayPorts, string serviceId = "dev", string clusterId = "dev")

Configures the client to connect to a silo on the localhost.

Parameters

builderIClientBuilder: The client builder.
gatewayPortsint[]: The local silo gateway ports.
serviceIdstring: The service id.
clusterIdstring: The cluster id.

Returns

The IClientBuilder.

UseStaticClustering(IClientBuilder, Action<OptionsBuilder<StaticGatewayListProviderOptions>>)

staticextension

public static IClientBuilder UseStaticClustering(this IClientBuilder builder, Action<OptionsBuilder<StaticGatewayListProviderOptions>> configureOptions)

Configures the client to use static clustering.

Parameters

builderIClientBuilder: The client builder.
configureOptionsAction<OptionsBuilder<StaticGatewayListProviderOptions>>: The configure Options.

Returns

The IClientBuilder.

UseStaticClustering(IClientBuilder, Action<StaticGatewayListProviderOptions>)

staticextension

public static IClientBuilder UseStaticClustering(this IClientBuilder builder, Action<StaticGatewayListProviderOptions> configureOptions)

Configures the client to use static clustering.

Parameters

builderIClientBuilder: The client builder.
configureOptionsAction<StaticGatewayListProviderOptions>: The configure Options.

Returns

The IClientBuilder.

UseStaticClustering(IClientBuilder, IPEndPoint[])

staticextension

public static IClientBuilder UseStaticClustering(this IClientBuilder builder, params IPEndPoint[] endpoints)

Configures the client to use static clustering.

Parameters

builderIClientBuilder: The client builder.
endpointsIPEndPoint[]: The gateway endpoints.

Returns

The IClientBuilder.