io.zeebe.util.sched

Interface ActorSubscription

All Known Implementing Classes:

ActorConditionImpl, ActorFutureSubscription, BlockingPollSubscription, ChannelConsumerCondition, TimerSubscription

public interface ActorSubscription

Subscription to some external source of work / jobs.

Method Summary

Modifier and Type	Method and Description
default void	cancel()
ActorJob	getJob() called by the ActorThread after poll() returned true to get the job to be run
boolean	isRecurring() Returns true in case the subscription is recurring (ie.
default void	onJobCompleted() callback received as the job returned by getJob() completes execution.
boolean	poll() called by the ActorThread to determine whether the subscription has work available.
default boolean	triggersInPhase(ActorTask.ActorLifecyclePhase phase) returns true if the subscription should be able to trigger in the provided phase

Method Detail

triggersInPhase

default boolean triggersInPhase(ActorTask.ActorLifecyclePhase phase)

returns true if the subscription should be able to trigger in the provided phase

poll

boolean poll()

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

getJob

ActorJob getJob()

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

isRecurring

boolean isRecurring()

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

onJobCompleted

default void onJobCompleted()

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

cancel

default void cancel()