模块 wjybxx.commons.concurrent

程序包 cn.wjybxx.concurrent

类 FutureUtils

java.lang.Object

cn.wjybxx.concurrent.FutureUtils

public class FutureUtils
extends Object

作者:

wjybxx date 2023/4/9

构造器概要

构造器

构造器	说明
FutureUtils()

方法概要

修饰符和类型	方法	说明
static IFuture<?>	allOf(IFuture<?>... futures)
static IFuture<?>	anyOf(IFuture<?> futures)
static boolean	await(CompletableFuture<?> future, long timeout, TimeUnit unit)
static boolean	awaitUninterruptedly(CompletableFuture<?> future, long timeout, TimeUnit unit)
static <T> IFuture<T>	callAsync(Executor executor, Callable<? extends T> supplier)
static <V> IFuture<V>	completedFuture(V result)
static <V> IFuture<V>	completedFuture(V result, Executor executor)
static void	ensureInEventLoop(SingleThreadExecutor eventLoop)
static void	ensureInEventLoop(SingleThreadExecutor eventLoop, String msg)
static void	execute(IExecutor executor, Consumer<? super IContext> action, IContext ctx, int options)
static void	execute(Executor executor, Consumer<? super IContext> action, IContext ctx)
static <V> IFuture<V>	failedFuture(Throwable cause)
static <V> IFuture<V>	failedFuture(Throwable cause, Executor executor)
static <V> IPromise<V>	fromJDKFuture(CompletionStage<V> stage)
static Throwable	getCause(IFuture<?> future)
static Throwable	getCause(CompletableFuture<?> future)
static boolean	inEventLoop(Executor executor)
static FutureCombiner	newCombiner()
static JDKFutureCombiner	newJdkCombiner()
static <V> IPromise<V>	newPromise()
static <V> IPromise<V>	newPromise(Executor executor)
static CachedTimeProvider	newTimeProvider(EventLoop eventLoop)
static CachedTimeProvider	newTimeProvider(EventLoop eventLoop, long curTime)	创建一个支持缓存的时间提供器，且可以多线程安全访问。
static <V> void	setFuture(IPromise<? super V> output, ICompletionStage<V> input)
static <V> void	setFuture(IPromise<? super V> output, CompletionStage<V> input)
static <V> void	setFuture(CompletableFuture<? super V> output, ICompletionStage<V> input)
static <V> void	setFuture(CompletableFuture<? super V> output, CompletionStage<V> input)
static <V> void	setFutureAsync(Executor executor, IPromise<? super V> output, ICompletionStage<V> input)
static <V> void	setFutureAsync(Executor executor, IPromise<? super V> output, ICompletionStage<V> input, int options)
static <V> void	setFutureAsync(Executor executor, IPromise<? super V> output, CompletionStage<V> input)
static <V> void	setFutureAsync(Executor executor, CompletableFuture<? super V> output, ICompletionStage<V> input)
static <V> void	setFutureAsync(Executor executor, CompletableFuture<? super V> output, ICompletionStage<V> input, int options)
static <V> void	setFutureAsync(Executor executor, CompletableFuture<? super V> output, CompletionStage<V> input)
static <T> IFuture<T>	submit(IExecutor executor, TaskBuilder<T> builder)
static IFuture<?>	submitAction(IExecutor executor, Runnable action, int options)
static IFuture<?>	submitAction(IExecutor executor, Consumer<? super IContext> task, IContext ctx, int options)
static IFuture<?>	submitAction(Executor executor, Runnable action)
static IFuture<?>	submitAction(Executor executor, Consumer<? super IContext> task, IContext ctx)
static <V> IFuture<V>	submitFunc(IExecutor executor, Callable<? extends V> task, int options)
static <V> IFuture<V>	submitFunc(IExecutor executor, Function<? super IContext,? extends V> task, IContext ctx, int options)
static <V> IFuture<V>	submitFunc(Executor executor, Callable<? extends V> task)
static <V> IFuture<V>	submitFunc(Executor executor, Function<? super IContext,? extends V> task, IContext ctx)
static <T> IFuture<T>	supplyAsync(Executor executor, Supplier<? extends T> supplier)
static <V> IPromise<V>	toEventLoopPromise(EventLoop eventLoop, ICompletionStage<V> input)	由EventLoop通知返回的IPromise
static <V> CompletableFuture<V>	toJDKFuture(ICompletionStage<V> stage)
static ITask	toTask(Runnable action, int options)
static ITask	toTask(Consumer<? super IContext> action, IContext ctx, int options)
static <V> BiFunction<V,Throwable,V>	treatExceptionAsNull()	如果future失败则返回null
static Throwable	unwrapCompletionException(Throwable t)	CompletableFuture总是使用CompletionException包装异常，我们需要找到原始异常

从类继承的方法 java.lang.Object

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

构造器详细资料

FutureUtils

public FutureUtils()

方法详细资料

treatExceptionAsNull

public static <V> BiFunction<V,Throwable,V> treatExceptionAsNull()

如果future失败则返回null

unwrapCompletionException

public static Throwable unwrapCompletionException(Throwable t)

CompletableFuture总是使用CompletionException包装异常，我们需要找到原始异常

getCause

public static Throwable getCause(CompletableFuture<?> future)

getCause

public static Throwable getCause(IFuture<?> future)

fromJDKFuture

public static <V> IPromise<V> fromJDKFuture(CompletionStage<V> stage)

