Package akka.stream.stage
Class TimerGraphStageLogic
- java.lang.Object
-
- akka.stream.stage.GraphStageLogic
-
- akka.stream.stage.TimerGraphStageLogic
-
- Direct Known Subclasses:
TimerGraphStageLogicWithLogging
public abstract class TimerGraphStageLogic extends GraphStageLogic
Will be called when the scheduled timer is triggered.param: timerKey key of the scheduled timer
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class akka.stream.stage.GraphStageLogic
GraphStageLogic.ConditionalTerminateInput, GraphStageLogic.ConditionalTerminateOutput, GraphStageLogic.EagerTerminateInput$, GraphStageLogic.EagerTerminateOutput$, GraphStageLogic.IgnoreTerminateInput$, GraphStageLogic.IgnoreTerminateOutput$, GraphStageLogic.StageActor, GraphStageLogic.StageActorRef$, GraphStageLogic.StageActorRefNotInitializedException, GraphStageLogic.StageActorRefNotInitializedException$, GraphStageLogic.SubSinkInlet<T>, GraphStageLogic.SubSourceOutlet<T>, GraphStageLogic.TotallyIgnorantInput$
-
-
Constructor Summary
Constructors Constructor Description TimerGraphStageLogic(Shape _shape)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
afterPostStop()
INTERNAL APIprotected void
cancelTimer(java.lang.Object timerKey)
Cancel timer, ensuring that theonTimer(java.lang.Object)
is not subsequently called.protected boolean
isTimerActive(java.lang.Object timerKey)
Inquire whether the timer is still active.protected void
onTimer(java.lang.Object timerKey)
Will be called when the scheduled timer is triggered.protected void
scheduleOnce(java.lang.Object timerKey, java.time.Duration delay)
Schedule timer to callonTimer(java.lang.Object)
after given delay.protected void
scheduleOnce(java.lang.Object timerKey, scala.concurrent.duration.FiniteDuration delay)
Schedule timer to callonTimer(java.lang.Object)
after given delay.protected void
schedulePeriodically(java.lang.Object timerKey, java.time.Duration interval)
Schedule timer to callonTimer(java.lang.Object)
periodically with the given interval.protected void
schedulePeriodically(java.lang.Object timerKey, scala.concurrent.duration.FiniteDuration interval)
Schedule timer to callonTimer(java.lang.Object)
periodically with the given interval.protected void
schedulePeriodicallyWithInitialDelay(java.lang.Object timerKey, java.time.Duration initialDelay, java.time.Duration interval)
Schedule timer to callonTimer(java.lang.Object)
periodically with the given interval after the specified initial delay.protected void
schedulePeriodicallyWithInitialDelay(java.lang.Object timerKey, scala.concurrent.duration.FiniteDuration initialDelay, scala.concurrent.duration.FiniteDuration interval)
Schedule timer to callonTimer(java.lang.Object)
periodically with the given interval after the specified initial delay.-
Methods inherited from class akka.stream.stage.GraphStageLogic
abortEmitting, abortReading, attributes, attributes_$eq, beforePreStart, cancel, cancelStage, complete, completeStage, conditionalTerminateInput, conditionalTerminateOutput, createAsyncCallback, eagerTerminateInput, eagerTerminateOutput, emit, emit, emit, emitMultiple, emitMultiple, emitMultiple, emitMultiple, emitMultiple, emitMultiple, fail, failStage, getAsyncCallback, getEagerStageActor, getHandler, getHandler, getStageActor, grab, handlers, hasBeenPulled, ignoreTerminateInput, ignoreTerminateOutput, inCount, inHandler, interpreter, interpreter_$eq, isAvailable, isAvailable, isClosed, isClosed, materializer, NoPromise, onFeedbackDispatched, originalStage, originalStage_$eq, outCount, outHandler, passAlong, passAlong$default$3, passAlong$default$4, passAlong$default$5, portToConn, postStop, preStart, pull, push, read, read, readN, readN, setHandler, setHandler, setHandlers, setKeepGoing, stageActor, stageActorName, stageId, stageId_$eq, subFusingMaterializer, totallyIgnorantInput, tryPull
-
-
-
-
Constructor Detail
-
TimerGraphStageLogic
public TimerGraphStageLogic(Shape _shape)
-
-
Method Detail
-
afterPostStop
protected void afterPostStop()
Description copied from class:GraphStageLogic
INTERNAL API- Overrides:
afterPostStop
in classGraphStageLogic
-
cancelTimer
protected final void cancelTimer(java.lang.Object timerKey)
Cancel timer, ensuring that theonTimer(java.lang.Object)
is not subsequently called.- Parameters:
timerKey
- key of the timer to cancel
-
isTimerActive
protected final boolean isTimerActive(java.lang.Object timerKey)
Inquire whether the timer is still active. Returns true unless the timer does not exist, has previously been canceled or if it was a single-shot timer that was already triggered.- Parameters:
timerKey
- (undocumented)- Returns:
- (undocumented)
-
onTimer
protected void onTimer(java.lang.Object timerKey) throws java.lang.Exception
Will be called when the scheduled timer is triggered.- Parameters:
timerKey
- key of the scheduled timer- Throws:
java.lang.Exception
-
scheduleOnce
protected final void scheduleOnce(java.lang.Object timerKey, scala.concurrent.duration.FiniteDuration delay)
Schedule timer to callonTimer(java.lang.Object)
after given delay. Any existing timer with the same key will automatically be canceled before adding the new timer.- Parameters:
timerKey
- (undocumented)delay
- (undocumented)
-
scheduleOnce
protected final void scheduleOnce(java.lang.Object timerKey, java.time.Duration delay)
Schedule timer to callonTimer(java.lang.Object)
after given delay. Any existing timer with the same key will automatically be canceled before adding the new timer.- Parameters:
timerKey
- (undocumented)delay
- (undocumented)
-
schedulePeriodically
protected final void schedulePeriodically(java.lang.Object timerKey, scala.concurrent.duration.FiniteDuration interval)
Schedule timer to callonTimer(java.lang.Object)
periodically with the given interval. Any existing timer with the same key will automatically be canceled before adding the new timer.- Parameters:
timerKey
- (undocumented)interval
- (undocumented)
-
schedulePeriodically
protected final void schedulePeriodically(java.lang.Object timerKey, java.time.Duration interval)
Schedule timer to callonTimer(java.lang.Object)
periodically with the given interval. Any existing timer with the same key will automatically be canceled before adding the new timer.- Parameters:
timerKey
- (undocumented)interval
- (undocumented)
-
schedulePeriodicallyWithInitialDelay
protected final void schedulePeriodicallyWithInitialDelay(java.lang.Object timerKey, scala.concurrent.duration.FiniteDuration initialDelay, scala.concurrent.duration.FiniteDuration interval)
Schedule timer to callonTimer(java.lang.Object)
periodically with the given interval after the specified initial delay. Any existing timer with the same key will automatically be canceled before adding the new timer.- Parameters:
timerKey
- (undocumented)initialDelay
- (undocumented)interval
- (undocumented)
-
schedulePeriodicallyWithInitialDelay
protected final void schedulePeriodicallyWithInitialDelay(java.lang.Object timerKey, java.time.Duration initialDelay, java.time.Duration interval)
Schedule timer to callonTimer(java.lang.Object)
periodically with the given interval after the specified initial delay. Any existing timer with the same key will automatically be canceled before adding the new timer.- Parameters:
timerKey
- (undocumented)initialDelay
- (undocumented)interval
- (undocumented)
-
-