IClientBuilder Interface

Definition

Namespace:

Orleans

Assembly:

Orleans.Core.dll

Package:

Microsoft.Orleans.Core v3.6.5

Source:

IClientBuilder.cs

Functionality for building IClusterClient instances.

public interface IClientBuilder

type IClientBuilder = interface

Public Interface IClientBuilder

Derived

Orleans.ClientBuilder

Properties

Properties

A central location for sharing state between components during the client building process.

Methods

Build()	Builds the client.
ConfigureAppConfiguration(Action<HostBuilderContext,IConfigurationBuilder>)	Sets up the configuration for the remainder of the build process and application. This can be called multiple times and the results will be additive. The results will be available at Configuration for subsequent operations./>.
ConfigureContainer<TContainerBuilder>(Action<TContainerBuilder>)	Adds a container configuration delegate.
ConfigureHostConfiguration(Action<IConfigurationBuilder>)	Set up the configuration for the builder itself. This will be used to initialize the IHostingEnvironment for use later in the build process. This can be called multiple times and the results will be additive.
ConfigureServices(Action<HostBuilderContext,IServiceCollection>)	Adds services to the container. This can be called multiple times and the results will be additive.
UseServiceProviderFactory<TContainerBuilder>(IServiceProviderFactory<TContainerBuilder>)	Specifies how the IServiceProvider for this client is configured.

Extension Methods

