Package dev.getelements.elements.rt

Interface Scheduler

All Known Implementing Classes:

SimpleScheduler

public interface Scheduler

The Scheduler is the main entry point dispatching requests and operations to the various Resource instances contained in the underlying services. This allows for both immediate and timed dispatches of various operations to Resource instances and is responsible for coordinating and serializing access to each Resource. Created by patricktwohig on 8/22/15.

Method Summary

Modifier and Type	Method	Description
<T> Future<T>	perform(ResourceId resourceId, Function<ResourceService.ResourceTransaction,T> operation, Consumer<Throwable> failure)	Performs an action against the resource with the provided ResourceId.
<T> Future<T>	perform(Path path, Function<ResourceService.ResourceTransaction,T> operation, Consumer<Throwable> failure)	Performs an action against the resource with the provided ResourceId
<T> Future<T>	performAfterDelay(ResourceId resourceId, long time, TimeUnit timeUnit, Function<ResourceService.ResourceTransaction,T> operation, Consumer<Throwable> failure)	Performs the supplied Function<Resource,T> after a specified delay.
default Future<Void>	performAfterDelayV(ResourceId resourceId, long time, TimeUnit timeUnit, Consumer<ResourceService.ResourceTransaction> operation, Consumer<Throwable> failure)	Invoke performAfterDelay(ResourceId, long, TimeUnit, Function, Consumer) with a Consumer<Resource> instead of a Function<Resource,?>.
default Future<Void>	performV(ResourceId resourceId, Consumer<ResourceService.ResourceTransaction> operation, Consumer<Throwable> failure)	Performs an action against the resource with the provided ID.
default Future<Void>	performV(Path path, Consumer<ResourceService.ResourceTransaction> operation, Consumer<Throwable> failure)	Performs an action against the resource with the provided Path.
default Future<Void>	resumeTask(TaskId taskId, Consumer<Throwable> failure)	Resumes the task associated with the supplied TaskId.
default Future<Void>	resumeTaskAfterDelay(TaskId taskId, long time, TimeUnit timeUnit, Runnable resumed, Consumer<Throwable> failure)	Resumes the task associated with the supplied TaskId.
RunnableFuture<Void>	scheduleDestruction(ResourceId resourceId, long delay, TimeUnit timeUnit)	Provided the ResourceId, this will schedule destruction at some point in the near future, but not before.
RunnableFuture<Void>	scheduleUnlink(Path path, long delay, TimeUnit timeUnit)	Provided the Path, this will schedule an unlink operation at some point in the near future, but not before the delay time specified in the parameters of this method.
default void	start()	Starts the Scheduler.
default void	stop()	Shuts down the Scheduler.
<T> Future<T>	submit(Callable<T> tCallable)	Submits an arbitrary Callable<T> to run within the Scheduler.
default Future<Void>	submitV(Runnable runnable)	Submits an arbitrary Runnable to run within the Scheduler.

Method Details

submitV

default Future<Void> submitV(Runnable runnable)

Submits an arbitrary Runnable to run within the Scheduler.

Parameters:

runnable - the Runnable to run

Returns:

a Future<Void> to control the execution state of the task

submit

<T> Future<T> submit(Callable<T> tCallable)

Submits an arbitrary Callable<T> to run within the Scheduler.

Parameters:

tCallable - the Callable<T> to run

Returns:

a Future<T> to control the execution state of the task

scheduleUnlink

RunnableFuture<Void> scheduleUnlink(Path path,
 long delay,
 TimeUnit timeUnit)

Provided the Path, this will schedule an unlink operation at some point in the near future, but not before the delay time specified in the parameters of this method. Any pending operations to relase their locks gracefully unlink an potentially destroy any Resources associated with the supplied Path. If the Resource is removed this will ensure that the Resource.close() method is called appropriately. This returns a RunnableFuture<Void> which may be run sooner to short-circuit the unlink operation

Parameters:

path - the Path to unlink

Returns:

a RunnableFuture<Void> used to signal destruction, may be run sooner by the calling code

scheduleDestruction

RunnableFuture<Void> scheduleDestruction(ResourceId resourceId,
 long delay,
 TimeUnit timeUnit)

