IReminderService Interface

  • Reference

Definition

Namespace:
Orleans
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
Source:
IReminderService.cs

Functionality for managing reminders.

public interface IReminderService : Orleans.Services.IGrainService
type IReminderService = interface
    interface IGrainService
    interface ISystemTarget
    interface IAddressable
Public Interface IReminderService
Implements IGrainService
Implements
ISystemTarget IAddressable IGrainService

Methods

GetReminder(GrainId, String)

Gets the reminder registered to the specified grain with the provided name.
GetReminder(GrainReference, String)
GetReminders(GrainId)

Gets all reminders registered for the specified grain.
GetReminders(GrainReference)
RegisterOrUpdateReminder(GrainId, String, TimeSpan, TimeSpan)

Registers a new reminder or updates an existing one.
RegisterOrUpdateReminder(GrainReference, String, TimeSpan, TimeSpan)

Registers a new reminder or updates an existing one
Start()

Starts the service.
Stop()

Stops the service.
UnregisterReminder(IGrainReminder)

Unregisters the specified reminder.

Extension Methods

AsReference(IAddressable, Type)

Returns a typed reference to the provided grain.
AsReference<TGrainInterface>(IAddressable)

Returns a typed reference to the provided grain.
BindGrainReference(IAddressable, IGrainFactory)

Binds the grain reference to the provided IGrainFactory.
Cast(IAddressable, Type)

Returns a typed reference to the provided grain.
Cast<TGrainInterface>(IAddressable)

Returns a typed reference to the provided grain.
GetGrainId(IAddressable)

Returns the grain id corresponding to the provided grain.
GetPrimaryKey(IAddressable, String)

Returns the Guid representation of a grain primary key.
GetPrimaryKey(IAddressable)

Returns the Guid representation of a grain primary key.
GetPrimaryKeyLong(IAddressable, String)

Returns the long representation of a grain primary key.
GetPrimaryKeyLong(IAddressable)

Returns the long representation of a grain primary key.
GetPrimaryKeyString(IAddressable)

Returns the string primary key of the grain.
IsPrimaryKeyBasedOnLong(IAddressable)

Returns whether part of the primary key is of type long.

Applies to