OrleansClientGenericHostExtensions.UseOrleansClient Method

Definition

Namespace:

Microsoft.Extensions.Hosting

Assembly:

Orleans.Core.dll

Package:

Microsoft.Orleans.Core v8.0.0

Overloads

UseOrleansClient(HostApplicationBuilder, 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, 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 HostApplicationBuilder

Parameters

hostAppBuilder

HostApplicationBuilder

The host app builder.

configureDelegate

Action<IClientBuilder>

The delegate used to configure the client.

Returns

HostApplicationBuilder

The host builder.

Exceptions

ArgumentNullException

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.

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 IHostBuilder

Parameters

hostBuilder

IHostBuilder

The host builder.

configureDelegate

Action<HostBuilderContext,IClientBuilder>

The delegate used to configure the client.

Returns

IHostBuilder

The host builder.

Exceptions

ArgumentNullException

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.

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 IHostBuilder

Parameters

hostBuilder

IHostBuilder

The host builder.

configureDelegate

Action<IClientBuilder>

The delegate used to configure the client.

Returns

IHostBuilder

The host builder.

Exceptions

ArgumentNullException

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.