org.bytedeco.arrow

Class Future

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.Future

All Implemented Interfaces:

AutoCloseable

@Name(value="arrow::Future<>")
 @Properties(inherit=arrow.class)
public class Future
extends Pointer

\brief EXPERIMENTAL A std::future-like class with more functionality. A Future represents the results of a past or future computation. The Future API has two sides: a producer side and a consumer side. The producer API allows creating a Future and setting its result or status, possibly after running a computation function. The consumer API allows querying a Future's current state, wait for it to complete, or wait on multiple Futures at once (using WaitForAll, WaitForAny or AsCompletedIterator).

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
Future(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Future	asFuture() \brief Future is convertible to Future<>, which views only the Status of the original.
boolean	is_finished() \brief Whether the Future is finished A false return value is only indicative, as the Future can complete concurrently.
boolean	is_valid()
static Future	Make() \brief Producer API: instantiate a valid Future The Future's state is initialized with PENDING.
arrow.FutureState	state() \brief Return the Future's current state A return value of PENDING is only indicative, as the Future can complete concurrently.
Status	status() \brief Wait for the Future to complete and return its Status
void	Wait() \brief Wait for the Future to complete
boolean	Wait(double seconds) \brief Wait for the Future to complete, or for the timeout to expire true is returned if the Future completed, false if the timeout expired.

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, offsetAddress, 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

Future

public Future(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

is_valid

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

state

public arrow.FutureState state()

\brief Return the Future's current state A return value of PENDING is only indicative, as the Future can complete concurrently. A return value of FAILURE or SUCCESS is definitive, though.

is_finished

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

\brief Whether the Future is finished A false return value is only indicative, as the Future can complete concurrently. A true return value is definitive, though.

status

@Const
 @ByRef
public Status status()

\brief Wait for the Future to complete and return its Status

asFuture

@ByVal
 @Name(value="operator arrow::Future<>")
public Future asFuture()

\brief Future is convertible to Future<>, which views only the Status of the original. Marking the returned Future Finished is not supported.

Wait

public void Wait()

\brief Wait for the Future to complete

Wait

@Cast(value="bool")
public boolean Wait(double seconds)

\brief Wait for the Future to complete, or for the timeout to expire true is returned if the Future completed, false if the timeout expired. Note a false value is only indicative, as the Future can complete concurrently.

Make

@ByVal
public static Future Make()

\brief Producer API: instantiate a valid Future The Future's state is initialized with PENDING. If you are creating a future with this method you must ensure that future is eventually completed (with success or failure). Creating a future, returning it, and never completing the future can lead to memory leaks (for example, see Loop).