OrleansClientGenericHostExtensions.UseOrleansClient Method
Definition
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.
Overloads
| UseOrleansClient(HostApplicationBuilder) |
Configures the host app builder to host an Orleans client. |
| UseOrleansClient(IHostApplicationBuilder) | |
| UseOrleansClient(IHostBuilder) |
Configures the host builder to host an Orleans client. |
| UseOrleansClient(HostApplicationBuilder, Action<IClientBuilder>) |
Configures the host app builder to host an Orleans client. |
| UseOrleansClient(IHostApplicationBuilder, Action<IClientBuilder>) |
Configures the host app builder to host an Orleans client. |
| UseOrleansClient(IHostBuilder, Action<HostBuilderContext,IClientBuilder>) |
Configures the host builder to host an Orleans client. |
| UseOrleansClient(IHostBuilder, Action<IClientBuilder>) |
Configures the host builder to host an Orleans client. |
UseOrleansClient(HostApplicationBuilder)
Configures the host app builder to host an Orleans client.
public static Microsoft.Extensions.Hosting.HostApplicationBuilder UseOrleansClient (this Microsoft.Extensions.Hosting.HostApplicationBuilder hostAppBuilder);static member UseOrleansClient : Microsoft.Extensions.Hosting.HostApplicationBuilder -> Microsoft.Extensions.Hosting.HostApplicationBuilder<Extension()>
Public Function UseOrleansClient (hostAppBuilder As HostApplicationBuilder) As HostApplicationBuilderParameters
- hostAppBuilder
- HostApplicationBuilder
The host app builder.
Returns
The host builder.
Exceptions
hostAppBuilder was null.
Remarks
Calling this method multiple times on the same IClientBuilder instance will result in one client being configured. Note that this method shouldn't be used in conjunction with HostApplicationBuilder.UseOrleans, since UseOrleans includes a client automatically.
Applies to
UseOrleansClient(IHostApplicationBuilder)
public static Microsoft.Extensions.Hosting.IHostApplicationBuilder UseOrleansClient (this Microsoft.Extensions.Hosting.IHostApplicationBuilder hostAppBuilder);static member UseOrleansClient : Microsoft.Extensions.Hosting.IHostApplicationBuilder -> Microsoft.Extensions.Hosting.IHostApplicationBuilder<Extension()>
Public Function UseOrleansClient (hostAppBuilder As IHostApplicationBuilder) As IHostApplicationBuilderParameters
- hostAppBuilder
- IHostApplicationBuilder
The host app builder.
Returns
The host builder.
Exceptions
hostAppBuilder was null.
Remarks
Calling this method multiple times on the same IClientBuilder instance will result in one client being configured. Note that this method shouldn't be used in conjunction with IHostApplicationBuilder.UseOrleans, since UseOrleans includes a client automatically.
Applies to
UseOrleansClient(IHostBuilder)
Configures the host builder to host an Orleans client.
public static Microsoft.Extensions.Hosting.IHostBuilder UseOrleansClient (this Microsoft.Extensions.Hosting.IHostBuilder hostBuilder);static member UseOrleansClient : Microsoft.Extensions.Hosting.IHostBuilder -> Microsoft.Extensions.Hosting.IHostBuilder<Extension()>
Public Function UseOrleansClient (hostBuilder As IHostBuilder) As IHostBuilderParameters
- hostBuilder
- IHostBuilder
The host builder.
Returns
The host builder.
Exceptions
hostBuilder was null.
Remarks
Calling this method multiple times on the same IClientBuilder instance will result in one client being configured. Note that this method should not be used in conjunction with IHostBuilder.UseOrleans, since UseOrleans includes a client automatically.
Applies to
UseOrleansClient(HostApplicationBuilder, Action<IClientBuilder>)
Configures the host app builder to host an Orleans client.
public static Microsoft.Extensions.Hosting.HostApplicationBuilder UseOrleansClient (this Microsoft.Extensions.Hosting.HostApplicationBuilder hostAppBuilder, Action<Orleans.Hosting.IClientBuilder> configureDelegate);static member UseOrleansClient : Microsoft.Extensions.Hosting.HostApplicationBuilder * Action<Orleans.Hosting.IClientBuilder> -> Microsoft.Extensions.Hosting.HostApplicationBuilder<Extension()>
Public Function UseOrleansClient (hostAppBuilder As HostApplicationBuilder, configureDelegate As Action(Of IClientBuilder)) As HostApplicationBuilderParameters
- hostAppBuilder
- HostApplicationBuilder
The host app builder.
- configureDelegate
- Action<IClientBuilder>
The delegate used to configure the client.
Returns
The host builder.
Exceptions
hostAppBuilder was null or configureDelegate was null.
Remarks
Calling this method multiple times on the same IClientBuilder instance will result in one client being configured. However, the effects of configureDelegate will be applied once for each call. Note that this method shouldn't be used in conjunction with HostApplicationBuilder.UseOrleans, since UseOrleans includes a client automatically.
Applies to
UseOrleansClient(IHostApplicationBuilder, Action<IClientBuilder>)
Configures the host app builder to host an Orleans client.
public static Microsoft.Extensions.Hosting.IHostApplicationBuilder UseOrleansClient (this Microsoft.Extensions.Hosting.IHostApplicationBuilder hostAppBuilder, Action<Orleans.Hosting.IClientBuilder> configureDelegate);static member UseOrleansClient : Microsoft.Extensions.Hosting.IHostApplicationBuilder * Action<Orleans.Hosting.IClientBuilder> -> Microsoft.Extensions.Hosting.IHostApplicationBuilder<Extension()>
Public Function UseOrleansClient (hostAppBuilder As IHostApplicationBuilder, configureDelegate As Action(Of IClientBuilder)) As IHostApplicationBuilderParameters
- hostAppBuilder
- IHostApplicationBuilder
The host app builder.
- configureDelegate
- Action<IClientBuilder>
The delegate used to configure the client.
Returns
The host builder.
Exceptions
hostAppBuilder was null or configureDelegate was null.
Remarks
Calling this method multiple times on the same IClientBuilder instance will result in one client being configured. However, the effects of configureDelegate will be applied once for each call. Note that this method shouldn't be used in conjunction with IHostApplicationBuilder.UseOrleans, since UseOrleans includes a client automatically.
Applies to
UseOrleansClient(IHostBuilder, Action<HostBuilderContext,IClientBuilder>)
Configures the host builder to host an Orleans client.
public static Microsoft.Extensions.Hosting.IHostBuilder UseOrleansClient (this Microsoft.Extensions.Hosting.IHostBuilder hostBuilder, Action<Microsoft.Extensions.Hosting.HostBuilderContext,Orleans.Hosting.IClientBuilder> configureDelegate);static member UseOrleansClient : Microsoft.Extensions.Hosting.IHostBuilder * Action<Microsoft.Extensions.Hosting.HostBuilderContext, Orleans.Hosting.IClientBuilder> -> Microsoft.Extensions.Hosting.IHostBuilder<Extension()>
Public Function UseOrleansClient (hostBuilder As IHostBuilder, configureDelegate As Action(Of HostBuilderContext, IClientBuilder)) As IHostBuilderParameters
- hostBuilder
- IHostBuilder
The host builder.
- configureDelegate
- Action<HostBuilderContext,IClientBuilder>
The delegate used to configure the client.
Returns
The host builder.
Exceptions
hostBuilder was null or configureDelegate was null.
Remarks
Calling this method multiple times on the same IClientBuilder instance will result in one client being configured. However, the effects of configureDelegate will be applied once for each call. Note that this method should not be used in conjunction with IHostBuilder.UseOrleans, since UseOrleans includes a client automatically.
Applies to
UseOrleansClient(IHostBuilder, Action<IClientBuilder>)
Configures the host builder to host an Orleans client.
public static Microsoft.Extensions.Hosting.IHostBuilder UseOrleansClient (this Microsoft.Extensions.Hosting.IHostBuilder hostBuilder, Action<Orleans.Hosting.IClientBuilder> configureDelegate);static member UseOrleansClient : Microsoft.Extensions.Hosting.IHostBuilder * Action<Orleans.Hosting.IClientBuilder> -> Microsoft.Extensions.Hosting.IHostBuilder<Extension()>
Public Function UseOrleansClient (hostBuilder As IHostBuilder, configureDelegate As Action(Of IClientBuilder)) As IHostBuilderParameters
- hostBuilder
- IHostBuilder
The host builder.
- configureDelegate
- Action<IClientBuilder>
The delegate used to configure the client.
Returns
The host builder.
Exceptions
hostBuilder was null or configureDelegate was null.
Remarks
Calling this method multiple times on the same IClientBuilder instance will result in one client being configured. However, the effects of configureDelegate will be applied once for each call. Note that this method should not be used in conjunction with IHostBuilder.UseOrleans, since UseOrleans includes a client automatically.