OrleansServiceExtensions Methods

AddOrleans(IDistributedApplicationBuilder, string)extensionOrleansService

Adds an Orleans service to the application.

public static class OrleansServiceExtensions
{
    public static OrleansService AddOrleans(
        this IDistributedApplicationBuilder builder,
        string name)
    {
        // ...
    }
}

OrleansServiceExtensions.cs#L30

Parameters

builderIDistributedApplicationBuilderThe application builder.

namestringThe name of the Orleans service.

Returns

OrleansServiceThe Orleans service builder.

AsClient(OrleansService)extensionOrleansServiceClient

Returns a model of the clients of an Orleans service.

public static class OrleansServiceExtensions
{
    public static OrleansServiceClient AsClient(
        this OrleansService orleansService)
    {
        // ...
    }
}

OrleansServiceExtensions.cs#L403

Parameters

orleansServiceOrleansServiceThe Orleans service

Returns

OrleansServiceClientA model of the clients of an Orleans service.

WithBroadcastChannel(OrleansService, string, IProviderConfiguration)extensionOrleansService

Adds a broadcast channel provider to the Orleans service.

public static class OrleansServiceExtensions
{
    public static OrleansService WithBroadcastChannel(
        this OrleansService orleansServiceBuilder,
        string name,
        IProviderConfiguration provider)
    {
        // ...
    }
}

OrleansServiceExtensions.cs#L260-L261

Parameters

orleansServiceBuilderOrleansServiceThe target Orleans service builder.

namestringThe name of the provider. This is the name the application will use to resolve the provider.

providerIProviderConfigurationThe provider to add.

Returns

OrleansServiceThe Orleans service builder.

Remarks

This method is not available in polyglot AppHosts. Use OrleansServiceExtensions.WithBroadcastChannel instead.

WithBroadcastChannel(OrleansService, string)extensionOrleansService

Adds a broadcast channel provider to the Orleans service.

public static class OrleansServiceExtensions
{
    public static OrleansService WithBroadcastChannel(
        this OrleansService orleansServiceBuilder,
        string name)
    {
        // ...
    }
}

OrleansServiceExtensions.cs#L274

Parameters

orleansServiceBuilderOrleansServiceThe target Orleans service builder.

namestringThe name of the provider. This is the name the application will use to resolve the provider.

Returns

OrleansServiceThe Orleans service builder.

WithClusterId(OrleansService, string)extensionOrleansService

Sets the ClusterId of the Orleans service.

public static class OrleansServiceExtensions
{
    public static OrleansService WithClusterId(
        this OrleansService orleansServiceBuilder,
        string clusterId)
    {
        // ...
    }
}

OrleansServiceExtensions.cs

Parameters

orleansServiceBuilderOrleansServiceThe target Orleans service builder.

clusterIdstringThe ClusterId value.

Returns

OrleansServiceThe Orleans service builder.

WithClusterId(OrleansService, IResourceBuilder<ParameterResource>)extensionOrleansService

Sets the ClusterId of the Orleans service.

public static class OrleansServiceExtensions
{
    public static OrleansService WithClusterId(
        this OrleansService orleansServiceBuilder,
        IResourceBuilder<ParameterResource> clusterId)
    {
        // ...
    }
}

OrleansServiceExtensions.cs

Parameters

orleansServiceBuilderOrleansServiceThe target Orleans service builder.

clusterIdIResourceBuilder<ParameterResource>The ClusterId value.

Returns

OrleansServiceThe Orleans service builder.

Remarks

This method is not available in polyglot AppHosts. Use OrleansServiceExtensions.WithClusterId instead.

WithClustering(OrleansService, IResourceBuilder<IResourceWithConnectionString>)extensionOrleansService

Configures the Orleans service to use the provided clustering provider.

public static class OrleansServiceExtensions
{
    public static OrleansService WithClustering(
        this OrleansService orleansServiceBuilder,
        IResourceBuilder<IResourceWithConnectionString> provider)
    {
        // ...
    }
}

OrleansServiceExtensions.cs

Parameters

orleansServiceBuilderOrleansServiceThe target Orleans service builder.

providerIResourceBuilder<IResourceWithConnectionString>The provider.

Returns

OrleansServiceThe Orleans service builder.

WithClustering(OrleansService, IProviderConfiguration)extensionOrleansService

Configures the Orleans service to use the provided clustering provider.

public static class OrleansServiceExtensions
{
    public static OrleansService WithClustering(
        this OrleansService orleansServiceBuilder,
        IProviderConfiguration provider)
    {
        // ...
    }
}

