org.redisson.api.RScheduledExecutorService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of redisson-all Show documentation
Show all versions of redisson-all Show documentation
Easy Redis Java client and Real-Time Data Platform. Valkey compatible. Sync/Async/RxJava3/Reactive API. Client side caching. Over 50 Redis based Java objects and services: JCache API, Apache Tomcat, Hibernate, Spring, Set, Multimap, SortedSet, Map, List, Queue, Deque, Semaphore, Lock, AtomicLong, Map Reduce, Bloom filter, Scheduler, RPC
/**
* Copyright (c) 2013-2024 Nikita Koksharov
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.redisson.api;
import java.time.Duration;
import java.util.concurrent.Callable;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
/**
* Redis based implementation of {@link java.util.concurrent.ScheduledExecutorService}
*
* @author Nikita Koksharov
*
*/
public interface RScheduledExecutorService extends RExecutorService, ScheduledExecutorService, RScheduledExecutorServiceAsync {
/**
* Synchronously schedules a Runnable task for execution asynchronously
* after the given delay. Returns a RScheduledFuture representing that task.
* The Future's {@code get} method will return the given result upon successful completion.
*
* @param command the task to execute
* @param delay the time from now to delay execution
* @param unit the time unit of the delay parameter
* @return a ScheduledFuture representing pending completion of
* the task and whose {@code get()} method will return
* {@code null} upon completion
*/
@Override
RScheduledFuture schedule(Runnable command, long delay, TimeUnit unit);
/**
* Synchronously schedules a Runnable task
* with defined id for execution asynchronously
* after the given delay.
* Returns a RScheduledFuture representing that task.
*
* @param id task id
* @param task the task to execute
* @param delay the time from now to delay execution
* @return a ScheduledFuture representing pending completion of
* the task and whose {@code get()} method will return
* {@code null} upon completion
*/
RScheduledFuture schedule(String id, Runnable task, Duration delay);
/**
* Synchronously schedules a Runnable task with defined timeToLive parameter
* for execution asynchronously after the given delay.
* Returns a RScheduledFuture representing that task.
* The Future's {@code get} method will return the given result upon successful completion.
*
* @param task the task to execute
* @param delay the time from now to delay execution
* @param unit the time unit of the delay parameter
* @param timeToLive time to live interval
* @param ttlUnit unit of time to live interval
* @return a ScheduledFuture representing pending completion of
* the task and whose {@code get()} method will return
* {@code null} upon completion
*/
RScheduledFuture schedule(Runnable task, long delay, TimeUnit unit, long timeToLive, TimeUnit ttlUnit);
/**
* Synchronously schedules a Runnable task with
* defined id and timeToLive parameters
* for execution asynchronously after the given delay.
* Returns a RScheduledFuture representing that task.
*
* @param id task id
* @param task the task to execute
* @param delay the time from now to delay execution
* @param timeToLive time to live interval
* @return a ScheduledFuture representing pending completion of
* the task and whose {@code get()} method will return
* {@code null} upon completion
*/
RScheduledFuture schedule(String id, Runnable task, Duration delay, Duration timeToLive);
/**
* Synchronously schedules a value-returning task for execution asynchronously
* after the given delay. Returns a RScheduledFuture representing that task.
* The Future's {@code get} method will return the given result upon successful completion.
*
* @param callable the function to execute
* @param delay the time from now to delay execution
* @param unit the time unit of the delay parameter
* @param the type of the callable's result
* @return a ScheduledFuture that can be used to extract result or cancel
*/
@Override
RScheduledFuture schedule(Callable callable, long delay, TimeUnit unit);
/**
* Synchronously schedules a value-returning task with defined id for execution asynchronously
* after the given delay. Returns a RScheduledFuture representing that task.
*
* @param id task id
* @param callable the function to execute
* @param delay the time from now to delay execution
* @param the type of the callable's result
* @return a ScheduledFuture that can be used to extract result or cancel
*/
RScheduledFuture schedule(String id, Callable callable, Duration delay);
/**
* Synchronously schedules a value-returning task with defined timeToLive parameter
* for execution asynchronously after the given delay.
* Returns a RScheduledFuture representing that task.
* The Future's {@code get} method will return the given result upon successful completion.
*
* @param callable the function to execute
* @param delay the time from now to delay execution
* @param unit the time unit of the delay parameter
* @param timeToLive time to live interval
* @param ttlUnit unit of time to live interval
* @param the type of the callable's result
* @return a ScheduledFuture that can be used to extract result or cancel
*/
RScheduledFuture schedule(Callable callable, long delay, TimeUnit unit, long timeToLive, TimeUnit ttlUnit);
/**
* Synchronously schedules a value-returning task
* with defined id and timeToLive parameters
* for execution asynchronously after the given delay.
* Returns a RScheduledFuture representing that task.
*
* @param id task id
* @param callable the function to execute
* @param delay the time from now to delay execution
* @param timeToLive time to live interval
* @param the type of the callable's result
* @return a ScheduledFuture that can be used to extract result or cancel
*/
RScheduledFuture schedule(String id, Callable callable, Duration delay, Duration timeToLive);
/**
* Synchronously schedules a Runnable task for execution asynchronously
* after the given initialDelay, and subsequently with the given
* period.
* Subsequent executions are stopped if any execution of the task throws an exception.
* Otherwise, task could be terminated via cancellation or
* termination of the executor.
*
* @param task the task to execute
* @param initialDelay the time to delay first execution
* @param period the period between successive executions
* @param unit the time unit of the initialDelay and period parameters
* @return a ScheduledFuture representing pending completion of
* the task, and whose {@code get()} method will throw an
* exception upon cancellation
*/
@Override
RScheduledFuture scheduleAtFixedRate(Runnable task, long initialDelay, long period, TimeUnit unit);
/**
* Synchronously schedules a Runnable task with defined id
* for execution asynchronously after the given initialDelay,
* and subsequently with the given period.
* Subsequent executions are stopped if any execution of the task throws an exception.
* Otherwise, task could be terminated via cancellation or
* termination of the executor.
*
* @param id task id
* @param task the task to execute
* @param initialDelay the time to delay first execution
* @param period the period between successive executions
* @return a ScheduledFuture representing pending completion of
* the task, and whose {@code get()} method will throw an
* exception upon cancellation
*/
RScheduledFuture scheduleAtFixedRate(String id, Runnable task, Duration initialDelay, Duration period);
/**
* Synchronously schedules a Runnable task for execution asynchronously
* after the given initialDelay, and subsequently with the given
* delay started from the task finishing moment.
* Subsequent executions are stopped if any execution of the task throws an exception.
* Otherwise, task could be terminated via cancellation or
* termination of the executor.
*
* @param task the task to execute
* @param initialDelay the time to delay first execution
* @param delay the delay between the termination of one
* execution and the commencement of the next
* @param unit the time unit of the initialDelay and delay parameters
* @return a ScheduledFuture representing pending completion of
* the task, and whose {@code get()} method will throw an
* exception upon cancellation
*/
@Override
RScheduledFuture scheduleWithFixedDelay(Runnable task, long initialDelay, long delay, TimeUnit unit);
/**
* Synchronously schedules a Runnable task with
* specified id for execution asynchronously
* after the given initialDelay, and subsequently with the given
* delay started from the task finishing moment.
* Subsequent executions are stopped if any execution of the task throws an exception.
* Otherwise, task could be terminated via cancellation or
* termination of the executor.
*
* @param id task id
* @param task the task to execute
* @param initialDelay the time to delay first execution
* @param delay the delay between the termination of one
* execution and the commencement of the next
* @return a ScheduledFuture representing pending completion of
* the task, and whose {@code get()} method will throw an
* exception upon cancellation
*/
RScheduledFuture scheduleWithFixedDelay(String id, Runnable task, Duration initialDelay, Duration delay);
/**
* Synchronously schedules a Runnable task for execution asynchronously
* cron schedule object.
* Subsequent executions are stopped if any execution of the task throws an exception.
* Otherwise, task could be terminated via cancellation or
* termination of the executor.
*
* @param task the task to execute
* @param cronSchedule cron schedule object
* @return future object
*/
RScheduledFuture schedule(Runnable task, CronSchedule cronSchedule);
/**
* Synchronously schedules a Runnable task with
* defined id for execution asynchronously
* cron schedule object.
* Subsequent executions are stopped if any execution of the task throws an exception.
* Otherwise, task could be terminated via cancellation or
* termination of the executor.
*
* @param id task id
* @param task the task to execute
* @param cronSchedule cron schedule object
* @return future object
*/
RScheduledFuture schedule(String id, Runnable task, CronSchedule cronSchedule);
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy