Package com.glitchybyte.glib.concurrent

Class GTaskSchedulerService

java.lang.Object

com.glitchybyte.glib.concurrent.GTaskExecutorService<ScheduledExecutorService>

com.glitchybyte.glib.concurrent.GTaskSchedulerService

All Implemented Interfaces:

GTaskScheduler, AutoCloseable, Executor

public final class GTaskSchedulerService
extends GTaskExecutorService<ScheduledExecutorService>
implements GTaskScheduler

A scheduler utility on top of ScheduledExecutorService.

This class standardizes the interface to use Duration for timings.

Field Summary

Fields inherited from class com.glitchybyte.glib.concurrent.GTaskExecutorService

runner

Constructor Summary

Constructors

Constructor	Description
GTaskSchedulerService()	Creates a task scheduler with a single worker thread.
GTaskSchedulerService(Integer threadCount)	Creates a task scheduler with a fixed thread pool.
GTaskSchedulerService(ScheduledExecutorService runner)	Creates a task scheduler with the given ScheduledExecutorService.

Method Summary

Modifier and Type	Method	Description
GCancelable	schedule(Duration delay, Runnable runnable)	Schedules a one-shot task.
GCancelable	scheduleAtFixedRate(Duration initialDelay, Duration period, Runnable runnable)	Schedules a task to run at a fixed delay.
GCancelable	scheduleWithFixedDelay(Duration initialDelay, Duration delay, Runnable runnable)	Schedules a task at a delay after each run.

Methods inherited from class com.glitchybyte.glib.concurrent.GTaskExecutorService

close, createTaskWrapper, execute

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.concurrent.Executor

execute

Constructor Details

GTaskSchedulerService

public GTaskSchedulerService()

Creates a task scheduler with a single worker thread.

GTaskSchedulerService

public GTaskSchedulerService(Integer threadCount)

Creates a task scheduler with a fixed thread pool.

Parameters:

threadCount - Thread count for this scheduler.

GTaskSchedulerService

public GTaskSchedulerService(ScheduledExecutorService runner)

Creates a task scheduler with the given ScheduledExecutorService.

This scheduler owns the given ScheduledExecutorService and will shut it down and close it when the scheduler is closed.

Parameters:

runner - ScheduledExecutorService to use as scheduler.

Method Details

schedule

public GCancelable schedule(Duration delay,
 Runnable runnable)

Description copied from interface: GTaskScheduler

Schedules a one-shot task.

Specified by:

schedule in interface GTaskScheduler

Parameters:

delay - Delay before task execution.

runnable - Task to schedule.

Returns:

A GCancelable to cancel the task.

scheduleAtFixedRate

public GCancelable scheduleAtFixedRate(Duration initialDelay,
 Duration period,
 Runnable runnable)

Description copied from interface: GTaskScheduler

Schedules a task to run at a fixed delay.

Specified by:

scheduleAtFixedRate in interface GTaskScheduler

Parameters:

initialDelay - Delay before task execution.

period - Cadence at which tasks run.

runnable - Task to schedule.

Returns:

A GCancelable to cancel the task.

scheduleWithFixedDelay

public GCancelable scheduleWithFixedDelay(Duration initialDelay,
 Duration delay,
 Runnable runnable)

Description copied from interface: GTaskScheduler

Schedules a task at a delay after each run.

Specified by:

scheduleWithFixedDelay in interface GTaskScheduler

Parameters:

initialDelay - Delay before task execution.

delay - Delay after task execution.

runnable - Task to schedule.

Returns:

A GCancelable to cancel the task.