OrleansServiceExtensions.cs

Parameters

orleansServiceBuilderOrleansServiceThe target Orleans service builder.

providerIProviderConfigurationThe provider.

Returns

OrleansServiceThe Orleans service builder.

Remarks

This method is not available in polyglot AppHosts. Use OrleansServiceExtensions.WithClustering instead.

WithDevelopmentClustering(OrleansService)extensionOrleansService

Configures the Orleans service to use development-only clustering.

public static class OrleansServiceExtensions
{
    public static OrleansService WithDevelopmentClustering(
        this OrleansService orleansServiceBuilder)
    {
        // ...
    }
}

OrleansServiceExtensions.cs#L130

Parameters

orleansServiceBuilderOrleansServiceThe target Orleans service builder.

Returns

OrleansServiceThe Orleans service builder.

WithGrainDirectory(OrleansService, IResourceBuilder<IResourceWithConnectionString>)extensionOrleansService

Adds a grain directory provider to the Orleans service.

public static class OrleansServiceExtensions
{
    public static OrleansService WithGrainDirectory(
        this OrleansService orleansServiceBuilder,
        IResourceBuilder<IResourceWithConnectionString> provider)
    {
        // ...
    }
}

OrleansServiceExtensions.cs#L328

Parameters

orleansServiceBuilderOrleansServiceThe target Orleans service builder.

providerIResourceBuilder<IResourceWithConnectionString>The provider to add.

Returns

OrleansServiceThe Orleans service builder.

Remarks

This resource name is the name the application will use to resolve the provider. This method is not available in polyglot AppHosts. Use OrleansServiceExtensions.WithGrainDirectory instead.

WithGrainDirectory(OrleansService, string, IResourceBuilder<IResourceWithConnectionString>)extensionOrleansService

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)
    {
        // ...
    }
}

OrleansServiceExtensions.cs

Parameters

orleansServiceBuilderOrleansServiceThe target Orleans service builder.

namestringThe name of the provider. This is the name the application will use to resolve the provider.

providerIResourceBuilder<IResourceWithConnectionString>The provider to add.

Returns

OrleansServiceThe Orleans service builder.

WithGrainDirectory(OrleansService, string, IProviderConfiguration)extensionOrleansService

Adds a grain directory provider to the Orleans service.

public static class OrleansServiceExtensions
{
    public static OrleansService WithGrainDirectory(
        this OrleansService orleansServiceBuilder,
        string name,
        IProviderConfiguration provider)
    {
        // ...
    }
}

OrleansServiceExtensions.cs

Parameters

orleansServiceBuilderOrleansServiceThe target Orleans service builder.

namestringThe name of the provider. This is the name the application will use to resolve the provider.

providerIProviderConfigurationThe provider to add.

Returns

OrleansServiceThe Orleans service builder.

Remarks

This method is not available in polyglot AppHosts. Use OrleansServiceExtensions.WithGrainDirectory instead.

WithGrainStorage(OrleansService, IResourceBuilder<IResourceWithConnectionString>)extensionOrleansService

Adds a grain storage provider to the Orleans service.

public static class OrleansServiceExtensions
{
    public static OrleansService WithGrainStorage(
        this OrleansService orleansServiceBuilder,
        IResourceBuilder<IResourceWithConnectionString> provider)
    {
        // ...
    }
}

OrleansServiceExtensions.cs#L143

Parameters

orleansServiceBuilderOrleansServiceThe target Orleans service builder.

providerIResourceBuilder<IResourceWithConnectionString>The provider to add.

Returns

OrleansServiceThe Orleans service builder.

Remarks

This resource name is the name the application will use to resolve the provider. This method is not available in polyglot AppHosts. Use OrleansServiceExtensions.WithGrainStorage instead.

WithGrainStorage(OrleansService, string, IResourceBuilder<IResourceWithConnectionString>)extensionOrleansService

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)
    {
        // ...
    }
}

OrleansServiceExtensions.cs

Parameters

orleansServiceBuilderOrleansServiceThe target Orleans service builder.

namestringThe name of the provider. This is the name the application will use to resolve the provider.

providerIResourceBuilder<IResourceWithConnectionString>The provider to add.

Returns

OrleansServiceThe Orleans service builder.

WithGrainStorage(OrleansService, string, IProviderConfiguration)extensionOrleansService

Adds a grain storage provider to the Orleans service.

