Skip to content
Orleans logoMicrosoft Orleans

IRemindable Methods

Callback interface that grains must implement in order to be able to register and receive Reminders.

ReceiveReminder(string, TickStatus)

abstract
View source
[Orleans.Alias(ReceiveReminder)]
public abstract Task ReceiveReminder(string reminderName, TickStatus status)
Receive a new Reminder.

Parameters

reminderNamestring
Name of this Reminder
statusTickStatus
Status of this Reminder tick

Returns

Completion promise which the grain will resolve when it has finished processing this Reminder tick.

ReceiveReminder(string, TickStatus, CancellationToken)

virtual
View source
[Orleans.Alias(6461BF2F)]
public virtual Task ReceiveReminder(string reminderName, TickStatus status, CancellationToken cancellationToken)
Receive a new Reminder.

Parameters

reminderNamestring
Name of this Reminder
statusTickStatus
Status of this Reminder tick
cancellationTokenCancellationToken
The cancellation token.

Returns

Completion promise which the grain will resolve when it has finished processing this Reminder tick.