Skip to content
Orleans logoMicrosoft Orleans

OrleansClientGenericHostExtensions Methods

Extension methods for Microsoft.Extensions.Hosting.IHostBuilder.

AddOrleansClient(IServiceCollection, Action<IClientBuilder>)

staticextension
View source
public static IServiceCollection AddOrleansClient(this IServiceCollection services, Action<IClientBuilder> configureDelegate)
Configures the service collection to host an Orleans client.

Parameters

servicesIServiceCollection
The service collection.
configureDelegateAction<IClientBuilder>
The delegate used to configure the client.

Returns

The service collection.

Exceptions

System.ArgumentNullException
services was null or configureDelegate was null.

AddOrleansClient(IServiceCollection, IConfiguration, Action<IClientBuilder>)

staticextension
View source
public static IServiceCollection AddOrleansClient(this IServiceCollection services, IConfiguration configuration, Action<IClientBuilder> configureDelegate)
Configures the service collection to host an Orleans client.

Parameters

servicesIServiceCollection
The service collection.
configurationIConfiguration
The configuration.
configureDelegateAction<IClientBuilder>
The delegate used to configure the client.

Returns

The service collection.

Exceptions

System.ArgumentNullException
services was null or configureDelegate was null.

UseOrleansClient(HostApplicationBuilder)

staticextension
View source
public static HostApplicationBuilder UseOrleansClient(this HostApplicationBuilder hostAppBuilder)
Configures the host app builder to host an Orleans client.

Parameters

hostAppBuilderHostApplicationBuilder
The host app builder.

Returns

The host builder.

Exceptions

System.ArgumentNullException
hostAppBuilder was null.

UseOrleansClient(HostApplicationBuilder, Action<IClientBuilder>)

staticextension
View source
public static HostApplicationBuilder UseOrleansClient(this HostApplicationBuilder hostAppBuilder, Action<IClientBuilder> configureDelegate)
Configures the host app builder to host an Orleans client.

Parameters

hostAppBuilderHostApplicationBuilder
The host app builder.
configureDelegateAction<IClientBuilder>
The delegate used to configure the client.

Returns

The host builder.

Exceptions

System.ArgumentNullException
hostAppBuilder was null or configureDelegate was null.

UseOrleansClient(IHostApplicationBuilder)

staticextension
View source
public static IHostApplicationBuilder UseOrleansClient(this IHostApplicationBuilder hostAppBuilder)

Parameters

hostAppBuilderIHostApplicationBuilder
The host app builder.

Returns

The host builder.

Exceptions

System.ArgumentNullException
hostAppBuilder was null.

UseOrleansClient(IHostApplicationBuilder, Action<IClientBuilder>)

staticextension
View source
public static IHostApplicationBuilder UseOrleansClient(this IHostApplicationBuilder hostAppBuilder, Action<IClientBuilder> configureDelegate)
Configures the host app builder to host an Orleans client.

Parameters

hostAppBuilderIHostApplicationBuilder
The host app builder.
configureDelegateAction<IClientBuilder>
The delegate used to configure the client.

Returns

The host builder.

Exceptions

System.ArgumentNullException
hostAppBuilder was null or configureDelegate was null.

UseOrleansClient(IHostBuilder)

staticextension
View source
public static IHostBuilder UseOrleansClient(this IHostBuilder hostBuilder)
Configures the host builder to host an Orleans client.

Parameters

hostBuilderIHostBuilder
The host builder.

Returns

The host builder.

Exceptions

System.ArgumentNullException
hostBuilder was null.

UseOrleansClient(IHostBuilder, Action<HostBuilderContext, IClientBuilder>)

staticextension
View source
public static IHostBuilder UseOrleansClient(this IHostBuilder hostBuilder, Action<HostBuilderContext, IClientBuilder> configureDelegate)
Configures the host builder to host an Orleans client.

Parameters

hostBuilderIHostBuilder
The host builder.
configureDelegateAction<HostBuilderContext, IClientBuilder>
The delegate used to configure the client.

Returns

The host builder.

Exceptions

System.ArgumentNullException
hostBuilder was null or configureDelegate was null.

UseOrleansClient(IHostBuilder, Action<IClientBuilder>)

staticextension
View source
public static IHostBuilder UseOrleansClient(this IHostBuilder hostBuilder, Action<IClientBuilder> configureDelegate)
Configures the host builder to host an Orleans client.

Parameters

hostBuilderIHostBuilder
The host builder.
configureDelegateAction<IClientBuilder>
The delegate used to configure the client.

Returns

The host builder.

Exceptions

System.ArgumentNullException
hostBuilder was null or configureDelegate was null.