org.apache.ratis.util

类 TaskQueue

java.lang.Object

org.apache.ratis.util.TaskQueue

public class TaskQueue
extends Object

A queue with execution order guarantee such that each task is submitted for execution only if it becomes the head of the queue. Tasks are executed sequentially without any overlap. By the definition of a queue, a task can become the head iff (1) the queue is empty when offering it, or (2) it is the next to the head and the head is polled out from the queue. A typically use case is to submit concurrent tasks with in-order guarantee for some of the tasks. One example use case is to submit tasks to write multiple files: - A file may requires multiple write tasks. - Multiple files are written at the same time. A solution is to create a TaskQueue for each file and then submit the write tasks to the corresponding queue. The files will be written concurrently and the writes to each file are in-order.

字段概要

字段

限定符和类型	字段和说明
static org.slf4j.Logger	LOG

构造器概要

构造器

构造器和说明
TaskQueue(String name)

方法概要

限定符和类型	方法和说明
boolean	isEmpty() Is this queue empty?
<OUTPUT,THROWABLE extends Throwable> CompletableFuture<OUTPUT>	submit(CheckedSupplier<OUTPUT,THROWABLE> task, ExecutorService executor) The same as submit(task, executor, Function.identity());
<OUTPUT,THROWABLE extends Throwable> CompletableFuture<OUTPUT>	submit(CheckedSupplier<OUTPUT,THROWABLE> task, ExecutorService executor, Function<Throwable,Throwable> newThrowable) Offer the given task to this queue and then submit the tasks one by one in the queue order for execution.
String	toString()

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

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

字段详细资料

LOG

public static final org.slf4j.Logger LOG

构造器详细资料

TaskQueue

public TaskQueue(String name)

方法详细资料

isEmpty

public boolean isEmpty()

Is this queue empty?

submit

public <OUTPUT,THROWABLE extends Throwable> CompletableFuture<OUTPUT> submit(CheckedSupplier<OUTPUT,THROWABLE> task,
                                                                             ExecutorService executor)

The same as submit(task, executor, Function.identity());

submit

public <OUTPUT,THROWABLE extends Throwable> CompletableFuture<OUTPUT> submit(CheckedSupplier<OUTPUT,THROWABLE> task,
                                                                             ExecutorService executor,
                                                                             Function<Throwable,Throwable> newThrowable)

Offer the given task to this queue and then submit the tasks one by one in the queue order for execution.

类型参数:

OUTPUT - the output type of the task.

THROWABLE - the throwable type of the task.

参数:

task - the task to be submitted.

executor - to execute tasks.

newThrowable - When the task throws a throwable, create a new Throwable in order to include more error message.

返回:

a future of the output.

toString

public String toString()

覆盖:

toString 在类中 Object