GrainReminderExtensions.RegisterOrUpdateReminder Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| RegisterOrUpdateReminder(Grain, String, TimeSpan, TimeSpan) |
Registers a persistent, reliable reminder to send regular notifications (reminders) to the grain.
The grain must implement the |
| RegisterOrUpdateReminder(IGrainBase, String, TimeSpan, TimeSpan) |
Registers a persistent, reliable reminder to send regular notifications (reminders) to the grain.
The grain must implement the |
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.
public static System.Threading.Tasks.Task<Orleans.Runtime.IGrainReminder> RegisterOrUpdateReminder (this Orleans.Grain grain, string reminderName, TimeSpan dueTime, TimeSpan period);static member RegisterOrUpdateReminder : Orleans.Grain * string * TimeSpan * TimeSpan -> System.Threading.Tasks.Task<Orleans.Runtime.IGrainReminder><Extension()>
Public Function RegisterOrUpdateReminder (grain As Grain, reminderName As String, dueTime As TimeSpan, period As TimeSpan) As Task(Of IGrainReminder)Parameters
- grain
- Grain
The grain instance.
- reminderName
- String
Name of this reminder
- dueTime
- TimeSpan
Due time for this reminder
- period
- TimeSpan
Frequency period for this reminder
Returns
Promise for Reminder handle.
Applies to
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.
public static System.Threading.Tasks.Task<Orleans.Runtime.IGrainReminder> RegisterOrUpdateReminder (this Orleans.IGrainBase grain, string reminderName, TimeSpan dueTime, TimeSpan period);static member RegisterOrUpdateReminder : Orleans.IGrainBase * string * TimeSpan * TimeSpan -> System.Threading.Tasks.Task<Orleans.Runtime.IGrainReminder><Extension()>
Public Function RegisterOrUpdateReminder (grain As IGrainBase, reminderName As String, dueTime As TimeSpan, period As TimeSpan) As Task(Of IGrainReminder)Parameters
- grain
- IGrainBase
The grain instance.
- reminderName
- String
Name of this reminder
- dueTime
- TimeSpan
Due time for this reminder
- period
- TimeSpan
Frequency period for this reminder
Returns
Promise for Reminder handle.