ClientBuilder Class

Definition

Namespace:

Orleans.Hosting

Assembly:

Orleans.Core.dll

Package:

Microsoft.Orleans.Core v8.2.0

Builder for configuring an Orleans client.

public class ClientBuilder : Orleans.Hosting.IClientBuilder

type ClientBuilder = class
    interface IClientBuilder

Public Class ClientBuilder
Implements IClientBuilder

Inheritance

Object

ClientBuilder

Implements

IClientBuilder

Constructors

ClientBuilder(IServiceCollection, IConfiguration)

Initializes a new instance of the ClientBuilder class.

Properties

Configuration	Gets the configuration.
Services	Gets the services collection.

Extension Methods

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.
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.
AddBroadcastChannel(IClientBuilder, String, Action<OptionsBuilder<BroadcastChannelOptions>>)	Add a new broadcast channel to the client.
AddBroadcastChannel(IClientBuilder, String, Action<BroadcastChannelOptions>)	Add a new broadcast channel to the client.
AddActivityPropagation(IClientBuilder)	Add Current propagation through grain calls. Note: according to StartActivity(String, ActivityKind) activity will be created only when any listener for activity exists HasListeners() and Sample returns PropagationData.
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.
AddClusterConnectionLostHandler(IClientBuilder, ConnectionToClusterLostHandler)	Registers a ConnectionToClusterLostHandler event handler.
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.
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.
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.
ConfigureServices(IClientBuilder, Action<IServiceCollection>)	Adds services to the container. This can be called multiple times and the results will be additive.
UseConnectionRetryFilter(IClientBuilder, IClientConnectionRetryFilter)	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.
UseConnectionRetryFilter(IClientBuilder, Func<Exception,CancellationToken,Task<Boolean>>)	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.
UseConnectionRetryFilter<TConnectionRetryFilter>(IClientBuilder)	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.
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.
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.
UseTransactions(IClientBuilder)
AddIncomingGrainCallFilter(IClientBuilder, IIncomingGrainCallFilter)	Adds an IIncomingGrainCallFilter to the filter pipeline.
AddIncomingGrainCallFilter(IClientBuilder, IncomingGrainCallFilterDelegate)	Adds an IIncomingGrainCallFilter to the filter pipeline via a delegate.
AddIncomingGrainCallFilter<TImplementation>(IClientBuilder)	Adds an IIncomingGrainCallFilter to the filter pipeline.
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.
AddMemoryStreams(IClientBuilder, String, Action<IClusterClientMemoryStreamConfigurator>)	Adds a new in-memory stream provider to the client, using the default message serializer (DefaultMemoryMessageBodySerializer).
AddMemoryStreams<TSerializer>(IClientBuilder, String, Action<IClusterClientMemoryStreamConfigurator>)	Adds a new in-memory stream provider to the client.
AddPersistentStreams(IClientBuilder, String, Func<IServiceProvider,String,IQueueAdapterFactory>, Action<IClusterClientPersistentStreamConfigurator>)	Adds a new persistent streams provider to the client.
AddStreaming(IClientBuilder)	Adds support for streaming to this client.
UseConsulClientClustering(IClientBuilder, Action<OptionsBuilder<ConsulClusteringOptions>>)	Configures the client to use Consul for clustering.
UseConsulClientClustering(IClientBuilder, Action<ConsulClusteringOptions>)	Configures the client to use Consul 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.
AddStreamFilter<T>(IClientBuilder, String)	Adds a stream filter.
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.
UseUnixSocketConnection(IClientBuilder)