org.bytedeco.arrow

Class IpcReadOptions

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.IpcReadOptions

All Implemented Interfaces:

AutoCloseable

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

\brief Options for reading Arrow IPC messages

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

Method Summary

Modifier and Type	Method and Description
static IpcReadOptions	Defaults()
boolean	ensure_native_endian() \brief Whether to convert incoming data to platform-native endianness If the endianness of the received schema is not equal to platform-native endianness, then all buffers with endian-sensitive data will be byte-swapped.
IpcReadOptions	ensure_native_endian(boolean setter)
IpcReadOptions	getPointer(long i)
IntPointer	included_fields() \brief Top-level schema fields to include when deserializing RecordBatch.
IpcReadOptions	included_fields(IntPointer setter)
int	max_recursion_depth() \brief The maximum permitted schema nesting depth.
IpcReadOptions	max_recursion_depth(int setter)
MemoryPool	memory_pool() \brief The memory pool to use for allocations made during IPC reading While Arrow IPC is predominantly zero-copy, it may have to allocate memory in some cases (for example if compression is enabled).
IpcReadOptions	memory_pool(MemoryPool setter)
IpcReadOptions	position(long position)
boolean	use_threads() \brief Use global CPU thread pool to parallelize any computational tasks like decompression
IpcReadOptions	use_threads(boolean setter)

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

IpcReadOptions

public IpcReadOptions()

Default native constructor.

IpcReadOptions

public IpcReadOptions(long size)

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

IpcReadOptions

public IpcReadOptions(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

position

public IpcReadOptions position(long position)

Overrides:

position in class Pointer

getPointer

public IpcReadOptions getPointer(long i)

Overrides:

getPointer in class Pointer

max_recursion_depth

public int max_recursion_depth()

\brief The maximum permitted schema nesting depth.

max_recursion_depth

public IpcReadOptions max_recursion_depth(int setter)

memory_pool

public MemoryPool memory_pool()

\brief The memory pool to use for allocations made during IPC reading While Arrow IPC is predominantly zero-copy, it may have to allocate memory in some cases (for example if compression is enabled).

memory_pool

public IpcReadOptions memory_pool(MemoryPool setter)

included_fields

@StdVector
public IntPointer included_fields()

\brief Top-level schema fields to include when deserializing RecordBatch. If empty (the default), return all deserialized fields. If non-empty, the values are the indices of fields in the top-level schema.

included_fields

public IpcReadOptions included_fields(IntPointer setter)

use_threads

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

\brief Use global CPU thread pool to parallelize any computational tasks like decompression

use_threads

public IpcReadOptions use_threads(boolean setter)

ensure_native_endian

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

\brief Whether to convert incoming data to platform-native endianness If the endianness of the received schema is not equal to platform-native endianness, then all buffers with endian-sensitive data will be byte-swapped. This includes the value buffers of numeric types, temporal types, decimal types, as well as the offset buffers of variable-sized binary and list-like types. Endianness conversion is achieved by the RecordBatchFileReader, RecordBatchStreamReader and StreamDecoder classes.

ensure_native_endian

public IpcReadOptions ensure_native_endian(boolean setter)

Defaults

@ByVal
public static IpcReadOptions Defaults()