Skip to content
Docs Try Aspire
Docs Try

OrleansService

Handle
📦 Aspire.Hosting.Orleans v13.4.0
interface OrleansService {
asClient(): OrleansServiceClient;
withBroadcastChannel(name: string): OrleansService;
withClusterId(clusterId: string): OrleansService;
withClustering(provider: IResourceWithConnectionString): OrleansService;
withDevelopmentClustering(): OrleansService;
withGrainDirectory(
name: string,
provider: IResourceWithConnectionString): OrleansService;
withGrainStorage(
name: string,
provider: IResourceWithConnectionString): OrleansService;
withMemoryGrainStorage(name: string): OrleansService;
withMemoryReminders(): OrleansService;
withMemoryStreaming(name: string): OrleansService;
withReminders(provider: IResourceWithConnectionString): OrleansService;
withServiceId(serviceId: string): OrleansService;
withStreaming(
name: string,
provider: IResourceWithConnectionString): OrleansService;
}

Methods

method asClient
Returns a model of the clients of an Orleans service.
asClient(): OrleansServiceClient
OrleansServiceClient
Adds a broadcast channel provider to the Orleans service.
withBroadcastChannel(name: string): OrleansService
name string
OrleansService
Sets the ClusterId of the Orleans service.
withClusterId(clusterId: string): OrleansService
clusterId string
OrleansService
Configures the Orleans service to use the provided clustering provider.
withClustering(provider: IResourceWithConnectionString): OrleansService
provider IResourceWithConnectionString
OrleansService
Configures the Orleans service to use development-only clustering.
withDevelopmentClustering(): OrleansService
OrleansService
Adds a grain directory provider to the Orleans service.
withGrainDirectory(
name: string,
provider: IResourceWithConnectionString): OrleansService
name string
provider IResourceWithConnectionString
OrleansService
Adds a grain storage provider to the Orleans service.
withGrainStorage(
name: string,
provider: IResourceWithConnectionString): OrleansService
name string
provider IResourceWithConnectionString
OrleansService
Adds an in-memory grain storage to the Orleans service.
withMemoryGrainStorage(name: string): OrleansService
name string
OrleansService
Configures in-memory reminder storage for the Orleans service.
withMemoryReminders(): OrleansService
OrleansService
Adds an in-memory stream provider to the Orleans service.
withMemoryStreaming(name: string): OrleansService
name string
OrleansService
Configures reminder storage for the Orleans service.
withReminders(provider: IResourceWithConnectionString): OrleansService
provider IResourceWithConnectionString
OrleansService
Sets the ServiceId of the Orleans service.
withServiceId(serviceId: string): OrleansService
serviceId string
OrleansService
Adds a stream provider to the Orleans service.
withStreaming(
name: string,
provider: IResourceWithConnectionString): OrleansService
name string
provider IResourceWithConnectionString
OrleansService