io.zeebe.util.sched

Class ActorScheduler

java.lang.Object

io.zeebe.util.sched.ActorScheduler

public class ActorScheduler
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ActorScheduler.ActorSchedulerBuilder
static interface	ActorScheduler.ActorThreadFactory
static class	ActorScheduler.BlockingTasksThreadFactory
static class	ActorScheduler.DefaultActorThreadFactory

Constructor Summary

Constructors

Constructor and Description
ActorScheduler(ActorScheduler.ActorSchedulerBuilder builder)

Method Summary

Modifier and Type	Method and Description
MetricsManager	getMetricsManager()
static ActorScheduler.ActorSchedulerBuilder	newActorScheduler()
static ActorScheduler	newDefaultActorScheduler()
void	setBlockingTasksShutdownTime(java.time.Duration shutdownTime)
void	start()
Future<Void>	stop()
ActorFuture<Void>	submitActor(Actor actor) Submits an non-blocking, CPU-bound actor.
ActorFuture<Void>	submitActor(Actor actor, boolean collectTaskMetrics) Submits an non-blocking, CPU-bound actor.
ActorFuture<Void>	submitActor(Actor actor, boolean collectTaskMetrics, int schedulingHints) Submits an actor providing hints to the scheduler about how to best schedule the actor.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActorScheduler

public ActorScheduler(ActorScheduler.ActorSchedulerBuilder builder)

Method Detail

submitActor

public ActorFuture<Void> submitActor(Actor actor)

Submits an non-blocking, CPU-bound actor.

Parameters:

actor - the actor to submit

submitActor

public ActorFuture<Void> submitActor(Actor actor,
                                     boolean collectTaskMetrics)

Submits an non-blocking, CPU-bound actor.

Parameters:

actor - the actor to submit

collectTaskMetrics - controls whether metrics should be written for this actor. This has the overhead cost (time & memory) for allocating the counters which are used to record the metrics. Generally, metrics should not be recorded for short-lived tasks but only make sense for long-lived tasks where a small overhead when initially submitting the actor is acceptable.

submitActor

public ActorFuture<Void> submitActor(Actor actor,
                                     boolean collectTaskMetrics,
                                     int schedulingHints)

Submits an actor providing hints to the scheduler about how to best schedule the actor. Actors must always be non-blocking. On top of that, the scheduler distinguishes

• CPU-bound actors: actors which perform no or very little blocking I/O. It is possible to specify a priority.
• I/O-bound actors: actors where the runtime is dominated by performing blocking I/O (usually filesystem writes). It is possible to specify the I/O device used by the actor.

Scheduling hints can be created using the SchedulingHints class.

Parameters:

actor - the actor to submit

collectTaskMetrics - controls whether metrics should be written for this actor. This has the overhead cost (time & memory) for allocating the counters which are used to record the metrics. Generally, metrics should not be recorded for short-lived tasks but only make sense for long-lived tasks where a small overhead when initially submitting the actor is acceptable.

schedulingHints - additional scheduling hint

start

public void start()

stop

public Future<Void> stop()

setBlockingTasksShutdownTime

public void setBlockingTasksShutdownTime(java.time.Duration shutdownTime)

newActorScheduler

public static ActorScheduler.ActorSchedulerBuilder newActorScheduler()

newDefaultActorScheduler

public static ActorScheduler newDefaultActorScheduler()

getMetricsManager

public MetricsManager getMetricsManager()