cloud.orbit.actors.runtime

Interface ReminderController

All Superinterfaces:

Actor

All Known Implementing Classes:

ReminderControllerActor

public interface ReminderController
extends Actor

Method Summary

Modifier and Type	Method and Description
Task<Void>	ensureStart()
Task<List<String>>	getReminders(Remindable actor) Gets all reminders tied to the actor actor.
Task<String>	registerOrUpdateReminder(Remindable actor, String reminderName, Date dueTime, long period, TimeUnit timeUnit) Adds or updates a reminder
Task<String>	unregisterReminder(Remindable actor, String reminderName) Cancels a reminder registration.

Methods inherited from interface cloud.orbit.actors.Actor

cast, deactivate, getClusterActorCount, getIdentity, getIdentity, getReference, getReference

Method Detail

registerOrUpdateReminder

Task<String> registerOrUpdateReminder(Remindable actor,
                                      String reminderName,
                                      Date dueTime,
                                      long period,
                                      TimeUnit timeUnit)

Adds or updates a reminder

Parameters:

actor - the actor that owns of the reminder

reminderName - the name, used with actor as reminder key

dueTime - the first time the reminder will trigger

period - the period of the reminder after the first time.

timeUnit - the time unit for period

Returns:

a task that returns the reminder name

unregisterReminder

Task<String> unregisterReminder(Remindable actor,
                                String reminderName)

Cancels a reminder registration. It's not guaranteed that the reminder won't be called after this method a the invocation might have already being triggered

Parameters:

actor - the target actor

reminderName - the reminder handle

Returns:

a task holding the reminder name.

getReminders

Task<List<String>> getReminders(Remindable actor)

Gets all reminders tied to the actor actor.

Parameters:

actor - the target actor

Returns:

a task holding the list of reminder names.

ensureStart

Task<Void> ensureStart()