toJDKFuture

public static <V> CompletableFuture<V> toJDKFuture(ICompletionStage<V> stage)

setFuture

public static <V> void setFuture(IPromise<? super V> output,
 ICompletionStage<V> input)

setFuture

public static <V> void setFuture(IPromise<? super V> output,
 CompletionStage<V> input)

setFutureAsync

public static <V> void setFutureAsync(Executor executor,
 IPromise<? super V> output,
 ICompletionStage<V> input)

setFutureAsync

public static <V> void setFutureAsync(Executor executor,
 IPromise<? super V> output,
 ICompletionStage<V> input,
 int options)

setFutureAsync

public static <V> void setFutureAsync(Executor executor,
 IPromise<? super V> output,
 CompletionStage<V> input)

setFuture

public static <V> void setFuture(CompletableFuture<? super V> output,
 CompletionStage<V> input)

setFuture

public static <V> void setFuture(CompletableFuture<? super V> output,
 ICompletionStage<V> input)

setFutureAsync

public static <V> void setFutureAsync(Executor executor,
 CompletableFuture<? super V> output,
 CompletionStage<V> input)

setFutureAsync

public static <V> void setFutureAsync(Executor executor,
 CompletableFuture<? super V> output,
 ICompletionStage<V> input)

setFutureAsync

public static <V> void setFutureAsync(Executor executor,
 CompletableFuture<? super V> output,
 ICompletionStage<V> input,
 int options)

toEventLoopPromise

public static <V> IPromise<V> toEventLoopPromise(EventLoop eventLoop,
 ICompletionStage<V> input)

由EventLoop通知返回的IPromise

await

public static boolean await(CompletableFuture<?> future,
 long timeout,
 TimeUnit unit)
                     throws InterruptedException

返回:

如果future在指定时间内进入了完成状态，则返回true

抛出:

InterruptedException

awaitUninterruptedly

public static boolean awaitUninterruptedly(CompletableFuture<?> future,
 long timeout,
 TimeUnit unit)

返回:

如果future在指定时间内进入了完成状态，则返回true

newPromise

public static <V> IPromise<V> newPromise()

newPromise

public static <V> IPromise<V> newPromise(Executor executor)

completedFuture

public static <V> IFuture<V> completedFuture(V result)

completedFuture

public static <V> IFuture<V> completedFuture(V result,
 Executor executor)

failedFuture

public static <V> IFuture<V> failedFuture(Throwable cause)

failedFuture

public static <V> IFuture<V> failedFuture(Throwable cause,
 Executor executor)

newCombiner

public static FutureCombiner newCombiner()

newJdkCombiner

public static JDKFutureCombiner newJdkCombiner()

inEventLoop

public static boolean inEventLoop(@Nullable
 Executor executor)

ensureInEventLoop

public static void ensureInEventLoop(SingleThreadExecutor eventLoop)

ensureInEventLoop

public static void ensureInEventLoop(SingleThreadExecutor eventLoop,
 String msg)

newTimeProvider

public static CachedTimeProvider newTimeProvider(EventLoop eventLoop)

另请参阅:

• newTimeProvider(EventLoop, long)

newTimeProvider

public static CachedTimeProvider newTimeProvider(EventLoop eventLoop,
 long curTime)

创建一个支持缓存的时间提供器，且可以多线程安全访问。 你需要调用CachedTimeProvider.setTime(long)更新时间值，且应该只有一个线程调用更新方法。

参数:

eventLoop - 负责更新时间的线程

curTime - 初始时间

返回:

timeProvider - threadSafe

submit

public static <T> IFuture<T> submit(IExecutor executor,
 @Nonnull
 TaskBuilder<T> builder)

submitFunc

public static <V> IFuture<V> submitFunc(Executor executor,
 Callable<? extends V> task)

submitFunc

public static <V> IFuture<V> submitFunc(IExecutor executor,
 Callable<? extends V> task,
 int options)

submitFunc

public static <V> IFuture<V> submitFunc(Executor executor,
 Function<? super IContext,? extends V> task,
 IContext ctx)

submitFunc

public static <V> IFuture<V> submitFunc(IExecutor executor,
 Function<? super IContext,? extends V> task,
 IContext ctx,
 int options)

submitAction

public static IFuture<?> submitAction(Executor executor,
 Runnable action)

submitAction

public static IFuture<?> submitAction(IExecutor executor,
 Runnable action,
 int options)

submitAction

public static IFuture<?> submitAction(Executor executor,
 Consumer<? super IContext> task,
 IContext ctx)

submitAction

public static IFuture<?> submitAction(IExecutor executor,
 Consumer<? super IContext> task,
 IContext ctx,
 int options)

execute

public static void execute(Executor executor,
 Consumer<? super IContext> action,
 IContext ctx)

execute

public static void execute(IExecutor executor,
 Consumer<? super IContext> action,
 IContext ctx,
 int options)

callAsync

public static <T> IFuture<T> callAsync(Executor executor,
 Callable<? extends T> supplier)

supplyAsync

public static <T> IFuture<T> supplyAsync(Executor executor,
 Supplier<? extends T> supplier)

anyOf

public static IFuture<?> anyOf(IFuture<?> futures)

allOf

public static IFuture<?> allOf(IFuture<?>... futures)

toTask

public static ITask toTask(Runnable action,
 int options)

toTask

public static ITask toTask(Consumer<? super IContext> action,
 IContext ctx,
 int options)