GrainReminderExtensions

1. Documentation
2. API reference
3. Microsoft.Orleans.Reminders
4. GrainReminderExtensions

class

Namespace: Orleans

NuGetSourceMarkdown

Extension methods for accessing reminders from a Grain or IGrainBase implementation.

public static class GrainReminderExtensions

Methods

• GetReminder(Grain, string) Returns a previously registered reminder.
• GetReminder(Grain, string, CancellationToken)Returns a previously registered reminder.
• GetReminder(IGrainBase, string) Returns a previously registered reminder.
• GetReminder(IGrainBase, string, CancellationToken)Returns a previously registered reminder.
• GetReminders(Grain) Returns a list of all reminders registered by the grain.
• GetReminders(Grain, CancellationToken)Returns all reminders registered by the grain.
• GetReminders(IGrainBase) Returns a list of all reminders registered by the grain.
• GetReminders(IGrainBase, CancellationToken)Returns all reminders registered by the grain.
• RegisterOrUpdateReminder(Grain, string, TimeSpan, TimeSpan) Registers a persistent, reliable reminder to send regular notifications (reminders) to the grain. The grain must implement the Orleans.IRemindable interface, and reminders for this grain will be sent to the ReceiveReminder callback method. If the current grain is deactivated when the timer fires, a new activation of this grain will be created to receive this reminder. If an existing reminder with the same name already exists, that reminder will be overwritten with this new reminder. Reminders will always be received by one activation of this grain, even if multiple activations exist for this grain.
• RegisterOrUpdateReminder(Grain, string, TimeSpan, TimeSpan, CancellationToken)Registers or updates a reminder.
• RegisterOrUpdateReminder(IGrainBase, string, TimeSpan, TimeSpan) Registers a persistent, reliable reminder to send regular notifications (reminders) to the grain. The grain must implement the Orleans.IRemindable interface, and reminders for this grain will be sent to the ReceiveReminder callback method. If the current grain is deactivated when the timer fires, a new activation of this grain will be created to receive this reminder. If an existing reminder with the same name already exists, that reminder will be overwritten with this new reminder. Reminders will always be received by one activation of this grain, even if multiple activations exist for this grain.
• RegisterOrUpdateReminder(IGrainBase, string, TimeSpan, TimeSpan, CancellationToken)Registers or updates a reminder.
• UnregisterReminder(Grain, IGrainReminder) Unregisters a previously registered reminder.
• UnregisterReminder(Grain, IGrainReminder, CancellationToken)Unregisters a previously registered reminder.
• UnregisterReminder(IGrainBase, IGrainReminder) Unregisters a previously registered reminder.
• UnregisterReminder(IGrainBase, IGrainReminder, CancellationToken)Unregisters a previously registered reminder.