io.zeebe.util.sched

Class ActorControl

java.lang.Object

io.zeebe.util.sched.ActorControl

public class ActorControl
extends Object

Constructor Summary

Constructors

Constructor and Description
ActorControl(Actor actor)

Method Summary

Modifier and Type	Method and Description
<T> ActorFuture<T>	call(Callable<T> callable) Callables actions are called while the actor is in the following actor lifecycle phases: ActorTask.ActorLifecyclePhase.STARTED
ActorFuture<Void>	call(Runnable action) Callables actions are called while the actor is in the following actor lifecycle phases: ActorTask.ActorLifecyclePhase.STARTED
ActorFuture<Void>	close()
ChannelSubscription	consume(ConsumableChannel channel, Runnable consumer) Consumers are called while the actor is in the following actor lifecycle phases: ActorTask.ActorLifecyclePhase.STARTED
void	done()
ActorTask.ActorLifecyclePhase	getLifecyclePhase()
boolean	isCalledFromWithinActor(ActorJob job)
boolean	isClosing()
ActorCondition	onCondition(String conditionName, Runnable conditionAction) Conditional actions are called while the actor is in the following actor lifecycle phases: ActorTask.ActorLifecyclePhase.STARTED
void	pollBlocking(Runnable condition, Runnable action)
void	run(Runnable action) Runnables submitted by the actor itself are executed while the actor is in any of its lifecycle phases.
ScheduledTimer	runAtFixedRate(java.time.Duration delay, Runnable runnable) Scheduled a repeating timer
void	runBlocking(Runnable runnable) run a blocking task
void	runBlocking(Runnable runnable, java.util.function.Consumer<Throwable> completionConsumer) The provided runnable is executed in any of the actor's lifecycle phases.
ScheduledTimer	runDelayed(java.time.Duration delay, Runnable runnable) The runnable is is executed while the actor is in the following actor lifecycle phases: ActorTask.ActorLifecyclePhase.STARTED
<T> void	runOnCompletion(ActorFuture<T> future, java.util.function.BiConsumer<T,Throwable> callback) Invoke the callback when the given future is completed (successfully or exceptionally).
<T> void	runOnCompletion(Collection<ActorFuture<T>> futures, java.util.function.Consumer<Throwable> callback) Invoke the callback when the given futures are completed (successfully or exceptionally).
<T> void	runOnCompletionBlockingCurrentPhase(ActorFuture<T> future, java.util.function.BiConsumer<T,Throwable> callback) Invoke the callback when the given future is completed (successfully or exceptionally).
<T> void	runOnFirstCompletion(Collection<ActorFuture<T>> futures, java.util.function.BiConsumer<T,Throwable> callback) Invoke the callback when the first future is completed successfully, or when all futures are completed exceptionally.
<T> void	runOnFirstCompletion(Collection<ActorFuture<T>> futures, java.util.function.BiConsumer<T,Throwable> callback, java.util.function.Consumer<T> closer) Invoke the callback when the first future is completed successfully, or when all futures are completed exceptionally.
void	runUntilDone(Runnable runnable) Run the provided runnable repeatedly until it calls done().
void	setPriority(ActorPriority priority)
void	setSchedulingHints(int hints) changes the actor's scheduling hints.
void	submit(Runnable action) Like run(Runnable) but submits the runnable to the end end of the actor's queue such that other other actions may be executed before this.
void	yield() can be called by the actor to yield the thread

Methods inherited from class java.lang.Object

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

Constructor Detail

ActorControl

public ActorControl(Actor actor)

Method Detail

setSchedulingHints

public void setSchedulingHints(int hints)

changes the actor's scheduling hints. For example, this makes it possible to transform a cpu-bound actor into an io-bound actor and vice versa.

Parameters:

hints - the changed scheduling hints

consume

public ChannelSubscription consume(ConsumableChannel channel,
                                   Runnable consumer)

Consumers are called while the actor is in the following actor lifecycle phases: ActorTask.ActorLifecyclePhase.STARTED

Parameters:

channel -

consumer -

pollBlocking

public void pollBlocking(Runnable condition,
                         Runnable action)

onCondition

public ActorCondition onCondition(String conditionName,
                                  Runnable conditionAction)

Conditional actions are called while the actor is in the following actor lifecycle phases: ActorTask.ActorLifecyclePhase.STARTED

Parameters:

conditionName -

conditionAction -

Returns:

call

public <T> ActorFuture<T> call(Callable<T> callable)

Callables actions are called while the actor is in the following actor lifecycle phases: ActorTask.ActorLifecyclePhase.STARTED

Parameters:

callable -

Returns:

call

public ActorFuture<Void> call(Runnable action)

Callables actions are called while the actor is in the following actor lifecycle phases: ActorTask.ActorLifecyclePhase.STARTED

Parameters:

action -

Returns:

run

public void run(Runnable action)

Runnables submitted by the actor itself are executed while the actor is in any of its lifecycle phases.

Runnables submitted externally are executed while the actor is in the following actor lifecycle phases: ActorTask.ActorLifecyclePhase.STARTED

