Skip to content
Orleans logoMicrosoft Orleans

IReminderRegistry Methods

Functionality for managing reminders.

GetReminder(GrainId, string)

abstract
public abstract Task<IGrainReminder?> GetReminder(GrainId callingGrainId, string reminderName)
Gets the reminder with the specified name which is registered to the currently active grain.

Parameters

callingGrainIdGrainId
The ID of the the currently executing grain
reminderNamestring
The reminder name.

Returns

The reminder.

GetReminders(GrainId)

abstract
public abstract Task<List<IGrainReminder>> GetReminders(GrainId callingGrainId)
Gets all reminders which are currently registered to the active grain.

Parameters

callingGrainIdGrainId
The ID of the the currently executing grain

Returns

All reminders which are currently registered to the active grain.

RegisterOrUpdateReminder(GrainId, string, TimeSpan, TimeSpan)

abstract
public abstract Task<IGrainReminder> RegisterOrUpdateReminder(GrainId callingGrainId, string reminderName, TimeSpan dueTime, TimeSpan period)
Register or update the reminder with the specified name for the currently active grain.

Parameters

callingGrainIdGrainId
The ID of the the currently executing grain
reminderNamestring
The reminder name.
dueTimeTimeSpan
The amount of time to delay before initially invoking the reminder. A value of System.TimeSpan.Zero means the first tick is scheduled immediately; negative, infinite, or values which exceed the remaining System.DateTime range are rejected.
periodTimeSpan
The time interval between invocations of the reminder. The value must be at least ReminderOptions; smaller values and System.Threading.Timeout.InfiniteTimeSpan are rejected.

Returns

The reminder.

UnregisterReminder(GrainId, IGrainReminder)

abstract
public abstract Task UnregisterReminder(GrainId callingGrainId, IGrainReminder reminder)
Unregisters a reminder from the currently active grain.

Parameters

callingGrainIdGrainId
The ID of the the currently executing grain
reminderIGrainReminder
The reminder to unregister.

Returns

A System.Threading.Tasks.Task representing the operation.