public static class OrleansServiceExtensions
{
    public static OrleansService WithGrainStorage(
        this OrleansService orleansServiceBuilder,
        string name,
        IProviderConfiguration provider)
    {
        // ...
    }
}

OrleansServiceExtensions.cs

Parameters

orleansServiceBuilderOrleansServiceThe target Orleans service builder.

namestringThe name of the provider. This is the name the application will use to resolve the provider.

providerIProviderConfigurationThe provider to add.

Returns

OrleansServiceThe Orleans service builder.

Remarks

This method is not available in polyglot AppHosts. Use OrleansServiceExtensions.WithGrainStorage instead.

WithMemoryGrainStorage(OrleansService, string)extensionOrleansService

Adds an in-memory grain storage to the Orleans service.

public static class OrleansServiceExtensions
{
    public static OrleansService WithMemoryGrainStorage(
        this OrleansService orleansServiceBuilder,
        string name)
    {
        // ...
    }
}

OrleansServiceExtensions.cs#L187

Parameters

orleansServiceBuilderOrleansServiceThe target Orleans service builder.

namestringThe name of the provider. This is the name the application will use to resolve the provider.

Returns

OrleansServiceThe Orleans service builder.

WithMemoryReminders(OrleansService)extensionOrleansService

Configures in-memory reminder storage for the Orleans service.

public static class OrleansServiceExtensions
{
    public static OrleansService WithMemoryReminders(
        this OrleansService orleansServiceBuilder)
    {
        // ...
    }
}

OrleansServiceExtensions.cs#L313-L314

Parameters

orleansServiceBuilderOrleansServiceThe target Orleans service builder.

Returns

OrleansServiceThe Orleans service builder.

WithMemoryStreaming(OrleansService, string)extensionOrleansService

Adds an in-memory stream provider to the Orleans service.

public static class OrleansServiceExtensions
{
    public static OrleansService WithMemoryStreaming(
        this OrleansService orleansServiceBuilder,
        string name)
    {
        // ...
    }
}

OrleansServiceExtensions.cs#L244

Parameters

orleansServiceBuilderOrleansServiceThe target Orleans service builder.

namestringThe name of the provider. This is the name the application will use to resolve the provider.

Returns

OrleansServiceThe Orleans service builder.

WithOrleansProviderType(IResourceBuilder<T>, string)extensionIResourceBuilder<T>

Configures a resource to use the specified Orleans provider type.

public static class OrleansServiceExtensions
{
    public static IResourceBuilder<T> WithOrleansProviderType<T>(
        this IResourceBuilder<T> builder,
        string providerType)
    {
        // ...
    }
}

OrleansServiceExtensions.cs#L389-L392

Parameters

builderIResourceBuilder<T>The connection-string resource builder.

providerTypestringThe Orleans provider type to use for the resource.

Returns

IResourceBuilder<T>The resource builder.

Exceptions

ArgumentNullExceptionThrown when builder is null.

ArgumentExceptionThrown when providerType is null, empty, or consists only of white-space characters.

Remarks

Use this when a resource can be used as a drop-in replacement for an Orleans provider type that is inferred from a different resource name. For example, Garnet can be used wherever Orleans expects a Redis provider.

Examples

Configure a Garnet resource as a Redis Orleans provider:

var garnet = builder.AddGarnet("garnet")
    .WithOrleansProviderType("Redis");

var orleans = builder.AddOrleans("orleans")
    .WithClustering(garnet);

WithReference(IResourceBuilder<T>, OrleansService)extensionIResourceBuilder<T>

Adds Orleans to the resource.

public static class OrleansServiceExtensions
{
    public static IResourceBuilder<T> WithReference<T>(
        this IResourceBuilder<T> builder,
        OrleansService orleansService)
    {
        // ...
    }
}

OrleansServiceExtensions.cs#L419

Parameters

builderIResourceBuilder<T>The builder on which add the Orleans service builder.

orleansServiceOrleansServiceThe Orleans service, containing clustering, etc.

Returns

IResourceBuilder<T>The resource builder.

Exceptions

InvalidOperationExceptionClustering has not been configured.

WithReminders(OrleansService, IResourceBuilder<IResourceWithConnectionString>)extensionOrleansService

Configures reminder storage for the Orleans service.

public static class OrleansServiceExtensions
{
    public static OrleansService WithReminders(
        this OrleansService orleansServiceBuilder,
        IResourceBuilder<IResourceWithConnectionString> provider)
    {
        // ...
    }
}

