org.redisson.api.RExecutorService 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.Set;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.TimeUnit;
/**
* Distributed implementation of {@link java.util.concurrent.ExecutorService}
*
* @author Nikita Koksharov
*
*/
public interface RExecutorService extends ExecutorService, RExecutorServiceAsync {
/**
* MapReduce's executor name
*/
String MAPREDUCE_NAME = "redisson_mapreduce";
/**
* Synchronously submits a value-returning task for execution asynchronously and returns a
* Future representing the pending results of the task. The
* Future's {@code get} method will return the task's result upon
* successful completion.
*
* @param task the task to submit
* @param the type of the task's result
* @return a Future representing pending completion of the task
*/
@Override
RExecutorFuture submit(Callable task);
/**
* Synchronously submits a value-returning task
* with specified id for execution asynchronously.
* Returns a Future representing the pending results of the task.
*
* @param id task id
* @param task the task to submit
* @param the type of the task's result
* @return a Future representing pending completion of the task
*/
RExecutorFuture submit(String id, Callable task);
/**
* Synchronously submits a value-returning task with defined timeToLive parameter
* for execution asynchronously. Returns a Future representing the pending
* results of the task. The Future's {@code get} method will return the
* task's result upon successful completion.
*
* @param task the task to submit
* @param timeToLive time to live interval
* @param timeUnit unit of time to live interval
* @param the type of the task's result
* @return a Future representing pending completion of the task
*/
RExecutorFuture submit(Callable task, long timeToLive, TimeUnit timeUnit);
/**
* Synchronously submits a value-returning task with
* defined id and timeToLive parameters
* for execution asynchronously.
* Returns a Future representing the pending results of the task.
*
* @param id task id
* @param task the task to submit
* @param timeToLive time to live interval
* @param the type of the task's result
* @return a Future representing pending completion of the task
*/
RExecutorFuture submit(String id, Callable task, Duration timeToLive);
/**
* Synchronously submits tasks batch for execution asynchronously.
* All tasks are stored to executor request queue atomically,
* if case of any error none of tasks will be added.
*
* @param tasks - tasks to execute
* @return Future object
*/
RExecutorBatchFuture submit(Callable... tasks);
/**
* Synchronously submits a Runnable task for execution asynchronously
* and returns a RExecutorFuture representing that task. The Future's {@code get} method will
* return the given result upon successful completion.
*
* @param task the task to submit
* @param result the result to return
* @param the type of the result
* @return a Future representing pending completion of the task
*/
@Override
RExecutorFuture submit(Runnable task, T result);;
/**
* Synchronously submits a Runnable task for execution asynchronously.
* Returns a RExecutorFuture representing task completion. The Future's {@code get} method will
* return {@code null} upon successful completion.
*
* @param task the task to submit
* @return a Future representing pending completion of the task
*/
@Override
RExecutorFuture submit(Runnable task);
/**
* Synchronously submits a Runnable task with id for execution asynchronously.
* Returns a RExecutorFuture representing task completion.
*
* @param id task id
* @param task the task to submit
* @return a Future representing pending completion of the task
*/
RExecutorFuture submit(String id, Runnable task);
/**
* Synchronously submits a task with defined timeToLive parameter
* for execution asynchronously. Returns a Future representing task completion.
* The Future's {@code get} method will return the
* task's result upon successful completion.
*
* @param task the task to submit
* @param timeToLive time to live interval
* @param timeUnit unit of time to live interval
* @return a Future representing pending completion of the task
*/
RExecutorFuture submit(Runnable task, long timeToLive, TimeUnit timeUnit);
/**
* Synchronously submits a task
* with defined id and timeToLive parameters
* for execution asynchronously.
* Returns a Future representing task completion.
*
* @param id task id
* @param task the task to submit
* @param timeToLive time to live interval
* @return a Future representing pending completion of the task
*/
RExecutorFuture submit(String id, Runnable task, Duration timeToLive);
/**
* Synchronously submits tasks batch for execution asynchronously.
* All tasks are stored to executor request queue atomically,
* if case of any error none of tasks will be added.
*
* @param tasks - tasks to execute
* @return Future object
*/
RExecutorBatchFuture submit(Runnable... tasks);
/**
* Returns executor name
*
* @return name of service
*/
String getName();
/**
* Deletes executor request queue and state objects
*
* @return true if any of objects were deleted
*/
boolean delete();
/*
* Use {@link #registerWorkers(WorkerOptions)} setting instead
*
*/
@Deprecated
void registerWorkers(int workers);
/*
* Use {@link #registerWorkers(WorkerOptions)} setting instead
*
*/
@Deprecated
void registerWorkers(int workers, ExecutorService executor);
/**
* Register workers
*
* @param options - worker options
*/
void registerWorkers(WorkerOptions options);
/**
* Returns amount of tasks awaiting execution or currently in execution.
*
* @return amount of tasks
*/
int getTaskCount();
/**
* Returns active workers amount available for tasks execution.
*
* @return workers amount
*/
int countActiveWorkers();
/**
* Returns true if this Executor Service has task
* by taskId awaiting execution or currently in execution.
*
* @param taskId id of task
* @return true if this Executor Service has task
*/
boolean hasTask(String taskId);
/**
* Returns list of task ids awaiting execution or currently in execution.
*
* @return task ids
*/
Set getTaskIds();
/**
* Cancel task by id
*
* @see RExecutorFuture#getTaskId()
*
* @param taskId id of task
* @return true if task has been canceled successfully
* or null if task wasn't found
*/
Boolean cancelTask(String taskId);
/**
* Submits tasks batch for execution synchronously.
* All tasks are stored to executor request queue atomically,
* if case of any error none of tasks will be added.
*
* @param tasks tasks to execute
*/
void execute(Runnable... tasks);
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy