io.zeebe.util.sched.channel

Class ChannelConsumerCondition

java.lang.Object

io.zeebe.util.sched.channel.ChannelConsumerCondition

All Implemented Interfaces:

ActorCondition, ActorSubscription, ChannelSubscription

public class ChannelConsumerCondition
extends Object
implements ActorCondition, ActorSubscription, ChannelSubscription

Constructor Summary

Constructors

Constructor and Description
ChannelConsumerCondition(ActorJob job, ConsumableChannel channel)

Method Summary

Modifier and Type	Method and Description
void	cancel()
ActorJob	getJob() called by the ActorThread after ActorSubscription.poll() returned true to get the job to be run
boolean	isRecurring() Returns true in case the subscription is recurring (ie.
void	onJobCompleted() callback received as the job returned by ActorSubscription.getJob() completes execution.
boolean	poll() called by the ActorThread to determine whether the subscription has work available.
void	signal() notify that the condition is met (true)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.zeebe.util.sched.ActorSubscription

triggersInPhase

Constructor Detail

ChannelConsumerCondition

public ChannelConsumerCondition(ActorJob job,
                                ConsumableChannel channel)

Method Detail

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

signal

public void signal()

Description copied from interface: ActorCondition

notify that the condition is met (true)

Specified by:

signal in interface ActorCondition

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

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

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

cancel

public void cancel()

Specified by:

cancel in interface ActorCondition

Specified by:

cancel in interface ActorSubscription

Specified by:

cancel in interface ChannelSubscription