OrleansServiceExtensions.cs

Parameters

orleansServiceBuilderOrleansServiceThe target Orleans service builder.

providerIResourceBuilder<IResourceWithConnectionString>The reminder storage provider.

Returns

OrleansServiceThe Orleans service builder.

WithReminders(OrleansService, IProviderConfiguration)extensionOrleansService

Configures reminder storage for the Orleans service.

public static class OrleansServiceExtensions
{
    public static OrleansService WithReminders(
        this OrleansService orleansServiceBuilder,
        IProviderConfiguration provider)
    {
        // ...
    }
}

OrleansServiceExtensions.cs

Parameters

orleansServiceBuilderOrleansServiceThe target Orleans service builder.

providerIProviderConfigurationThe reminder storage provider to use.

Returns

OrleansServiceThe Orleans service builder.

Remarks

This method is not available in polyglot AppHosts. Use OrleansServiceExtensions.WithReminders instead.

WithServiceId(OrleansService, string)extensionOrleansService

Sets the ServiceId of the Orleans service.

public static class OrleansServiceExtensions
{
    public static OrleansService WithServiceId(
        this OrleansService orleansServiceBuilder,
        string serviceId)
    {
        // ...
    }
}

OrleansServiceExtensions.cs

Parameters

orleansServiceBuilderOrleansServiceThe target Orleans service builder.

serviceIdstringThe ServiceId value.

Returns

OrleansServiceThe Orleans service builder.

WithServiceId(OrleansService, IResourceBuilder<ParameterResource>)extensionOrleansService

Sets the ServiceId of the Orleans service.

public static class OrleansServiceExtensions
{
    public static OrleansService WithServiceId(
        this OrleansService orleansServiceBuilder,
        IResourceBuilder<ParameterResource> serviceId)
    {
        // ...
    }
}

OrleansServiceExtensions.cs

Parameters

orleansServiceBuilderOrleansServiceThe target Orleans service builder.

serviceIdIResourceBuilder<ParameterResource>The ServiceId value.

Returns

OrleansServiceThe Orleans service builder.

Remarks

This method is not available in polyglot AppHosts. Use OrleansServiceExtensions.WithServiceId instead.

WithStreaming(OrleansService, IResourceBuilder<IResourceWithConnectionString>)extensionOrleansService

Adds a stream provider to the Orleans service.

public static class OrleansServiceExtensions
{
    public static OrleansService WithStreaming(
        this OrleansService orleansServiceBuilder,
        IResourceBuilder<IResourceWithConnectionString> provider)
    {
        // ...
    }
}

OrleansServiceExtensions.cs#L200

Parameters

orleansServiceBuilderOrleansServiceThe target Orleans service builder.

providerIResourceBuilder<IResourceWithConnectionString>The provider to add.

Returns

OrleansServiceThe Orleans service builder.

Remarks

This resource name is the name the application will use to resolve the provider. This method is not available in polyglot AppHosts. Use OrleansServiceExtensions.WithStreaming instead.

WithStreaming(OrleansService, string, IResourceBuilder<IResourceWithConnectionString>)extensionOrleansService

Adds a stream provider to the Orleans service.

public static class OrleansServiceExtensions
{
    public static OrleansService WithStreaming(
        this OrleansService orleansServiceBuilder,
        string name,
        IResourceBuilder<IResourceWithConnectionString> provider)
    {
        // ...
    }
}

OrleansServiceExtensions.cs

Parameters

orleansServiceBuilderOrleansServiceThe target Orleans service builder.

namestringThe name of the provider. This is the name the application will use to resolve the provider.

providerIResourceBuilder<IResourceWithConnectionString>The provider to add.

Returns

OrleansServiceThe Orleans service builder.

WithStreaming(OrleansService, string, IProviderConfiguration)extensionOrleansService

Adds a stream provider to the Orleans service.

public static class OrleansServiceExtensions
{
    public static OrleansService WithStreaming(
        this OrleansService orleansServiceBuilder,
        string name,
        IProviderConfiguration provider)
    {
        // ...
    }
}

OrleansServiceExtensions.cs

Parameters

orleansServiceBuilderOrleansServiceThe target Orleans service builder.

namestringThe name of the provider. This is the name the application will use to resolve the provider.

providerIProviderConfigurationThe provider to add.

Returns

OrleansServiceThe Orleans service builder.

Remarks

This method is not available in polyglot AppHosts. Use OrleansServiceExtensions.WithStreaming instead.