Provided the ResourceId, this will schedule destruction at some point in the near future, but not before. the delay specified in the arguments to this method. This allows any pending operations to scheduleRelease their locks gracefully and destroy the Resource associated with the supplied. ResourceId. This ensures that the underlying Resource is removed from the ResourceService and its Resource.close() method invoked. This returns a RunnableFuture<Void> which may be run sooner to short-circuit the unlink operation

Parameters:

resourceId - the ResourceId

Returns:

a RunnableFuture<Void> used to signal destruction, may be run sooner by the calling code

perform

<T> Future<T> perform(ResourceId resourceId,
 Function<ResourceService.ResourceTransaction,T> operation,
 Consumer<Throwable> failure)

Performs an action against the resource with the provided ResourceId.

Parameters:

resourceId - the id of the resource

operation - the operation to perform

Returns:

Future<T> which can be used to monitor the status of the request

performV

default Future<Void> performV(ResourceId resourceId,
 Consumer<ResourceService.ResourceTransaction> operation,
 Consumer<Throwable> failure)

Performs an action against the resource with the provided ID.

Parameters:

resourceId - the id of the resource

operation - the operation to perform

Returns:

Future<Void> which can be used to monitor the status of the request

perform

<T> Future<T> perform(Path path,
 Function<ResourceService.ResourceTransaction,T> operation,
 Consumer<Throwable> failure)

Performs an action against the resource with the provided ResourceId

Type Parameters:

T -

Parameters:

path - the path of the resource

operation - the operation to perform

Returns:

Future<T> which can be used to monitor the status of the request

performV

default Future<Void> performV(Path path,
 Consumer<ResourceService.ResourceTransaction> operation,
 Consumer<Throwable> failure)

Performs an action against the resource with the provided Path.

Parameters:

path - the path of the resource

operation - the operation to perform

Returns:

Future<Void> which can be used to monitor the status of the request

performAfterDelay

<T> Future<T> performAfterDelay(ResourceId resourceId,
 long time,
 TimeUnit timeUnit,
 Function<ResourceService.ResourceTransaction,T> operation,
 Consumer<Throwable> failure)

Performs the supplied Function<Resource,T> after a specified delay. The delay is calculated using the supplied time and TimeUnit.

Type Parameters:

T -

Parameters:

resourceId - the id of the resource

time - the time value to delay

timeUnit - the units of the time value

operation - the operation to perform

Returns:

Future<T> which can be used to monitor the status of the request

performAfterDelayV

default Future<Void> performAfterDelayV(ResourceId resourceId,
 long time,
 TimeUnit timeUnit,
 Consumer<ResourceService.ResourceTransaction> operation,
 Consumer<Throwable> failure)

Invoke performAfterDelay(ResourceId, long, TimeUnit, Function, Consumer) with a Consumer<Resource> instead of a Function<Resource,?>.

Parameters:

resourceId - the id of the resource

time - the time value to delay

timeUnit - the units of the time value

operation - the operation to perform

Returns:

Future<Void> which can be used to monitor the status of the request

resumeTask

default Future<Void> resumeTask(TaskId taskId,
 Consumer<Throwable> failure)

Resumes the task associated with the supplied TaskId. This allows for the specification of a delay after a specified period of time.

Parameters:

taskId - the TaskId of the task

Returns:

Future<Void> which can be used to monitor the status of the request

resumeTaskAfterDelay

default Future<Void> resumeTaskAfterDelay(TaskId taskId,
 long time,
 TimeUnit timeUnit,
 Runnable resumed,
 Consumer<Throwable> failure)

Resumes the task associated with the supplied TaskId. This allows for the specification of a delay after a specified period of time.

Parameters:

taskId - the TaskId of the task

time - the time delay

timeUnit - the TimeUnit instance designating the time units of measure

resumed - a Runnable that will execute when the task has been resumed successfully

Returns:

Future<Void> which can be used to monitor the status of the request

stop

default void stop()
           throws IllegalStateException

Shuts down the Scheduler. Attempting to invoke any the other methods after invoking this will result in an IllegalStateException until a subsequent call to start() is made.

Throws:

IllegalStateException

start

default void start()
            throws IllegalStateException

Starts the Scheduler. Attempting to invoke any the other methods before invoking this will result in an IllegalStateException.

Throws:

IllegalStateException