Parameters:

action -

runBlocking

public void runBlocking(Runnable runnable)

run a blocking task

The provided runnable is executed in any of the actor's lifecycle phases.

runBlocking

public void runBlocking(Runnable runnable,
                        java.util.function.Consumer<Throwable> completionConsumer)

The provided runnable is executed in any of the actor's lifecycle phases. The provided completionConsumer is only executed while the actor is in one of the following lifecycle phases ActorTask.ActorLifecyclePhase.STARTED.

Parameters:

runnable -

completionConsumer -

runUntilDone

public void runUntilDone(Runnable runnable)

Run the provided runnable repeatedly until it calls done(). To be used for jobs which may experience backpressure.

runDelayed

public ScheduledTimer runDelayed(java.time.Duration delay,
                                 Runnable runnable)

The runnable is is executed while the actor is in the following actor lifecycle phases: ActorTask.ActorLifecyclePhase.STARTED

Parameters:

delay -

runnable -

Returns:

submit

public void submit(Runnable action)

Like run(Runnable) but submits the runnable to the end end of the actor's queue such that other other actions may be executed before this. This method is useful in case an actor is in a (potentially endless) loop and it should be able to interrupt it.

The runnable is is executed while the actor is in the following actor lifecycle phases: ActorTask.ActorLifecyclePhase.STARTED

Parameters:

action - the action to run.

runAtFixedRate

public ScheduledTimer runAtFixedRate(java.time.Duration delay,
                                     Runnable runnable)

Scheduled a repeating timer

The runnable is is executed while the actor is in the following actor lifecycle phases: ActorTask.ActorLifecyclePhase.STARTED

Parameters:

delay -

runnable -

Returns:

runOnCompletion

public <T> void runOnCompletion(ActorFuture<T> future,
                                java.util.function.BiConsumer<T,Throwable> callback)

Invoke the callback when the given future is completed (successfully or exceptionally). This call does not block the actor. If close is requested the actor will not wait on this future, in this case the callback is never called.

The callback is is executed while the actor is in the following actor lifecycle phases: ActorTask.ActorLifecyclePhase.STARTED

Parameters:

future - the future to wait on

callback - the callback that handle the future's result. The throwable is null when the future is completed successfully.

runOnCompletionBlockingCurrentPhase

public <T> void runOnCompletionBlockingCurrentPhase(ActorFuture<T> future,
                                                    java.util.function.BiConsumer<T,Throwable> callback)

Invoke the callback when the given future is completed (successfully or exceptionally). This call does not block the actor. If close is requested the actor will wait on this future and not change the phase, in this case the callback will eventually called.

The callback is is executed while the actor is in the following actor lifecycle phases: ActorTask.ActorLifecyclePhase.STARTED

Parameters:

future - the future to wait on

callback - the callback that handle the future's result. The throwable is null when the future is completed successfully.

runOnCompletion

public <T> void runOnCompletion(Collection<ActorFuture<T>> futures,
                                java.util.function.Consumer<Throwable> callback)

Invoke the callback when the given futures are completed (successfully or exceptionally). This call does not block the actor.

The callback is is executed while the actor is in the following actor lifecycle phases: ActorTask.ActorLifecyclePhase.STARTED

Parameters:

futures - the futures to wait on

callback - The throwable is null when all futures are completed successfully. Otherwise, it holds the exception of the last completed future.

runOnFirstCompletion

public <T> void runOnFirstCompletion(Collection<ActorFuture<T>> futures,
                                     java.util.function.BiConsumer<T,Throwable> callback)

Invoke the callback when the first future is completed successfully, or when all futures are completed exceptionally. This call does not block the actor.

The callback is is executed while the actor is in the following actor lifecycle phases: ActorTask.ActorLifecyclePhase.STARTED

Parameters:

futures - the futures to wait on

callback - the callback that handle the future's result. The throwable is null when the first future is completed successfully. Otherwise, it holds the exception of the last completed future.

runOnFirstCompletion

public <T> void runOnFirstCompletion(Collection<ActorFuture<T>> futures,
                                     java.util.function.BiConsumer<T,Throwable> callback,
                                     java.util.function.Consumer<T> closer)

Invoke the callback when the first future is completed successfully, or when all futures are completed exceptionally. This call does not block the actor.

The callback is is executed while the actor is in the following actor lifecycle phases: ActorTask.ActorLifecyclePhase.STARTED

Parameters:

futures - the futures to wait on

callback - the callback that handle the future's result. The throwable is null when the first future is completed successfully. Otherwise, it holds the exception of the last completed future.

closer - the callback that is invoked when a future is completed after the first future is completed

yield

public void yield()

can be called by the actor to yield the thread

close

public ActorFuture<Void> close()

done

public void done()

isClosing

public boolean isClosing()

setPriority

public void setPriority(ActorPriority priority)

getLifecyclePhase

public ActorTask.ActorLifecyclePhase getLifecyclePhase()

isCalledFromWithinActor

public boolean isCalledFromWithinActor(ActorJob job)