Skip to content

CosmosGrainStorage Methods

Stores Orleans grain state in Azure Cosmos DB.

ClearStateAsync(string, GrainId, IGrainState<T>)

View source
public Task ClearStateAsync<T>(string grainType, GrainId grainId, IGrainState<T> grainState)
Delete / Clear data function for this storage instance.

Parameters

grainTypestring
Name of the state for this grain
grainIdGrainId
Grain ID
grainStateIGrainState<T>
Copy of last-known state data object for this grain.

Returns

Completion promise for the Delete operation on the specified grain.

ClearStateAsync(string, GrainId, IGrainState<T>, CancellationToken)

View source
public Task ClearStateAsync<T>(string grainType, GrainId grainId, IGrainState<T> grainState, CancellationToken cancellationToken)
Delete / Clear data function for this storage instance.

Parameters

grainTypestring
Name of the state for this grain.
grainIdGrainId
Grain ID.
grainStateIGrainState<T>
Copy of last-known state data object for this grain.
cancellationTokenCancellationToken
The cancellation token.

Returns

Completion promise for the Delete operation on the specified grain.

Participate(ISiloLifecycle)

View source
public void Participate(ISiloLifecycle lifecycle)
Adds the provided observer as a participant in the lifecycle.

Parameters

lifecycleISiloLifecycle
The observer.

ReadStateAsync(string, GrainId, IGrainState<T>)

View source
public Task ReadStateAsync<T>(string grainType, GrainId grainId, IGrainState<T> grainState)
Read data function for this storage instance.

Parameters

grainTypestring
Name of the state for this grain
grainIdGrainId
Grain ID
grainStateIGrainState<T>
State data object to be populated for this grain.

Returns

Completion promise for the Read operation on the specified grain.

ReadStateAsync(string, GrainId, IGrainState<T>, CancellationToken)

View source
public Task ReadStateAsync<T>(string grainType, GrainId grainId, IGrainState<T> grainState, CancellationToken cancellationToken)
Read data function for this storage instance.

Parameters

grainTypestring
Name of the state for this grain.
grainIdGrainId
Grain ID.
grainStateIGrainState<T>
State data object to be populated for this grain.
cancellationTokenCancellationToken
The cancellation token.

Returns

Completion promise for the Read operation on the specified grain.

WriteStateAsync(string, GrainId, IGrainState<T>)

View source
public Task WriteStateAsync<T>(string grainType, GrainId grainId, IGrainState<T> grainState)
Write data function for this storage instance.

Parameters

grainTypestring
Name of the state for this grain
grainIdGrainId
Grain ID
grainStateIGrainState<T>
State data object to be written for this grain.

Returns

Completion promise for the Write operation on the specified grain.

WriteStateAsync(string, GrainId, IGrainState<T>, CancellationToken)

View source
public Task WriteStateAsync<T>(string grainType, GrainId grainId, IGrainState<T> grainState, CancellationToken cancellationToken)
Write data function for this storage instance.

Parameters

grainTypestring
Name of the state for this grain.
grainIdGrainId
Grain ID.
grainStateIGrainState<T>
State data object to be written for this grain.
cancellationTokenCancellationToken
The cancellation token.

Returns

Completion promise for the Write operation on the specified grain.