org.bytedeco.arrow

Class TaskGroup

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.TaskGroup

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow::internal")
 @Properties(inherit=arrow.class)
public class TaskGroup
extends Pointer

\brief A group of related tasks A TaskGroup executes tasks with the signature Status(). Execution can be serial or parallel, depending on the TaskGroup implementation. When Finish() returns, it is guaranteed that all tasks have finished, or at least one has errored.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
TaskGroup(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Status	current_status() The current aggregate error Status.
Status	Finish() Wait for execution of all tasks (and subgroups) to be finished, or for at least one task (or subgroup) to error out.
static TaskGroup	MakeSerial()
TaskGroup	MakeSubGroup() Create a subgroup of this group.
static TaskGroup	MakeThreaded(Executor arg0)
boolean	ok() Whether some tasks have already failed.
int	parallelism() How many tasks can typically be executed in parallel.

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getPointer, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TaskGroup

public TaskGroup(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

Method Detail

Finish

@ByVal
public Status Finish()

Wait for execution of all tasks (and subgroups) to be finished, or for at least one task (or subgroup) to error out. The returned Status propagates the error status of the first failing task (or subgroup).

current_status

@ByVal
public Status current_status()

The current aggregate error Status. Non-blocking, useful for stopping early.

ok

@Cast(value="bool")
public boolean ok()

Whether some tasks have already failed. Non-blocking , useful for stopping early.

parallelism

public int parallelism()

How many tasks can typically be executed in parallel. This is only a hint, useful for testing or debugging.

MakeSubGroup

@SharedPtr
public TaskGroup MakeSubGroup()

Create a subgroup of this group. This group can only finish when all subgroups have finished (this means you must be be careful to call Finish() on subgroups before calling it on the main group).

MakeSerial

@SharedPtr
public static TaskGroup MakeSerial()

MakeThreaded

@SharedPtr
public static TaskGroup MakeThreaded(Executor arg0)