OrleansServiceExtensions Methods
Class Methods 26 members
Extensions to
Hosting.IDistributedApplicationBuilder related to Orleans. AddOrleans(IDistributedApplicationBuilder, string) Section titled AddOrleans(IDistributedApplicationBuilder, string) extension OrleansService Adds an Orleans service to the application.
public static class OrleansServiceExtensions{ public static OrleansService AddOrleans( this IDistributedApplicationBuilder builder, string name) { // ... }}Parameters
builder IDistributedApplicationBuilder The application builder. name string The name of the Orleans service. Returns
OrleansService The Orleans service builder. Returns a model of the clients of an Orleans service.
public static class OrleansServiceExtensions{ public static OrleansServiceClient AsClient( this OrleansService orleansService) { // ... }}Parameters
orleansService OrleansService The Orleans service Returns
OrleansServiceClient A model of the clients of an Orleans service. WithBroadcastChannel(OrleansService, string, IProviderConfiguration) Section titled WithBroadcastChannel(OrleansService, string, IProviderConfiguration) extension OrleansService Adds a broadcast channel provider to the Orleans service.
public static class OrleansServiceExtensions{ public static OrleansService WithBroadcastChannel( this OrleansService orleansServiceBuilder, string name, IProviderConfiguration provider) { // ... }}Parameters
orleansServiceBuilder OrleansService The target Orleans service builder. name string The name of the provider. This is the name the application will use to resolve the provider. provider IProviderConfiguration The provider to add. Returns
OrleansService >The Orleans service builder. WithBroadcastChannel(OrleansService, string) Section titled WithBroadcastChannel(OrleansService, string) extension OrleansService Adds a broadcast channel provider to the Orleans service.
public static class OrleansServiceExtensions{ public static OrleansService WithBroadcastChannel( this OrleansService orleansServiceBuilder, string name) { // ... }}Parameters
orleansServiceBuilder OrleansService The target Orleans service builder. name string The name of the provider. This is the name the application will use to resolve the provider. Returns
OrleansService >The Orleans service builder. WithClusterId(OrleansService, string) Section titled WithClusterId(OrleansService, string) extension OrleansService Sets the ClusterId of the Orleans service.
public static class OrleansServiceExtensions{ public static OrleansService WithClusterId( this OrleansService orleansServiceBuilder, string clusterId) { // ... }}Parameters
orleansServiceBuilder OrleansService The target Orleans service builder. clusterId string The ClusterId value. Returns
OrleansService >The Orleans service builder. WithClusterId(OrleansService, IResourceBuilder<ParameterResource>) Section titled WithClusterId(OrleansService, IResourceBuilder<ParameterResource>) extension OrleansService Sets the ClusterId of the Orleans service.
public static class OrleansServiceExtensions{ public static OrleansService WithClusterId( this OrleansService orleansServiceBuilder, IResourceBuilder<ParameterResource> clusterId) { // ... }}Parameters
orleansServiceBuilder OrleansService The target Orleans service builder. clusterId IResourceBuilder<ParameterResource> The ClusterId value. Returns
OrleansService >The Orleans service builder. WithClustering(OrleansService, IResourceBuilder<IResourceWithConnectionString>) Section titled WithClustering(OrleansService, IResourceBuilder<IResourceWithConnectionString>) extension OrleansService Configures the Orleans service to use the provided clustering provider.
public static class OrleansServiceExtensions{ public static OrleansService WithClustering( this OrleansService orleansServiceBuilder, IResourceBuilder<IResourceWithConnectionString> provider) { // ... }}Parameters
orleansServiceBuilder OrleansService The target Orleans service builder. provider IResourceBuilder<IResourceWithConnectionString> The provider. Returns
OrleansService >The Orleans service builder. WithClustering(OrleansService, IProviderConfiguration) Section titled WithClustering(OrleansService, IProviderConfiguration) extension OrleansService Configures the Orleans service to use the provided clustering provider.
public static class OrleansServiceExtensions{ public static OrleansService WithClustering( this OrleansService orleansServiceBuilder, IProviderConfiguration provider) { // ... }}Parameters
orleansServiceBuilder OrleansService The target Orleans service builder. provider IProviderConfiguration The provider. Returns
OrleansService >The Orleans service builder. WithDevelopmentClustering(OrleansService) Section titled WithDevelopmentClustering(OrleansService) extension OrleansService Configures the Orleans service to use development-only clustering.
public static class OrleansServiceExtensions{ public static OrleansService WithDevelopmentClustering( this OrleansService orleansServiceBuilder) { // ... }}Parameters
orleansServiceBuilder OrleansService The target Orleans service builder. Returns
OrleansService >The Orleans service builder. WithGrainDirectory(OrleansService, IResourceBuilder<IResourceWithConnectionString>) Section titled WithGrainDirectory(OrleansService, IResourceBuilder<IResourceWithConnectionString>) extension OrleansService Adds a grain directory provider to the Orleans service.
public static class OrleansServiceExtensions{ public static OrleansService WithGrainDirectory( this OrleansService orleansServiceBuilder, IResourceBuilder<IResourceWithConnectionString> provider) { // ... }}Parameters
orleansServiceBuilder OrleansService The target Orleans service builder. provider IResourceBuilder<IResourceWithConnectionString> The provider to add. Returns
OrleansService >The Orleans service builder. Remarks
This resource name is the name the application will use to resolve the provider.
WithGrainDirectory(OrleansService, string, IResourceBuilder<IResourceWithConnectionString>) Section titled WithGrainDirectory(OrleansService, string, IResourceBuilder<IResourceWithConnectionString>) extension OrleansService Adds a grain directory provider to the Orleans service.
public static class OrleansServiceExtensions{ public static OrleansService WithGrainDirectory( this OrleansService orleansServiceBuilder, string name, IResourceBuilder<IResourceWithConnectionString> provider) { // ... }}Parameters
orleansServiceBuilder OrleansService The target Orleans service builder. name string The name of the provider. This is the name the application will use to resolve the provider. provider IResourceBuilder<IResourceWithConnectionString> The provider to add. Returns
OrleansService >The Orleans service builder. WithGrainDirectory(OrleansService, string, IProviderConfiguration) Section titled WithGrainDirectory(OrleansService, string, IProviderConfiguration) extension OrleansService Adds a grain directory provider to the Orleans service.
public static class OrleansServiceExtensions{ public static OrleansService WithGrainDirectory( this OrleansService orleansServiceBuilder, string name, IProviderConfiguration provider) { // ... }}Parameters
orleansServiceBuilder OrleansService The target Orleans service builder. name string The name of the provider. This is the name the application will use to resolve the provider. provider IProviderConfiguration The provider to add. Returns
OrleansService >The Orleans service builder. WithGrainStorage(OrleansService, IResourceBuilder<IResourceWithConnectionString>) Section titled WithGrainStorage(OrleansService, IResourceBuilder<IResourceWithConnectionString>) extension OrleansService Adds a grain storage provider to the Orleans service.
public static class OrleansServiceExtensions{ public static OrleansService WithGrainStorage( this OrleansService orleansServiceBuilder, IResourceBuilder<IResourceWithConnectionString> provider) { // ... }}Parameters
orleansServiceBuilder OrleansService The target Orleans service builder. provider IResourceBuilder<IResourceWithConnectionString> The provider to add. Returns
OrleansService >The Orleans service builder. Remarks
This resource name is the name the application will use to resolve the provider.
WithGrainStorage(OrleansService, string, IResourceBuilder<IResourceWithConnectionString>) Section titled WithGrainStorage(OrleansService, string, IResourceBuilder<IResourceWithConnectionString>) extension OrleansService Adds a grain storage provider to the Orleans service.
public static class OrleansServiceExtensions{ public static OrleansService WithGrainStorage( this OrleansService orleansServiceBuilder, string name, IResourceBuilder<IResourceWithConnectionString> provider) { // ... }}Parameters
orleansServiceBuilder OrleansService The target Orleans service builder. name string The name of the provider. This is the name the application will use to resolve the provider. provider IResourceBuilder<IResourceWithConnectionString> The provider to add. Returns
OrleansService >The Orleans service builder. WithGrainStorage(OrleansService, string, IProviderConfiguration) Section titled WithGrainStorage(OrleansService, string, IProviderConfiguration) extension OrleansService Adds a grain storage provider to the Orleans service.
public static class OrleansServiceExtensions{ public static OrleansService WithGrainStorage( this OrleansService orleansServiceBuilder, string name, IProviderConfiguration provider) { // ... }}Parameters
orleansServiceBuilder OrleansService The target Orleans service builder. name string The name of the provider. This is the name the application will use to resolve the provider. provider IProviderConfiguration The provider to add. Returns
OrleansService >The Orleans service builder. WithMemoryGrainStorage(OrleansService, string) Section titled WithMemoryGrainStorage(OrleansService, string) extension OrleansService Adds an in-memory grain storage to the Orleans service.
public static class OrleansServiceExtensions{ public static OrleansService WithMemoryGrainStorage( this OrleansService orleansServiceBuilder, string name) { // ... }}Parameters
orleansServiceBuilder OrleansService The target Orleans service builder. name string The name of the provider. This is the name the application will use to resolve the provider. Returns
OrleansService >The Orleans service builder. WithMemoryReminders(OrleansService) Section titled WithMemoryReminders(OrleansService) extension OrleansService Configures in-memory reminder storage for the Orleans service.
public static class OrleansServiceExtensions{ public static OrleansService WithMemoryReminders( this OrleansService orleansServiceBuilder) { // ... }}Parameters
orleansServiceBuilder OrleansService The target Orleans service builder. Returns
OrleansService >The Orleans service builder. WithMemoryStreaming(OrleansService, string) Section titled WithMemoryStreaming(OrleansService, string) extension OrleansService Adds an in-memory stream provider to the Orleans service.
public static class OrleansServiceExtensions{ public static OrleansService WithMemoryStreaming( this OrleansService orleansServiceBuilder, string name) { // ... }}Parameters
orleansServiceBuilder OrleansService The target Orleans service builder. name string The name of the provider. This is the name the application will use to resolve the provider. Returns
OrleansService >The Orleans service builder. WithReference(IResourceBuilder<T>, OrleansService) Section titled WithReference(IResourceBuilder<T>, OrleansService) extension IResourceBuilder<T> Adds Orleans to the resource.
public static class OrleansServiceExtensions{ public static IResourceBuilder<T> WithReference<T>( this IResourceBuilder<T> builder, OrleansService orleansService) { // ... }}Parameters
builder IResourceBuilder<T> The builder on which add the Orleans service builder. orleansService OrleansService The Orleans service, containing clustering, etc. Returns
IResourceBuilder<T> The resource builder. Exceptions
InvalidOperationException Clustering has not been configured. WithReminders(OrleansService, IResourceBuilder<IResourceWithConnectionString>) Section titled WithReminders(OrleansService, IResourceBuilder<IResourceWithConnectionString>) extension OrleansService Configures reminder storage for the Orleans service.
public static class OrleansServiceExtensions{ public static OrleansService WithReminders( this OrleansService orleansServiceBuilder, IResourceBuilder<IResourceWithConnectionString> provider) { // ... }}Parameters
orleansServiceBuilder OrleansService The target Orleans service builder. provider IResourceBuilder<IResourceWithConnectionString> The reminder storage provider. Returns
OrleansService >The Orleans service builder. WithReminders(OrleansService, IProviderConfiguration) Section titled WithReminders(OrleansService, IProviderConfiguration) extension OrleansService Configures reminder storage for the Orleans service.
public static class OrleansServiceExtensions{ public static OrleansService WithReminders( this OrleansService orleansServiceBuilder, IProviderConfiguration provider) { // ... }}Parameters
orleansServiceBuilder OrleansService The target Orleans service builder. provider IProviderConfiguration The reminder storage provider to use. Returns
OrleansService >The Orleans service builder. WithServiceId(OrleansService, string) Section titled WithServiceId(OrleansService, string) extension OrleansService Sets the ServiceId of the Orleans service.
public static class OrleansServiceExtensions{ public static OrleansService WithServiceId( this OrleansService orleansServiceBuilder, string serviceId) { // ... }}Parameters
orleansServiceBuilder OrleansService The target Orleans service builder. serviceId string The ServiceId value. Returns
OrleansService >The Orleans service builder. WithServiceId(OrleansService, IResourceBuilder<ParameterResource>) Section titled WithServiceId(OrleansService, IResourceBuilder<ParameterResource>) extension OrleansService Sets the ServiceId of the Orleans service.
public static class OrleansServiceExtensions{ public static OrleansService WithServiceId( this OrleansService orleansServiceBuilder, IResourceBuilder<ParameterResource> serviceId) { // ... }}Parameters
orleansServiceBuilder OrleansService The target Orleans service builder. serviceId IResourceBuilder<ParameterResource> The ServiceId value. Returns
OrleansService >The Orleans service builder. WithStreaming(OrleansService, IResourceBuilder<IResourceWithConnectionString>) Section titled WithStreaming(OrleansService, IResourceBuilder<IResourceWithConnectionString>) extension OrleansService Adds a stream provider to the Orleans service.
public static class OrleansServiceExtensions{ public static OrleansService WithStreaming( this OrleansService orleansServiceBuilder, IResourceBuilder<IResourceWithConnectionString> provider) { // ... }}Parameters
orleansServiceBuilder OrleansService The target Orleans service builder. provider IResourceBuilder<IResourceWithConnectionString> The provider to add. Returns
OrleansService >The Orleans service builder. Remarks
This resource name is the name the application will use to resolve the provider.
WithStreaming(OrleansService, string, IResourceBuilder<IResourceWithConnectionString>) Section titled WithStreaming(OrleansService, string, IResourceBuilder<IResourceWithConnectionString>) extension OrleansService Adds a stream provider to the Orleans service.
public static class OrleansServiceExtensions{ public static OrleansService WithStreaming( this OrleansService orleansServiceBuilder, string name, IResourceBuilder<IResourceWithConnectionString> provider) { // ... }}Parameters
orleansServiceBuilder OrleansService The target Orleans service builder. name string The name of the provider. This is the name the application will use to resolve the provider. provider IResourceBuilder<IResourceWithConnectionString> The provider to add. Returns
OrleansService >The Orleans service builder. WithStreaming(OrleansService, string, IProviderConfiguration) Section titled WithStreaming(OrleansService, string, IProviderConfiguration) extension OrleansService Adds a stream provider to the Orleans service.
public static class OrleansServiceExtensions{ public static OrleansService WithStreaming( this OrleansService orleansServiceBuilder, string name, IProviderConfiguration provider) { // ... }}Parameters
orleansServiceBuilder OrleansService The target Orleans service builder. name string The name of the provider. This is the name the application will use to resolve the provider. provider IProviderConfiguration The provider to add. Returns
OrleansService >The Orleans service builder.