org.spf4j.base

Class ExecutionContexts

java.lang.Object

org.spf4j.base.ExecutionContexts

@ThreadSafe
 @ParametersAreNonnullByDefault
public final class ExecutionContexts
extends Object

Author:

Zoltan Farkas

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_TIMEOUT_NANOS

Method Summary

Modifier and Type	Method and Description
static void	clearCurrentThread()
static long	computeDeadline(ExecutionContext current, long timeout, TimeUnit unit)
static long	computeDeadline(ExecutionContext current, TimeUnit unit, long timeout) Deprecated. use variant where the value and unit are it the natural order.
static long	computeDeadline(long startTimeNanos, ExecutionContext current, TimeUnit unit, long timeout)
static long	computeDeadline(long timeout, TimeUnit unit)
static long	computeTimeout(long timeout, TimeUnit unit)
static TimeoutDeadline	computeTimeoutDeadline(ExecutionContext current, TimeUnit unit, long timeout) Compute the actual timeout taking in consideration the context deadline.
static ExecutionContext	createDetached(String name, CharSequence id, ExecutionContext parent, ExecutionContext.Relation relation, long startTimeNanos, long deadlineNanos)
static ExecutionContext	createDetached(String name, ExecutionContext parent, ExecutionContext.Relation relation, long startTimeNanos, long deadlineNanos)
static ExecutionContext	createDetached(String name, ExecutionContext parent, long startTimeNanos, long deadlineNanos)
static ExecutionContext	createDetached(String name, ExecutionContext parent, long timeout, TimeUnit tu)
static ExecutionContext	current()
static <T> Callable<T>	deadlinedPropagatingCallable(Callable<T> callable, ExecutionContext ctx, long deadlineNanos)
static <T> Collection<? extends Callable<T>>	deadlinedPropagatingCallables(Collection<? extends Callable<T>> tasks, ExecutionContext ctx, long deadlineNanos)
static ThreadLocalContextAttacher	defaultThreadLocalAttacher()
static CharSequence	genId()
static long	getContextDeadlineNanos()
static long	getContextDeadlineNanos(long currentTime)
static ExecutionContextFactory<ExecutionContext>	getContextFactory()
static long	getMillisToDeadline()
static int	getSecondsToDeadline()
static long	getTimeRelativeToDeadline(TimeUnit unit)
static long	getTimeToDeadline(TimeUnit unit)
static int	getTimeToDeadlineInt(TimeUnit unit)
static long	getTimeToDeadlineUnchecked(TimeUnit unit)
static boolean	inCurrentThread(ExecutionContext ctx)
static <X,Y> BiConsumer<X,Y>	propagatingBiConsumer(BiConsumer<X,Y> callable, ExecutionContext ctx, String name, long deadlineNanos)
static <X,Y,Z> BiFunction<X,Y,Z>	propagatingBiFunction(BiFunction<X,Y,Z> callable, ExecutionContext ctx, String name, long deadlineNanos)
static <T> Callable<T>	propagatingCallable(Callable<T> callable)
static <T> Callable<T>	propagatingCallable(Callable<T> callable, ExecutionContext ctx)
static <T> Callable<T>	propagatingCallable(Callable<T> callable, ExecutionContext ctx, String name, long deadlineNanos)
static <T> Collection<? extends Callable<T>>	propagatingCallables(Collection<? extends Callable<T>> tasks)
static <T> Collection<? extends Callable<T>>	propagatingCallables(Collection<? extends Callable<T>> tasks, ExecutionContext ctx)
static <X> Consumer<X>	propagatingConsumer(Consumer<X> callable, ExecutionContext ctx, String name, long deadlineNanos)
static <X,Y> Function<X,Y>	propagatingFunction(Function<X,Y> callable, ExecutionContext ctx, String name, long deadlineNanos)
static Runnable	propagatingRunnable(Runnable runnable)
static Runnable	propagatingRunnable(Runnable runnable, ExecutionContext ctx)
static Runnable	propagatingRunnable(Runnable runnable, ExecutionContext ctx, String name, long deadlineNanos)
static <X> Supplier<X>	propagatingSupplier(Supplier<X> callable, ExecutionContext ctx, String name, long deadlineNanos)
static ExecutionContext	start(ExecutionContext parent)
static ExecutionContext	start(ExecutionContext parent, long startTimeNanos, long deadlineNanos)
static ExecutionContext	start(ExecutionContext parent, long timeout, TimeUnit tu)
static ExecutionContext	start(long startTimeNanos, long deadlineNanos) start a execution context.
static ExecutionContext	start(long timeout, TimeUnit tu) start a execution context.
static ExecutionContext	start(String opname)
static ExecutionContext	start(String name, CharSequence id, ExecutionContext parent, ExecutionContext.Relation relation, long startTimeNanos, long deadlineNanos)
static ExecutionContext	start(String name, CharSequence id, ExecutionContext parent, long startTimeNanos, long deadlineNanos)
static ExecutionContext	start(String name, CharSequence id, ExecutionContext parent, long timeout, TimeUnit tu)
static ExecutionContext	start(String name, ExecutionContext parent)
static ExecutionContext	start(String name, ExecutionContext parent, long deadlineNanos)
static ExecutionContext	start(String name, ExecutionContext parent, long startTimeNanos, long deadlineNanos)
static ExecutionContext	start(String name, ExecutionContext parent, long timeout, TimeUnit tu)
static ExecutionContext	start(String name, long deadlineNanos)
static ExecutionContext	start(String name, long startTimeNanos, long deadlineNanos)
static ExecutionContext	start(String opname, long timeout, TimeUnit tu)
static ThreadLocalContextAttacher	threadLocalAttacher()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TIMEOUT_NANOS

