Skip to content
Orleans logoMicrosoft Orleans

AzureBasedReminderTable Methods

Stores and retrieves Orleans reminder entries using Azure Table Storage.

ReadRow(GrainId, string)

View source
public Task<ReminderEntry?> ReadRow(GrainId grainId, string reminderName)
Reads a reminder entry for the specified grain and reminder name.

Parameters

grainIdGrainId
The grain identifier.
reminderNamestring
The reminder name.

Returns

The reminder entry when found; otherwise, null.

ReadRows(GrainId)

View source
public Task<ReminderTableData> ReadRows(GrainId grainId)
Reads all reminder entries associated with the specified grain.

Parameters

grainIdGrainId
The grain identifier.

Returns

The reminder entries associated with grainId.

ReadRows(uint, uint)

View source
public Task<ReminderTableData> ReadRows(uint begin, uint end)
Reads reminder entries whose grain hash is in the range (begin, end].

Parameters

beginuint
The exclusive lower bound of the hash range.
enduint
The inclusive upper bound of the hash range.

Returns

The reminder entries in the specified hash range.

RemoveRow(GrainId, string, string)

View source
public Task<bool> RemoveRow(GrainId grainId, string reminderName, string eTag)
Removes a reminder entry when its entity tag matches the stored entry.

Parameters

grainIdGrainId
The grain identifier.
reminderNamestring
The reminder name.
eTagstring
The entity tag used for optimistic concurrency.

Returns

true when the entry was removed; otherwise, false.

StartAsync(CancellationToken)

View source
public Task StartAsync(CancellationToken cancellationToken)
Connects to Azure Table Storage and creates the reminder table if it does not exist.

Parameters

cancellationTokenCancellationToken
The token used to cancel lifecycle-lock acquisition and delays between initialization attempts.

Returns

A task representing the initialization operation.

StopAsync(CancellationToken)

View source
public Task StopAsync(CancellationToken cancellationToken)
Stops the reminder table until it is started again.

Parameters

cancellationTokenCancellationToken
The token used to cancel the stop operation.

Returns

A task representing the stop operation.

TestOnlyClearTable

View source
public Task TestOnlyClearTable()
Deletes all reminder entries for the current Orleans service and cluster.

Returns

A task representing the delete operation.

UpsertRow(ReminderEntry)

View source
public Task<string?> UpsertRow(ReminderEntry entry)
Inserts or replaces a reminder entry.

Parameters

entryReminderEntry
The reminder entry to store.

Returns

The new entity tag when the write succeeds; otherwise, null.

Exceptions

System.ArgumentNullException
entry is null.