Package io.camunda.zeebe.scheduler

Interface TimerSubscription

All Superinterfaces:

ActorSubscription, Runnable, ScheduledTimer

All Known Implementing Classes:

DelayedTimerSubscription, StampedTimerSubscription

public interface TimerSubscription
extends ActorSubscription, ScheduledTimer, Runnable

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()
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()

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

triggersInPhase

Method Details

poll

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

getJob

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

isRecurring

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

onJobCompleted

void onJobCompleted()

Description copied from interface: ActorSubscription

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

Specified by:

onJobCompleted in interface ActorSubscription

cancel

void cancel()

Specified by:

cancel in interface ActorSubscription

Specified by:

cancel in interface ScheduledTimer

getTimerId

long getTimerId()

setTimerId

void setTimerId(long timerId)

submit

void submit()

getDeadline

long getDeadline(ActorClock now)

onTimerExpired

void onTimerExpired(TimeUnit timeUnit,
 long now)

run

void run()

Specified by:

run in interface Runnable

getTimerExpiredAt

long getTimerExpiredAt()