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;
}

13 members

Methods

methodasClient

Returns a model of the clients of an Orleans service.

asClient(): OrleansServiceClient

Returns

OrleansServiceClient

methodwithBroadcastChannel

Adds a broadcast channel provider to the Orleans service.

withBroadcastChannel(name: string): OrleansService

Parameters

namestring

Returns

OrleansService

methodwithClusterId

Sets the ClusterId of the Orleans service.

withClusterId(clusterId: string): OrleansService

Parameters

clusterIdstring

Returns

OrleansService

methodwithClustering

Configures the Orleans service to use the provided clustering provider.

withClustering(provider: IResourceWithConnectionString): OrleansService

Parameters

providerIResourceWithConnectionString

Returns

OrleansService

methodwithDevelopmentClustering

Configures the Orleans service to use development-only clustering.

withDevelopmentClustering(): OrleansService

Returns

OrleansService

methodwithGrainDirectory

Adds a grain directory provider to the Orleans service.

withGrainDirectory(
    name: string,
    provider: IResourceWithConnectionString): OrleansService

Parameters

namestring

providerIResourceWithConnectionString

Returns

OrleansService

methodwithGrainStorage

Adds a grain storage provider to the Orleans service.

withGrainStorage(
    name: string,
    provider: IResourceWithConnectionString): OrleansService

Parameters

namestring

providerIResourceWithConnectionString

Returns

OrleansService

methodwithMemoryGrainStorage

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

withMemoryGrainStorage(name: string): OrleansService

Parameters

namestring

Returns

OrleansService

methodwithMemoryReminders

Configures in-memory reminder storage for the Orleans service.

withMemoryReminders(): OrleansService

Returns

OrleansService

methodwithMemoryStreaming

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

withMemoryStreaming(name: string): OrleansService

Parameters

namestring

Returns

OrleansService

methodwithReminders

Configures reminder storage for the Orleans service.

withReminders(provider: IResourceWithConnectionString): OrleansService

Parameters

providerIResourceWithConnectionString

Returns

OrleansService

methodwithServiceId

Sets the ServiceId of the Orleans service.

withServiceId(serviceId: string): OrleansService

Parameters

serviceIdstring

Returns

OrleansService

methodwithStreaming

Adds a stream provider to the Orleans service.

withStreaming(
    name: string,
    provider: IResourceWithConnectionString): OrleansService

Parameters

namestring

providerIResourceWithConnectionString

Returns

OrleansService