ClientBuilder Class

Definition

Namespace:: Orleans

Assembly:: Orleans.dll

Assembly:: Orleans.Core.dll

Package:: Microsoft.Orleans.Core v1.5.10

Package:: Microsoft.Orleans.Core v2.4.5

Package:: Microsoft.Orleans.Core v3.6.5

Source:: ClientBuilder.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Builder used for creating IClusterClient instances.

public class ClientBuilder : Orleans.IClientBuilder

type ClientBuilder = class
    interface IClientBuilder

Public Class ClientBuilder
Implements IClientBuilder

Inheritance: Object
ClientBuilder

Implements: IClientBuilder

Constructors

Name	Description
ClientBuilder()

Properties

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

Methods

Name	Description
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.
ConfigureServices(Action<IServiceCollection>)	Adds a service configuration delegate to the configuration pipeline.
UseConfiguration(ClientConfiguration)	Specified the configuration to use for this client.
UseServiceProviderFactory<TContainerBuilder>(IServiceProviderFactory<TContainerBuilder>)	Specifies how the IServiceProvider for this client is configured.

Extension Methods

Name	Description
AddApplicationInsightsTelemetryConsumer(IClientBuilder, String)	Adds a metrics telemetric consumer provider of type AITelemetryConsumer.
AddAzureQueueStreams(IClientBuilder, String, Action<ClusterClientAzureQueueStreamConfigurator>)	Configure cluster client to use azure queue persistent streams.
AddAzureQueueStreams(IClientBuilder, String, Action<OptionsBuilder<AzureQueueOptions>>)	Configure cluster client to use azure queue persistent streams.
AddAzureQueueStreams<TDataAdapter>(IClientBuilder, String, Action<ClusterClientAzureQueueStreamConfigurator<TDataAdapter>>)	Configure cluster client to use azure queue persistent streams.
AddAzureQueueStreams<TDataAdapter>(IClientBuilder, String, Action<OptionsBuilder<AzureQueueOptions>>)	Configure cluster client to use azure queue persistent streams.
AddClientInvokeCallback(IClientBuilder, ClientInvokeCallback)	Adds a client invocation callback.
AddClusterConnectionLostHandler(IClientBuilder, ConnectionToClusterLostHandler)	Registers a ConnectionToClusterLostHandler event handler.
AddEventHubStreams(IClientBuilder, String, Action<ClusterClientEventHubStreamConfigurator>)	Configure cluster client to use event hub 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.
AddGatewayCountChangedHandler(IClientBuilder, GatewayCountChangedHandler)	Registers a GatewayCountChangedHandler event handler.
AddMemoryStreams<TSerializer>(IClientBuilder, String, Action<ClusterClientMemoryStreamConfigurator<TSerializer>>)	Configure cluster client to use memory streams. This return a configurator for further configuration
AddMemoryStreams<TSerializer>(IClientBuilder, String, Action<IClusterClientMemoryStreamConfigurator>)	Configure cluster client to use memory streams. This return a configurator for further configuration
AddNewRelicTelemetryConsumer(IClientBuilder)	Adds a metrics telemetric consumer provider of type NRTelemetryConsumer.
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.
AddPerfCountersTelemetryConsumer(IClientBuilder)	Adds a metrics telemetric consumer provider of type OrleansPerfCounterTelemetryConsumer.
AddPersistentStreams(IClientBuilder, String, Func<IServiceProvider,String,IQueueAdapterFactory>, Action<IClusterClientPersistentStreamConfigurator>)
AddPersistentStreams(IClientBuilder, String, Func<IServiceProvider,String,IQueueAdapterFactory>, Action<IClusterClientPersistentStreamConfigurator>)
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.
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.
AddServiceFabric(IClientBuilder, String)	Adds support for connecting to a cluster hosted in Service Fabric.
AddServiceFabric(IClientBuilder, Uri)	Adds support for connecting to a cluster hosted in Service Fabric.
AddSimpleMessageStreamProvider(IClientBuilder, String, Action<ISimpleMessageStreamConfigurator>)	Configure client to use SimpleMessageProvider
AddSimpleMessageStreamProvider(IClientBuilder, String, Action<OptionsBuilder<SimpleMessageStreamProviderOptions>>)	Configure client to use SimpleMessageProvider
AddSimpleMessageStreamProvider(IClientBuilder, String, Action<SimpleMessageStreamProviderOptions>)	Configure client to use SimpleMessageProvider
AddSqsStreams(IClientBuilder, String, Action<ClusterClientSqsStreamConfigurator>)	Configure cluster client to use SQS persistent streams.
AddSqsStreams(IClientBuilder, String, Action<ClusterClientSqsStreamConfigurator>)	Configure cluster client to use SQS persistent streams.
AddSqsStreams(IClientBuilder, String, Action<SqsOptions>)	Configure cluster client to use SQS persistent streams with default settings
Configure<TOptions>(IClientBuilder, Action<TOptions>)	Registers an action used to configure a particular type of options.
Configure<TOptions>(IClientBuilder, IConfiguration)	Registers a configuration instance which `TOptions` will bind against.
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.
LoadConfiguration(IClientBuilder, FileInfo)	Loads configuration from the provided location.
LoadConfiguration(IClientBuilder, String)	Loads configuration from the provided location.
LoadConfiguration(IClientBuilder)	Loads configuration from the standard client configuration locations.
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.
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.
UseAzureStorageClustering(IClientBuilder, Action<AzureStorageGatewayOptions>)	Configures the client to use Azure Storage for clustering.
UseAzureStorageClustering(IClientBuilder, Action<AzureStorageGatewayOptions>)	Configures the client to use Azure Storage for clustering.
UseAzureStorageClustering(IClientBuilder, Action<OptionsBuilder<AzureStorageGatewayOptions>>)	Configures the client to use Azure Storage for clustering.
UseAzureStorageClustering(IClientBuilder, Action<OptionsBuilder<AzureStorageGatewayOptions>>)	Configures the client to use Azure Storage for clustering.
UseConfiguration(IClientBuilder, ClientConfiguration)	Specified the configuration to use for this client.
UseConsulClustering(IClientBuilder, Action<ConsulClusteringClientOptions>)	Configures the client to use Consul for clustering.
UseConsulClustering(IClientBuilder, Action<OptionsBuilder<ConsulClusteringClientOptions>>)	Configures the client to use Consul for clustering.
UseDynamoDBClustering(IClientBuilder, Action<DynamoDBGatewayOptions>)	Configures the client to use DynamoDB for clustering.
UseDynamoDBClustering(IClientBuilder, Action<OptionsBuilder<DynamoDBGatewayOptions>>)	Configures the client to use DynamoDB for clustering.
UseEnvironment(IClientBuilder, String)	Specify the environment to be used by the host.
UseLinuxEnvironmentStatistics(IClientBuilder)	Use Linux host environment statistics
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.
UsePerfCounterEnvironmentStatistics(IClientBuilder)	Use Windows performance counters as source for host environment statistics
UseServiceFabricClustering(IClientBuilder, String)	Adds support for connecting to a cluster hosted in Service Fabric.
UseServiceFabricClustering(IClientBuilder, Uri)	Adds support for connecting to a cluster hosted in Service Fabric.
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.
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.
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.

Applies to

Delen via