Package io.camunda.zeebe.scheduler

Class DelayedTimerSubscription

java.lang.Object

io.camunda.zeebe.scheduler.DelayedTimerSubscription

All Implemented Interfaces:

ActorSubscription, ScheduledTimer, TimerSubscription, Runnable

public final class DelayedTimerSubscription
extends Object
implements TimerSubscription

A TimerSubscription based on a delay. Scheduling requires an external clock to determine the exact timestamp. This type of timer subscription can be triggered once, or recur until canceled.

Constructor Summary

Constructors

Constructor	Description
DelayedTimerSubscription(ActorJob job, long delay, TimeUnit timeUnit, boolean isRecurring)

Method Summary

Modifier and Type	Method	Description
void	cancel()
long	getDeadline(ActorClock now)
ActorJob	getJob()	called by the ActorThread after ActorSubscription.poll() returned true to get the job to be run
long	getTimerExpiredAt()
long	getTimerId()
TimeUnit	getTimeUnit()
boolean	isRecurring()	Returns true in case the subscription is recurring (ie. after the job finished, the subscription is re-created
void	onJobCompleted()	callback received as the job returned by ActorSubscription.getJob() completes execution.
void	onTimerExpired(TimeUnit timeUnit, long now)
boolean	poll()	called by the ActorThread to determine whether the subscription has work available.
void	run()
void	setTimerId(long timerId)
void	submit()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.camunda.zeebe.scheduler.ActorSubscription

triggersInPhase

Constructor Details

DelayedTimerSubscription

public DelayedTimerSubscription(ActorJob job,
 long delay,
 TimeUnit timeUnit,
 boolean isRecurring)

Method Details

poll

public boolean poll()

Description copied from interface: ActorSubscription

called by the ActorThread to determine whether the subscription has work available.

Specified by:

poll in interface ActorSubscription

Specified by:

poll in interface TimerSubscription

getJob

public ActorJob getJob()

Description copied from interface: ActorSubscription

called by the ActorThread after ActorSubscription.poll() returned true to get the job to be run

Specified by:

getJob in interface ActorSubscription

Specified by:

getJob in interface TimerSubscription

isRecurring

public boolean isRecurring()

Description copied from interface: ActorSubscription

Returns true in case the subscription is recurring (ie. after the job finished, the subscription is re-created

Specified by:

isRecurring in interface ActorSubscription

Specified by:

isRecurring in interface TimerSubscription

onJobCompleted

public void onJobCompleted()

Description copied from interface: ActorSubscription

callback received as the job returned by ActorSubscription.getJob() completes execution.

Specified by:

onJobCompleted in interface ActorSubscription

Specified by:

onJobCompleted in interface TimerSubscription

cancel

public void cancel()

Specified by:

cancel in interface ActorSubscription

Specified by:

cancel in interface ScheduledTimer

Specified by:

cancel in interface TimerSubscription

getTimerId

public long getTimerId()

Specified by:

getTimerId in interface TimerSubscription

setTimerId

public void setTimerId(long timerId)

Specified by:

setTimerId in interface TimerSubscription

submit

public void submit()

Specified by:

submit in interface TimerSubscription

getDeadline

public long getDeadline(ActorClock now)

Specified by:

getDeadline in interface TimerSubscription

onTimerExpired

public void onTimerExpired(TimeUnit timeUnit,
 long now)

Specified by:

onTimerExpired in interface TimerSubscription

run

public void run()

Specified by:

run in interface Runnable

Specified by:

run in interface TimerSubscription

getTimerExpiredAt

public long getTimerExpiredAt()

Specified by:

getTimerExpiredAt in interface TimerSubscription

getTimeUnit

public TimeUnit getTimeUnit()

toString

public String toString()

Overrides:

toString in class Object