ISiloHostBuilder Interface

Definition

Namespace:

Orleans.Hosting

Assembly:

Orleans.Runtime.Abstractions.dll

Package:

Microsoft.Orleans.Runtime.Abstractions v3.6.5

Functionality for building ISiloHost instances.

public interface ISiloHostBuilder

type ISiloHostBuilder = interface

Public Interface ISiloHostBuilder

Derived

Orleans.Hosting.SiloHostBuilder

Properties

Properties

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

Methods

Build()	Run the given actions to initialize the host. This can only be called once.
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, as well as in Services.
ConfigureContainer<TContainerBuilder>(Action<HostBuilderContext,TContainerBuilder>)	Enables configuring the instantiated dependency container. This can be called multiple times and the results will be additive.
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>)	Overrides the factory used to create the service provider.

Extension Methods

AddProviderClusterOptions(ISiloHostBuilder, 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(ISiloHostBuilder, 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(ISiloHostBuilder, Action<OptionsBuilder<AdoNetClusteringSiloOptions>>)	Configures this silo to use ADO.NET for clustering. Instructions on configuring your database are available at http://aka.ms/orleans-sql-scripts.
UseAdoNetClustering(ISiloHostBuilder, Action<AdoNetClusteringSiloOptions>)	Configures this silo to use ADO.NET for clustering. Instructions on configuring your database are available at http://aka.ms/orleans-sql-scripts.
AddApplicationInsightsTelemetryConsumer(ISiloHostBuilder, String)	Adds a metrics telemetric consumer provider of type AITelemetryConsumer.
UseDynamoDBClustering(ISiloHostBuilder, Action<OptionsBuilder<DynamoDBClusteringOptions>>)	Configures the silo to use DynamoDB for clustering.
UseDynamoDBClustering(ISiloHostBuilder, Action<DynamoDBClusteringOptions>)	Configures the silo to use DynamoDB for clustering.
AddAzureBlobGrainStorage(ISiloHostBuilder, String, Action<OptionsBuilder<AzureBlobStorageOptions>>)	Configure silo to use azure blob storage for grain storage.
AddAzureBlobGrainStorage(ISiloHostBuilder, String, Action<AzureBlobStorageOptions>)	Configure silo to use azure blob storage for grain storage.
AddAzureBlobGrainStorageAsDefault(ISiloHostBuilder, Action<OptionsBuilder<AzureBlobStorageOptions>>)	Configure silo to use azure blob storage as the default grain storage.
AddAzureBlobGrainStorageAsDefault(ISiloHostBuilder, Action<AzureBlobStorageOptions>)	Configure silo to use azure blob storage as the default grain storage.
UseAzureStorageClustering(ISiloHostBuilder, Action<OptionsBuilder<AzureStorageClusteringOptions>>)	Configures the silo to use Azure Storage for clustering.
UseAzureStorageClustering(ISiloHostBuilder, Action<AzureStorageClusteringOptions>)	Configures the silo to use Azure Storage for clustering.
AddAzureTableGrainDirectory(ISiloHostBuilder, String, Action<OptionsBuilder<AzureTableGrainDirectoryOptions>>)
AddAzureTableGrainDirectory(ISiloHostBuilder, String, Action<AzureTableGrainDirectoryOptions>)
UseAzureTableGrainDirectoryAsDefault(ISiloHostBuilder, Action<OptionsBuilder<AzureTableGrainDirectoryOptions>>)
UseAzureTableGrainDirectoryAsDefault(ISiloHostBuilder, Action<AzureTableGrainDirectoryOptions>)
AddAzureTableGrainStorage(ISiloHostBuilder, String, Action<OptionsBuilder<AzureTableStorageOptions>>)	Configure silo to use azure table storage for grain storage.
AddAzureTableGrainStorage(ISiloHostBuilder, String, Action<AzureTableStorageOptions>)	Configure silo to use azure table storage for grain storage.
AddAzureTableGrainStorageAsDefault(ISiloHostBuilder, Action<OptionsBuilder<AzureTableStorageOptions>>)	Configure silo to use azure table storage as the default grain storage.
AddAzureTableGrainStorageAsDefault(ISiloHostBuilder, Action<AzureTableStorageOptions>)	Configure silo to use azure table storage as the default grain storage.
AddAzureTableTransactionalStateStorage(ISiloHostBuilder, String, Action<OptionsBuilder<AzureTableTransactionalStateOptions>>)	Configure silo to use azure table storage for transactional grain storage.
AddAzureTableTransactionalStateStorage(ISiloHostBuilder, String, Action<AzureTableTransactionalStateOptions>)	Configure silo to use azure table storage for transactional grain storage.
AddAzureTableTransactionalStateStorageAsDefault(ISiloHostBuilder, Action<OptionsBuilder<AzureTableTransactionalStateOptions>>)	Configure silo to use azure table storage as the default transactional grain storage.
AddAzureTableTransactionalStateStorageAsDefault(ISiloHostBuilder, Action<AzureTableTransactionalStateOptions>)	Configure silo to use azure table storage as the default transactional grain storage.
UseConsulClustering(ISiloHostBuilder, Action<OptionsBuilder<ConsulClusteringSiloOptions>>)	Configures the silo to use Consul for clustering.
UseConsulClustering(ISiloHostBuilder, Action<ConsulClusteringSiloOptions>)	Configures the silo to use Consul for clustering.
ConfigureDefaults(ISiloHostBuilder)	Configure the container to use Orleans.
EnableDirectClient(ISiloHostBuilder)	Obsolete. Enables support for interacting with the runtime from an external context. For example, outside the context of a grain.
UseDevelopmentClustering(ISiloHostBuilder, Action<OptionsBuilder<DevelopmentClusterMembershipOptions>>)	Configures the silo to use development-only clustering.
UseDevelopmentClustering(ISiloHostBuilder, Action<DevelopmentClusterMembershipOptions>)	Configures the silo to use development-only clustering.
UseDevelopmentClustering(ISiloHostBuilder, IPEndPoint)	Configures the silo to use development-only clustering.
UseLocalhostClustering(ISiloHostBuilder, Int32, Int32, IPEndPoint, String, String)	Configures the silo to use development-only clustering and listen on localhost.
AddCustomStorageBasedLogConsistencyProvider(ISiloHostBuilder, String, String)	Adds a custom storage log consistency provider"/>
AddCustomStorageBasedLogConsistencyProviderAsDefault(ISiloHostBuilder, String)	Adds a custom storage log consistency provider as default consistency provider"/>
AddEventDataGeneratorStreams(ISiloHostBuilder, String, Action<IEventDataGeneratorStreamConfigurator>)	Configure silo to use event data generator streams.
AddDynamoDBGrainStorage(ISiloHostBuilder, String, Action<OptionsBuilder<DynamoDBStorageOptions>>)	Configure silo to use AWS DynamoDB storage for grain storage.
AddDynamoDBGrainStorage(ISiloHostBuilder, String, Action<DynamoDBStorageOptions>)	Configure silo to use AWS DynamoDB storage for grain storage.
AddDynamoDBGrainStorageAsDefault(ISiloHostBuilder, Action<OptionsBuilder<DynamoDBStorageOptions>>)	Configure silo to use AWS DynamoDB storage as the default grain storage.
AddDynamoDBGrainStorageAsDefault(ISiloHostBuilder, Action<DynamoDBStorageOptions>)	Configure silo to use AWS DynamoDB storage as the default grain storage.
ConfigureEndpoints(ISiloHostBuilder, Int32, Int32, AddressFamily, Boolean)	Configure endpoints for the silo.
ConfigureEndpoints(ISiloHostBuilder, IPAddress, Int32, Int32, Boolean)	Configure endpoints for the silo.
ConfigureEndpoints(ISiloHostBuilder, String, Int32, Int32, AddressFamily, Boolean)	Configure endpoints for the silo.
AddGrainService<T>(ISiloHostBuilder)	Registers an application grain service to be started with the silo.
AddGrainExtension<TExtensionInterface,TExtension>(ISiloHostBuilder)	Registers a grain extension implementation for the specified interface.
AddLogStorageBasedLogConsistencyProvider(ISiloHostBuilder, String)	Adds a log storage log consistency provider"/>
AddLogStorageBasedLogConsistencyProviderAsDefault(ISiloHostBuilder)	Adds a log storage log consistency provider as default consistency provider"/>
AddMemoryGrainStorage(ISiloHostBuilder, String, Action<OptionsBuilder<MemoryGrainStorageOptions>>)	Configure silo to use memory grain storage as the default grain storage.
AddMemoryGrainStorage(ISiloHostBuilder, String, Action<MemoryGrainStorageOptions>)	Configure silo to use memory grain storage as the default grain storage.
AddMemoryGrainStorageAsDefault(ISiloHostBuilder, Action<OptionsBuilder<MemoryGrainStorageOptions>>)	Configure silo to use memory grain storage as the default grain storage.
AddMemoryGrainStorageAsDefault(ISiloHostBuilder, Action<MemoryGrainStorageOptions>)	Configure silo to use memory grain storage as the default grain storage.
AddNewRelicTelemetryConsumer(ISiloHostBuilder)	Adds a metrics telemetric consumer provider of type NRTelemetryConsumer.
UseTls(ISiloHostBuilder, Action<TlsOptions>)	Configures TLS.
UseTls(ISiloHostBuilder, StoreName, String, Boolean, StoreLocation, Action<TlsOptions>)	Configures TLS.
UseTls(ISiloHostBuilder, X509Certificate2)	Configures TLS.
UseTls(ISiloHostBuilder, X509Certificate2, Action<TlsOptions>)	Configures TLS.
AddPerfCountersTelemetryConsumer(ISiloHostBuilder)	Adds a metrics telemetric consumer provider of type OrleansPerfCounterTelemetryConsumer.
AddPlacementDirector<TStrategy>(ISiloHostBuilder, Func<IServiceProvider,IPlacementDirector>)	Adds a placement director.
AddPlacementDirector<TStrategy,TDirector>(ISiloHostBuilder)	Configures a TDirector as the placement director for placement strategy TStrategy.
AddRedisGrainDirectory(ISiloHostBuilder, String, Action<OptionsBuilder<RedisGrainDirectoryOptions>>)	Add a Redis data-store as a named Grain Directory
AddRedisGrainDirectory(ISiloHostBuilder, String, Action<RedisGrainDirectoryOptions>)	Add a Redis data-store as a named Grain Directory
UseRedisGrainDirectoryAsDefault(ISiloHostBuilder, Action<OptionsBuilder<RedisGrainDirectoryOptions>>)	Use a Redis data-store as the default Grain Directory
UseRedisGrainDirectoryAsDefault(ISiloHostBuilder, Action<RedisGrainDirectoryOptions>)	Use a Redis data-store as the default Grain Directory
AddAdoNetGrainStorage(ISiloHostBuilder, String, Action<OptionsBuilder<AdoNetGrainStorageOptions>>)	Configure silo to use AdoNet grain storage for grain storage. Instructions on configuring your database are available at http://aka.ms/orleans-sql-scripts.
AddAdoNetGrainStorage(ISiloHostBuilder, String, Action<AdoNetGrainStorageOptions>)	Configure silo to use AdoNet grain storage for grain storage. Instructions on configuring your database are available at http://aka.ms/orleans-sql-scripts.
AddAdoNetGrainStorageAsDefault(ISiloHostBuilder, Action<OptionsBuilder<AdoNetGrainStorageOptions>>)	Configure silo to use AdoNet grain storage as the default grain storage. Instructions on configuring your database are available at http://aka.ms/orleans-sql-scripts.
AddAdoNetGrainStorageAsDefault(ISiloHostBuilder, Action<AdoNetGrainStorageOptions>)	Configure silo to use AdoNet grain storage as the default grain storage. Instructions on configuring your database are available at http://aka.ms/orleans-sql-scripts.
AddAzureQueueStreams(ISiloHostBuilder, String, Action<OptionsBuilder<AzureQueueOptions>>)	Configure silo to use azure queue persistent streams with default settings
AddAzureQueueStreams(ISiloHostBuilder, String, Action<SiloAzureQueueStreamConfigurator>)	Configure silo to use azure queue persistent streams.
AddEventHubStreams(ISiloHostBuilder, String, Action<EventHubOptions>, Action<AzureTableStreamCheckpointerOptions>)	Configure silo to use event hub persistent streams with default check pointer and other settings
AddEventHubStreams(ISiloHostBuilder, String, Action<ISiloEventHubStreamConfigurator>)	Configure silo to use event hub persistent streams.
AddSqsStreams(ISiloHostBuilder, String, Action<SqsOptions>)	Configure silo to use SQS persistent streams.
AddSqsStreams(ISiloHostBuilder, String, Action<SiloSqsStreamConfigurator>)	Configure silo to use SQS persistent streams.
UseAzureBlobLeaseProvider(ISiloHostBuilder, Action<OptionsBuilder<AzureBlobLeaseProviderOptions>>)	Configure silo to use azure blob lease provider
UseTransactions(ISiloHostBuilder, Boolean)	Configure cluster to use the distributed TM algorithm
AddMemoryStreams<TSerializer>(ISiloHostBuilder, String, Action<ISiloMemoryStreamConfigurator>)	Configure silo to use memory streams.
AddStartupTask(ISiloHostBuilder, IStartupTask, Int32)	Adds a startup task to be executed when the silo has started.
AddStartupTask(ISiloHostBuilder, Func<IServiceProvider,CancellationToken,Task>, Int32)	Adds a startup task to be executed when the silo has started.
AddStartupTask<TStartup>(ISiloHostBuilder, Int32)	Adds a startup task to be executed when the silo has started.
Configure<TOptions>(ISiloHostBuilder, IConfiguration)	Registers a configuration instance which TOptions will bind against.
Configure<TOptions>(ISiloHostBuilder, Action<TOptions>)	Registers an action used to configure a particular type of options.
ConfigureAppConfiguration(ISiloHostBuilder, 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, as well as in Services.
ConfigureApplicationParts(ISiloHostBuilder, Action<IApplicationPartManager>)	Configures the ApplicationPartManager using the given Action<T>.
ConfigureLogging(ISiloHostBuilder, Action<ILoggingBuilder>)	Adds a delegate for configuring the provided ILoggingBuilder. This may be called multiple times.
ConfigureLogging(ISiloHostBuilder, Action<HostBuilderContext,ILoggingBuilder>)	Adds a delegate for configuring the provided ILoggingBuilder. This may be called multiple times.
ConfigureServices(ISiloHostBuilder, Action<IServiceCollection>)	Adds services to the container. This can be called multiple times and the results will be additive.
GetApplicationPartManager(ISiloHostBuilder)	Returns the ApplicationPartManager for this instance.
UseEnvironment(ISiloHostBuilder, String)	Specify the environment to be used by the host.
UseServiceProviderFactory(ISiloHostBuilder, Func<IServiceCollection,IServiceProvider>)	Specifies how the IServiceProvider for this silo is configured.
AddIncomingGrainCallFilter(ISiloHostBuilder, IIncomingGrainCallFilter)	Adds an IIncomingGrainCallFilter to the filter pipeline.
AddIncomingGrainCallFilter(ISiloHostBuilder, IncomingGrainCallFilterDelegate)	Adds an IOutgoingGrainCallFilter to the filter pipeline via a delegate.
AddIncomingGrainCallFilter<TImplementation>(ISiloHostBuilder)	Adds an IIncomingGrainCallFilter to the filter pipeline.
AddOutgoingGrainCallFilter(ISiloHostBuilder, IOutgoingGrainCallFilter)	Adds an IOutgoingGrainCallFilter to the filter pipeline.
AddOutgoingGrainCallFilter(ISiloHostBuilder, OutgoingGrainCallFilterDelegate)	Adds an IOutgoingGrainCallFilter to the filter pipeline via a delegate.
AddOutgoingGrainCallFilter<TImplementation>(ISiloHostBuilder)	Adds an IOutgoingGrainCallFilter to the filter pipeline.
UseAdoNetReminderService(ISiloHostBuilder, Action<OptionsBuilder<AdoNetReminderTableOptions>>)	Adds reminder storage using ADO.NET. Instructions on configuring your database are available at http://aka.ms/orleans-sql-scripts.
UseAdoNetReminderService(ISiloHostBuilder, Action<AdoNetReminderTableOptions>)	Adds reminder storage using ADO.NET. Instructions on configuring your database are available at http://aka.ms/orleans-sql-scripts.
UseDynamoDBReminderService(ISiloHostBuilder, Action<DynamoDBReminderStorageOptions>)	Adds reminder storage backed by Amazon DynamoDB.
UseInMemoryReminderService(ISiloHostBuilder)	Configures reminder storage using an in-memory, non-persistent store.
AddStateStorageBasedLogConsistencyProvider(ISiloHostBuilder, String)	Adds a state storage log consistency provider"/>
AddStateStorageBasedLogConsistencyProviderAsDefault(ISiloHostBuilder)	Adds a state storage log consistency provider as default consistency provider"/>
AddPersistentStreams(ISiloHostBuilder, String, Func<IServiceProvider,String,IQueueAdapterFactory>, Action<ISiloPersistentStreamConfigurator>)	Configure silo to use persistent streams.
AddSimpleMessageStreamProvider(ISiloHostBuilder, String, Action<OptionsBuilder<SimpleMessageStreamProviderOptions>>)	Configure silo to use SimpleMessageProvider
AddSimpleMessageStreamProvider(ISiloHostBuilder, String, Action<SimpleMessageStreamProviderOptions>)	Configure silo to use SimpleMessageProvider
AddSimpleMessageStreamProvider(ISiloHostBuilder, String, Action<ISimpleMessageStreamConfigurator>)	Configure silo to use SimpleMessageProvider
UseZooKeeperClustering(ISiloHostBuilder, Action<OptionsBuilder<ZooKeeperClusteringSiloOptions>>)	Configures the silo to use ZooKeeper for cluster membership.
UseZooKeeperClustering(ISiloHostBuilder, Action<ZooKeeperClusteringSiloOptions>)	Configures the silo to use ZooKeeper for cluster membership.
UseInMemoryLeaseProvider(ISiloHostBuilder)	Configure silo with test/development features. NOT FOR PRODUCTION USE - dev/test only
UseSiloUnobservedExceptionsHandler(ISiloHostBuilder)	Configure silo with unobserved exception handler
UseLinuxEnvironmentStatistics(ISiloHostBuilder)	Use Linux host environment statistics
UsePerfCounterEnvironmentStatistics(ISiloHostBuilder)	Use Windows performance counters as source for host environment statistics
AddFaultInjectionMemoryStorage(ISiloHostBuilder, String, Action<OptionsBuilder<MemoryGrainStorageOptions>>, Action<OptionsBuilder<FaultInjectionGrainStorageOptions>>)	Configure silo to use FaultInjectionMemoryStorage
AddFaultInjectionMemoryStorage(ISiloHostBuilder, String, Action<MemoryGrainStorageOptions>, Action<FaultInjectionGrainStorageOptions>)	Configure silo to use FaultInjectionMemoryStorage
GetConfiguration(ISiloHostBuilder)
GetConfigurationValue(ISiloHostBuilder, String)
GetTestClusterOptions(ISiloHostBuilder)
AddFaultInjectionAzureTableTransactionalStateStorage(ISiloHostBuilder, Action<AzureTableTransactionalStateOptions>)
AddFaultInjectionAzureTableTransactionalStateStorage(ISiloHostBuilder, String, Action<AzureTableTransactionalStateOptions>)
UseControlledFaultInjectionTransactionState(ISiloHostBuilder)	Configure cluster to use the distributed TM algorithm