cloud.orbit.actors.runtime

Class ReminderControllerActor

java.lang.Object

cloud.orbit.actors.runtime.AbstractActor<ReminderControllerActor.State>

cloud.orbit.actors.runtime.ReminderControllerActor

All Implemented Interfaces:

Actor, ReminderController, ShardedReminderController

public class ReminderControllerActor
extends AbstractActor<ReminderControllerActor.State>
implements ReminderController, ShardedReminderController

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReminderControllerActor.State

Field Summary

Fields inherited from class cloud.orbit.actors.runtime.AbstractActor

activation, logger, reference, runtime, state, stateExtension

Constructor Summary

Constructors

Constructor and Description
ReminderControllerActor()

Method Summary

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

Methods inherited from class cloud.orbit.actors.runtime.AbstractActor

actorIdentity, clearState, createDefaultState, getLogger, getLogger, getStateClass, getStreamProvider, readState, registerReminder, registerTimer, registerTimer, runtimeIdentity, state, unregisterReminder, writeState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface cloud.orbit.actors.Actor

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

Constructor Detail

ReminderControllerActor

public ReminderControllerActor()

Method Detail

registerOrUpdateReminder

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

Description copied from interface: ReminderController

Adds or updates a reminder

Specified by:

registerOrUpdateReminder in interface ReminderController

Specified by:

registerOrUpdateReminder in interface ShardedReminderController

Parameters:

actor - the actor that owns of the reminder

reminderName - the name, used with actor as reminder key

startAt - 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

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

Description copied from interface: ReminderController

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

Specified by:

unregisterReminder in interface ReminderController

Specified by:

unregisterReminder in interface ShardedReminderController

Parameters:

actor - the target actor

reminderName - the reminder handle

Returns:

a task holding the reminder name.

getReminders

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

Description copied from interface: ReminderController

Gets all reminders tied to the actor actor.

Specified by:

getReminders in interface ReminderController

Specified by:

getReminders in interface ShardedReminderController

Parameters:

actor - the target actor

Returns:

a task holding the list of reminder names.

getReminders

public Task<List<String>> getReminders()

Description copied from interface: ShardedReminderController

Gets all reminders.

Specified by:

getReminders in interface ShardedReminderController

Returns:

a task holding the list of reminder names.

ensureStart

public Task<Void> ensureStart()

Specified by:

ensureStart in interface ReminderController

Specified by:

ensureStart in interface ShardedReminderController

activateAsync

public Task<?> activateAsync()

Overrides:

activateAsync in class AbstractActor<ReminderControllerActor.State>

deactivateAsync

public Task<?> deactivateAsync()

Overrides:

deactivateAsync in class AbstractActor<ReminderControllerActor.State>