public static final long DEFAULT_TIMEOUT_NANOS

Method Detail

defaultThreadLocalAttacher

public static ThreadLocalContextAttacher defaultThreadLocalAttacher()

threadLocalAttacher

public static ThreadLocalContextAttacher threadLocalAttacher()

genId

public static CharSequence genId()

getContextFactory

public static ExecutionContextFactory<ExecutionContext> getContextFactory()

current

@Nullable
public static ExecutionContext current()

inCurrentThread

public static boolean inCurrentThread(ExecutionContext ctx)

clearCurrentThread

public static void clearCurrentThread()

start

public static ExecutionContext start(long startTimeNanos,
                                     long deadlineNanos)

start a execution context.

Parameters:

deadlineNanos - the deadline for this context. (System.nanotime)

Returns:

the execution context.

start

public static ExecutionContext start(long timeout,
                                     TimeUnit tu)

start a execution context.

Parameters:

timeout -

tu -

Returns:

start

public static ExecutionContext start(String opname)

start

public static ExecutionContext start(String opname,
                                     long timeout,
                                     TimeUnit tu)

start

public static ExecutionContext start(@Nullable
                                     ExecutionContext parent,
                                     long timeout,
                                     TimeUnit tu)

start

public static ExecutionContext start(@Nullable
                                     ExecutionContext parent)

start

public static ExecutionContext start(@Nullable
                                     ExecutionContext parent,
                                     long startTimeNanos,
                                     long deadlineNanos)

start

public static ExecutionContext start(String name,
                                     long startTimeNanos,
                                     long deadlineNanos)

start

public static ExecutionContext start(String name,
                                     long deadlineNanos)

start

public static ExecutionContext start(String name,
                                     @Nullable
                                     ExecutionContext parent)

start

public static ExecutionContext start(String name,
                                     @Nullable
                                     ExecutionContext parent,
                                     long timeout,
                                     TimeUnit tu)

start

public static ExecutionContext start(String name,
                                     @Nullable
                                     CharSequence id,
                                     @Nullable
                                     ExecutionContext parent,
                                     long timeout,
                                     TimeUnit tu)

createDetached

public static ExecutionContext createDetached(String name,
                                              @Nullable
                                              ExecutionContext parent,
                                              long timeout,
                                              TimeUnit tu)

start

public static ExecutionContext start(String name,
                                     @Nullable
                                     ExecutionContext parent,
                                     long deadlineNanos)

start

public static ExecutionContext start(String name,
                                     @Nullable
                                     ExecutionContext parent,
                                     long startTimeNanos,
                                     long deadlineNanos)

start

public static ExecutionContext start(String name,
                                     @Nullable
                                     CharSequence id,
                                     @Nullable
                                     ExecutionContext parent,
                                     long startTimeNanos,
                                     long deadlineNanos)

start

public static ExecutionContext start(String name,
                                     @Nullable
                                     CharSequence id,
                                     @Nullable
                                     ExecutionContext parent,
                                     ExecutionContext.Relation relation,
                                     long startTimeNanos,
                                     long deadlineNanos)

createDetached

public static ExecutionContext createDetached(String name,
                                              @Nullable
                                              ExecutionContext parent,
                                              long startTimeNanos,
                                              long deadlineNanos)

createDetached

public static ExecutionContext createDetached(String name,
                                              @Nullable
                                              ExecutionContext parent,
                                              ExecutionContext.Relation relation,
                                              long startTimeNanos,
                                              long deadlineNanos)

createDetached

public static ExecutionContext createDetached(String name,
                                              @Nullable
                                              CharSequence id,
                                              @Nullable
                                              ExecutionContext parent,
                                              ExecutionContext.Relation relation,
                                              long startTimeNanos,
                                              long deadlineNanos)

getContextDeadlineNanos

public static long getContextDeadlineNanos()

getContextDeadlineNanos

public static long getContextDeadlineNanos(long currentTime)

getTimeRelativeToDeadline

@Signed
public static long getTimeRelativeToDeadline(TimeUnit unit)

