Skip to content
Orleans logoMicrosoft Orleans

IReminderTable Methods

Interface for implementations of the underlying storage for reminder data: Azure Table, SQL, development emulator grain, and a mock implementation. Defined as a grain interface for the development emulator grain case.

Init

virtual
View source
[System.Obsolete(Implement and use StartAsync instead)]
public virtual Task Init()
Initializes this instance.

Returns

A System.Threading.Tasks.Task representing the work performed.

ReadRow(GrainId, string)

abstract
public abstract Task<ReminderEntry> ReadRow(GrainId grainId, string reminderName)
Reads the specified entry.

Parameters

grainIdGrainId
The grain ID.
reminderNamestring
Name of the reminder.

Returns

The reminder table entry.

ReadRows(GrainId)

abstract
public abstract Task<ReminderTableData> ReadRows(GrainId grainId)
Reads the reminder table entries associated with the specified grain.

Parameters

grainIdGrainId
The grain ID.

Returns

The reminder table entries associated with the specified grain.

ReadRows(uint, uint)

abstract
public abstract Task<ReminderTableData> ReadRows(uint begin, uint end)
Returns all rows that have their GrainId in the range (begin, end]. If begin is greater or equal to end, returns all entries with hash greater begin or hash less or equal to end.

Parameters

beginuint
The exclusive lower bound.
enduint
The inclusive upper bound.

Returns

The reminder table entries which fall within the specified range.

RemoveRow(GrainId, string, string)

abstract
public abstract Task<bool> RemoveRow(GrainId grainId, string reminderName, string eTag)
Removes a row from the table.

Parameters

grainIdGrainId
The grain ID.
reminderNamestring
The reminder name.
eTagstring
The ETag.

Returns

true if a row with grainId and reminderName existed and was removed successfully, false otherwise

StartAsync(CancellationToken)

virtual
View source
public virtual Task StartAsync(CancellationToken cancellationToken = default(CancellationToken))
Initializes this instance.

Parameters

cancellationTokenCancellationToken

Returns

A System.Threading.Tasks.Task representing the work performed.

StopAsync(CancellationToken)

virtual
View source
public virtual Task StopAsync(CancellationToken cancellationToken = default(CancellationToken))
Stops the reminder table.

Parameters

cancellationTokenCancellationToken
The cancellation token.

Returns

A System.Threading.Tasks.Task representing the work performed.

TestOnlyClearTable

abstract
public abstract Task TestOnlyClearTable()
Clears the table.

Returns

A System.Threading.Tasks.Task representing the work performed.

UpsertRow(ReminderEntry)

abstract
public abstract Task<string> UpsertRow(ReminderEntry entry)
Upserts the specified entry.

Parameters

entryReminderEntry
The entry.

Returns

The row's new ETag.