AddClusterConnectionLostHandler(IClientBuilder, ConnectionToClusterLostHandler)	Registers a ConnectionToClusterLostHandler event handler.
AddGatewayCountChangedHandler(IClientBuilder, GatewayCountChangedHandler)	Registers a GatewayCountChangedHandler event handler.
Configure<TOptions>(IClientBuilder, IConfiguration)	Registers a configuration instance which TOptions will bind against.
Configure<TOptions>(IClientBuilder, Action<TOptions>)	Registers an action used to configure a particular type of options.
ConfigureAppConfiguration(IClientBuilder, Action<IConfigurationBuilder>)	Sets up the configuration for the remainder of the build process and application. This can be called multiple times and the results will be additive. The results will be available at Configuration for subsequent operations./>.
ConfigureApplicationParts(IClientBuilder, Action<IApplicationPartManager>)	Configures the ApplicationPartManager for this builder.
ConfigureDefaults(IClientBuilder)	Configures default client services.
ConfigureLogging(IClientBuilder, Action<ILoggingBuilder>)	Adds a delegate for configuring the provided ILoggingBuilder. This may be called multiple times.
ConfigureServices(IClientBuilder, Action<IServiceCollection>)	Adds services to the container. This can be called multiple times and the results will be additive.
GetApplicationPartManager(IClientBuilder)	Returns the ApplicationPartManager for this builder.
UseEnvironment(IClientBuilder, String)	Specify the environment to be used by the host.
UseLocalhostClustering(IClientBuilder, Int32, String, String)	Configures the client to connect to a silo on the localhost.
UseLocalhostClustering(IClientBuilder, Int32[], String, String)	Configures the client to connect to a silo on the localhost.
UseServiceProviderFactory(IClientBuilder, Func<IServiceCollection,IServiceProvider>)	Specifies how the IServiceProvider for this client is configured.
UseStaticClustering(IClientBuilder, Action<OptionsBuilder<StaticGatewayListProviderOptions>>)	Configures the client to use static clustering.
UseStaticClustering(IClientBuilder, Action<StaticGatewayListProviderOptions>)	Configures the client to use static clustering.
UseStaticClustering(IClientBuilder, IPEndPoint[])	Configures the client to use static clustering.
AddOutgoingGrainCallFilter(IClientBuilder, IOutgoingGrainCallFilter)	Adds an IOutgoingGrainCallFilter to the filter pipeline.
AddOutgoingGrainCallFilter(IClientBuilder, OutgoingGrainCallFilterDelegate)	Adds an IOutgoingGrainCallFilter to the filter pipeline via a delegate.
AddOutgoingGrainCallFilter<TImplementation>(IClientBuilder)	Adds an IOutgoingGrainCallFilter to the filter pipeline.
AddProviderClusterOptions(IClientBuilder, String, Action<OptionsBuilder<ClusterOptions>>)	Add an override ClusterOptions on a per-provider basis. Note: This is intended for migration purposes as a means to handle previously inconsistent behaviors in how providers used ServiceId and ClusterId.
AddProviderClusterOptions(IClientBuilder, String, Action<ClusterOptions>)	Add an override ClusterOptions on a per-provider basis. Note: This is intended for migration purposes as a means to handle previously inconsistent behaviors in how providers used ServiceId and ClusterId.
UseAdoNetClustering(IClientBuilder, Action<OptionsBuilder<AdoNetClusteringClientOptions>>)	Configures this client to use ADO.NET for clustering. Instructions on configuring your database are available at http://aka.ms/orleans-sql-scripts.
UseAdoNetClustering(IClientBuilder, Action<AdoNetClusteringClientOptions>)	Configures this client to use ADO.NET for clustering. Instructions on configuring your database are available at http://aka.ms/orleans-sql-scripts.
AddApplicationInsightsTelemetryConsumer(IClientBuilder, String)	Adds a metrics telemetric consumer provider of type AITelemetryConsumer.
UseDynamoDBClustering(IClientBuilder, Action<OptionsBuilder<DynamoDBGatewayOptions>>)	Configures the client to use DynamoDB for clustering.
UseDynamoDBClustering(IClientBuilder, Action<DynamoDBGatewayOptions>)	Configures the client to use DynamoDB for clustering.
UseAzureStorageClustering(IClientBuilder, Action<OptionsBuilder<AzureStorageGatewayOptions>>)	Configures the client to use Azure Storage for clustering.
UseAzureStorageClustering(IClientBuilder, Action<AzureStorageGatewayOptions>)	Configures the client to use Azure Storage for clustering.
AddAzureQueueStreams(IClientBuilder, String, Action<OptionsBuilder<AzureQueueOptions>>)	Configure cluster client to use azure queue persistent streams.
AddAzureQueueStreams(IClientBuilder, String, Action<ClusterClientAzureQueueStreamConfigurator>)	Configure cluster client to use azure queue persistent streams.
AddEventHubStreams(IClientBuilder, String, Action<EventHubOptions>)	Configure cluster client to use event hub persistent streams with default settings.
AddEventHubStreams(IClientBuilder, String, Action<IClusterClientEventHubStreamConfigurator>)	Configure cluster client to use event hub persistent streams.
AddMemoryStreams<TSerializer>(IClientBuilder, String, Action<IClusterClientMemoryStreamConfigurator>)	Configure cluster client to use memory streams. This return a configurator for further configuration
AddSqsStreams(IClientBuilder, String, Action<SqsOptions>)	Configure cluster client to use SQS persistent streams with default settings
AddSqsStreams(IClientBuilder, String, Action<ClusterClientSqsStreamConfigurator>)	Configure cluster client to use SQS persistent streams.
AddPersistentStreams(IClientBuilder, String, Func<IServiceProvider,String,IQueueAdapterFactory>, Action<IClusterClientPersistentStreamConfigurator>)
AddSimpleMessageStreamProvider(IClientBuilder, String, Action<OptionsBuilder<SimpleMessageStreamProviderOptions>>)	Configure client to use SimpleMessageProvider
AddSimpleMessageStreamProvider(IClientBuilder, String, Action<SimpleMessageStreamProviderOptions>)	Configure client to use SimpleMessageProvider
AddSimpleMessageStreamProvider(IClientBuilder, String, Action<ISimpleMessageStreamConfigurator>)	Configure client to use SimpleMessageProvider
UseConsulClustering(IClientBuilder, Action<OptionsBuilder<ConsulClusteringClientOptions>>)	Configures the client to use Consul for clustering.
UseConsulClustering(IClientBuilder, Action<ConsulClusteringClientOptions>)	Configures the client to use Consul for clustering.
AddNewRelicTelemetryConsumer(IClientBuilder)	Adds a metrics telemetric consumer provider of type NRTelemetryConsumer.
AddPerfCountersTelemetryConsumer(IClientBuilder)	Adds a metrics telemetric consumer provider of type OrleansPerfCounterTelemetryConsumer.
UseZooKeeperClustering(IClientBuilder, Action<OptionsBuilder<ZooKeeperGatewayListProviderOptions>>)	Configure the client to use ZooKeeper for clustering.
UseZooKeeperClustering(IClientBuilder, Action<ZooKeeperGatewayListProviderOptions>)	Configure the client to use ZooKeeper for clustering.
UseTls(IClientBuilder, Action<TlsOptions>)	Configures TLS.
UseTls(IClientBuilder, StoreName, String, Boolean, StoreLocation, Action<TlsOptions>)	Configures TLS.
UseTls(IClientBuilder, X509Certificate2, Action<TlsOptions>)	Configures TLS.
UseTls(IClientBuilder, X509Certificate2)	Configures TLS.
UseLinuxEnvironmentStatistics(IClientBuilder)	Use Linux host environment statistics
UsePerfCounterEnvironmentStatistics(IClientBuilder)	Use Windows performance counters as source for host environment statistics