org.bytedeco.arrow

Class AsyncTaskGroup

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.AsyncTaskGroup

All Implemented Interfaces:

AutoCloseable

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

A utility which keeps track of a collection of asynchronous tasks This can be used to provide structured concurrency for asynchronous development. A task group created at a high level can be distributed amongst low level components which register work to be completed. The high level job can then wait for all work to be completed before cleaning up.

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
AsyncTaskGroup() Default native constructor.
AsyncTaskGroup(long size) Native array allocator.
AsyncTaskGroup(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Status	AddTask(Future task) Add a task that has already been started
Status	AddTask(Pointer task) Add a task to be tracked by this task group If a previous task has failed then adding a task will fail If WaitForTasksToFinish has been called and the returned future has been marked completed then adding a task will fail.
Future	End() Signal that top level tasks are done being added It is allowed for tasks to be added after this call provided the future has not yet completed.
AsyncTaskGroup	getPointer(long i)
Future	OnFinished() A future that will be finished after End is called and all tasks have completed This is the same future that is returned by End() but calling this method does not indicate that top level tasks are done being added.
AsyncTaskGroup	position(long position)

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, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, 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

AsyncTaskGroup

public AsyncTaskGroup()

Default native constructor.

AsyncTaskGroup

public AsyncTaskGroup(long size)

Native array allocator. Access with Pointer.position(long).

AsyncTaskGroup

public AsyncTaskGroup(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

position

public AsyncTaskGroup position(long position)

Overrides:

position in class Pointer

getPointer

public AsyncTaskGroup getPointer(long i)

Overrides:

getPointer in class Pointer

AddTask

@ByVal
public Status AddTask(@ByVal @Cast(value="std::function<arrow::Result<arrow::Future<> >()>*")
                              Pointer task)

Add a task to be tracked by this task group If a previous task has failed then adding a task will fail If WaitForTasksToFinish has been called and the returned future has been marked completed then adding a task will fail.

AddTask

@ByVal
public Status AddTask(@Const @ByRef
                              Future task)

Add a task that has already been started

End

@ByVal
public Future End()

Signal that top level tasks are done being added It is allowed for tasks to be added after this call provided the future has not yet completed. This should be safe as long as the tasks being added are added as part of a task that is tracked. As soon as the count of running tasks reaches 0 this future will be marked complete. Any attempt to add a task after the returned future has completed will fail. The returned future that will finish when all running tasks have finsihed.

OnFinished

@ByVal
public Future OnFinished()

A future that will be finished after End is called and all tasks have completed This is the same future that is returned by End() but calling this method does not indicate that top level tasks are done being added. End() must still be called at some point or the future returned will never finish. This is a utility method for workflows where the finish future needs to be referenced before all top level tasks have been queued.