getTimeToDeadline

@Nonnegative
public static long getTimeToDeadline(TimeUnit unit)
                                           throws TimeoutException

Throws:

TimeoutException

getTimeToDeadlineUnchecked

@Nonnegative
public static long getTimeToDeadlineUnchecked(TimeUnit unit)

getTimeToDeadlineInt

@Nonnegative
public static int getTimeToDeadlineInt(TimeUnit unit)
                                             throws TimeoutException

Throws:

TimeoutException

getMillisToDeadline

@Nonnegative
public static long getMillisToDeadline()
                                             throws TimeoutException

Throws:

TimeoutException

getSecondsToDeadline

@Nonnegative
public static int getSecondsToDeadline()
                                             throws TimeoutException

Throws:

TimeoutException

computeDeadline

public static long computeDeadline(long timeout,
                                   TimeUnit unit)

computeTimeout

public static long computeTimeout(long timeout,
                                  TimeUnit unit)
                           throws TimeoutException

Throws:

TimeoutException

computeDeadline

@Deprecated
public static long computeDeadline(@Nullable
                                               ExecutionContext current,
                                               TimeUnit unit,
                                               long timeout)

Deprecated. use variant where the value and unit are it the natural order.

computeDeadline

public static long computeDeadline(@Nullable
                                   ExecutionContext current,
                                   long timeout,
                                   TimeUnit unit)

computeDeadline

public static long computeDeadline(long startTimeNanos,
                                   @Nullable
                                   ExecutionContext current,
                                   TimeUnit unit,
                                   long timeout)

computeTimeoutDeadline

public static TimeoutDeadline computeTimeoutDeadline(@Nullable
                                                     ExecutionContext current,
                                                     TimeUnit unit,
                                                     long timeout)
                                              throws TimeoutException

Compute the actual timeout taking in consideration the context deadline.

Parameters:

current - the context

unit - timeout unit

timeout - timeout value

Returns:

the earliest timeout (of the provided and context one)

Throws:

TimeoutException

propagatingCallable

public static <T> Callable<T> propagatingCallable(Callable<T> callable)

propagatingCallable

public static <T> Callable<T> propagatingCallable(Callable<T> callable,
                                                  ExecutionContext ctx)

propagatingCallables

public static <T> Collection<? extends Callable<T>> propagatingCallables(Collection<? extends Callable<T>> tasks)

propagatingCallables

public static <T> Collection<? extends Callable<T>> propagatingCallables(Collection<? extends Callable<T>> tasks,
                                                                         ExecutionContext ctx)

deadlinedPropagatingCallables

public static <T> Collection<? extends Callable<T>> deadlinedPropagatingCallables(Collection<? extends Callable<T>> tasks,
                                                                                  ExecutionContext ctx,
                                                                                  long deadlineNanos)

deadlinedPropagatingCallable

public static <T> Callable<T> deadlinedPropagatingCallable(Callable<T> callable,
                                                           ExecutionContext ctx,
                                                           long deadlineNanos)

propagatingRunnable

public static Runnable propagatingRunnable(Runnable runnable)

propagatingRunnable

public static Runnable propagatingRunnable(Runnable runnable,
                                           ExecutionContext ctx)

propagatingRunnable

public static Runnable propagatingRunnable(Runnable runnable,
                                           ExecutionContext ctx,
                                           @Nullable
                                           String name,
                                           long deadlineNanos)

propagatingCallable

public static <T> Callable<T> propagatingCallable(Callable<T> callable,
                                                  ExecutionContext ctx,
                                                  @Nullable
                                                  String name,
                                                  long deadlineNanos)

propagatingFunction

public static <X,Y> Function<X,Y> propagatingFunction(Function<X,Y> callable,
                                                      ExecutionContext ctx,
                                                      @Nullable
                                                      String name,
                                                      long deadlineNanos)

propagatingBiFunction

public static <X,Y,Z> BiFunction<X,Y,Z> propagatingBiFunction(BiFunction<X,Y,Z> callable,
                                                              ExecutionContext ctx,
                                                              @Nullable
                                                              String name,
                                                              long deadlineNanos)

propagatingConsumer

public static <X> Consumer<X> propagatingConsumer(Consumer<X> callable,
                                                  ExecutionContext ctx,
                                                  @Nullable
                                                  String name,
                                                  long deadlineNanos)

propagatingSupplier

public static <X> Supplier<X> propagatingSupplier(Supplier<X> callable,
                                                  ExecutionContext ctx,
                                                  @Nullable
                                                  String name,
                                                  long deadlineNanos)

propagatingBiConsumer

public static <X,Y> BiConsumer<X,Y> propagatingBiConsumer(BiConsumer<X,Y> callable,
                                                          ExecutionContext ctx,
                                                          @Nullable
                                                          String name,
                                                          long deadlineNanos)