org.bytedeco.arrow

Class InputStreamFuture

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.InputStreamFuture

All Implemented Interfaces:

AutoCloseable

@Name(value="arrow::Future<std::shared_ptr<arrow::io::InputStream> >")
 @Properties(inherit=arrow.class)
public class InputStreamFuture
extends Pointer

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
InputStreamFuture()
InputStreamFuture(InputStream val) \brief Implicit constructor to create a finished future from a value
InputStreamFuture(InputStreamResult res) \brief Implicit constructor to create a future from a Result, enabling use of macros like ARROW_ASSIGN_OR_RAISE.
InputStreamFuture(long size) Native array allocator.
InputStreamFuture(Pointer p) Pointer cast constructor.
InputStreamFuture(Status s) \brief Implicit constructor to create a future from a Status, enabling use of macros like ARROW_RETURN_NOT_OK.

Method Summary

Modifier and Type	Method and Description
Future	asFuture() \brief Future is convertible to Future<>, which views only the Status of the original.
InputStreamFuture	getPointer(long i)
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 InputStreamFuture	Make() \brief Producer API: instantiate a valid Future The Future's state is initialized with PENDING.
static InputStreamFuture	MakeFinished(InputStreamResult res) \brief Producer API: instantiate a finished Future
void	MarkFinished(InputStreamResult res) \brief Producer API: mark Future finished The Future's result is set to res.
InputStreamResult	MoveResult() \brief Returns an rvalue to the result.
InputStreamFuture	position(long position)
InputStreamResult	result() \brief Wait for the Future to complete and return its Result
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, hashCode, 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

InputStreamFuture

public InputStreamFuture(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

InputStreamFuture

public InputStreamFuture(long size)

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

InputStreamFuture

public InputStreamFuture()

InputStreamFuture

public InputStreamFuture(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::io::InputStream>"})
                         InputStream val)

\brief Implicit constructor to create a finished future from a value

InputStreamFuture

public InputStreamFuture(@ByVal
                         InputStreamResult res)

\brief Implicit constructor to create a future from a Result, enabling use of macros like ARROW_ASSIGN_OR_RAISE.

InputStreamFuture

public InputStreamFuture(@ByVal
                         Status s)

\brief Implicit constructor to create a future from a Status, enabling use of macros like ARROW_RETURN_NOT_OK.

Method Detail

position

public InputStreamFuture position(long position)

Overrides:

position in class Pointer

getPointer

public InputStreamFuture getPointer(long i)

Overrides:

getPointer in class Pointer

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.

result

@Const
 @ByRef
public InputStreamResult result()

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

MoveResult

@ByRef(value=true)
public InputStreamResult MoveResult()

\brief Returns an rvalue to the result. This method is potentially unsafe The future is not the unique owner of the result, copies of a future will also point to the same result. You must make sure that no other copies of the future exist. Attempts to add callbacks after you move the result will result in undefined behavior.

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.

MarkFinished

public void MarkFinished(@ByVal
                         InputStreamResult res)

\brief Producer API: mark Future finished The Future's result is set to res.

Make

@ByVal
public static InputStreamFuture 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).

MakeFinished

@ByVal
public static InputStreamFuture MakeFinished(@ByVal
                                                    InputStreamResult res)

\brief Producer API: instantiate a finished Future