Edit

Share via

IReminderRegistry.RegisterOrUpdateReminder Method

  • Reference

Definition

Namespace:
Orleans.Timers
Assembly:
Orleans.dll
Assembly:
Orleans.Core.Abstractions.dll
Assembly:
Orleans.Reminders.dll
Package:
Microsoft.Orleans.Core v1.5.10
Package:
Microsoft.Orleans.Core.Abstractions v2.4.5
Package:
Microsoft.Orleans.Core.Abstractions v3.6.5
Package:
Microsoft.Orleans.Reminders v7.2.5
Package:
Microsoft.Orleans.Reminders v8.0.0
Package:
Microsoft.Orleans.Reminders v8.1.0
Package:
Microsoft.Orleans.Reminders v8.2.0

Overloads

RegisterOrUpdateReminder(String, TimeSpan, TimeSpan)
RegisterOrUpdateReminder(GrainId, String, TimeSpan, TimeSpan)

Register or update the reminder with the specified name for the currently active grain.

RegisterOrUpdateReminder(String, TimeSpan, TimeSpan)

Source:
IReminderRegistry.cs
public System.Threading.Tasks.Task<Orleans.Runtime.IGrainReminder> RegisterOrUpdateReminder (string reminderName, TimeSpan dueTime, TimeSpan period);
abstract member RegisterOrUpdateReminder : string * TimeSpan * TimeSpan -> System.Threading.Tasks.Task<Orleans.Runtime.IGrainReminder>
Public Function RegisterOrUpdateReminder (reminderName As String, dueTime As TimeSpan, period As TimeSpan) As Task(Of IGrainReminder)

Parameters

reminderName
String
dueTime
TimeSpan
period
TimeSpan

Returns

Task<IGrainReminder>

Applies to

RegisterOrUpdateReminder(GrainId, String, TimeSpan, TimeSpan)

Register or update the reminder with the specified name for the currently active grain.

public System.Threading.Tasks.Task<Orleans.Runtime.IGrainReminder> RegisterOrUpdateReminder (Orleans.Runtime.GrainId callingGrainId, string reminderName, TimeSpan dueTime, TimeSpan period);
abstract member RegisterOrUpdateReminder : Orleans.Runtime.GrainId * string * TimeSpan * TimeSpan -> System.Threading.Tasks.Task<Orleans.Runtime.IGrainReminder>
Public Function RegisterOrUpdateReminder (callingGrainId As GrainId, reminderName As String, dueTime As TimeSpan, period As TimeSpan) As Task(Of IGrainReminder)

Parameters

callingGrainId
GrainId

The ID of the the currently executing grain

reminderName
String

The reminder name.

dueTime
TimeSpan

The amount of time to delay before initially invoking the reminder.

period
TimeSpan

The time interval between invocations of the reminder.

Returns

Task<IGrainReminder>

The reminder.

Applies to