org.bytedeco.arrow

Class ReadRangeCache

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.ReadRangeCache

All Implemented Interfaces:

AutoCloseable

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

\brief A read cache designed to hide IO latencies when reading. To use this, you must first pass it the ranges you'll need in the future. The cache will combine those ranges according to parameters (see constructor) and start fetching the combined ranges in the background. You can then individually fetch them using Read().

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static long	kDefaultHoleSizeLimit
static long	kDefaultRangeSizeLimit

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
ReadRangeCache(Pointer p) Pointer cast constructor.
ReadRangeCache(RandomAccessFile file, IOContext ctx) Construct a read cache with default
ReadRangeCache(RandomAccessFile file, IOContext ctx, CacheOptions options) Construct a read cache with given options

Method Summary

Modifier and Type	Method and Description
Status	Cache(ReadRange ranges) \brief Cache the given ranges in the background.
static long	kDefaultHoleSizeLimit()
static long	kDefaultRangeSizeLimit()
BufferResult	Read(ReadRange range) \brief Read a range previously given to Cache().
Future	Wait() \brief Wait until all ranges added so far have been cached.

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

Field Detail

kDefaultHoleSizeLimit

public static final long kDefaultHoleSizeLimit

kDefaultRangeSizeLimit

public static final long kDefaultRangeSizeLimit

Constructor Detail

ReadRangeCache

public ReadRangeCache(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

ReadRangeCache

public ReadRangeCache(@SharedPtr
                      RandomAccessFile file,
                      @ByVal
                      IOContext ctx)

Construct a read cache with default

ReadRangeCache

public ReadRangeCache(@SharedPtr
                      RandomAccessFile file,
                      @ByVal
                      IOContext ctx,
                      @ByVal
                      CacheOptions options)

Construct a read cache with given options

Method Detail

kDefaultHoleSizeLimit

@MemberGetter
 @Cast(value="const int64_t")
public static long kDefaultHoleSizeLimit()

kDefaultRangeSizeLimit

@MemberGetter
 @Cast(value="const int64_t")
public static long kDefaultRangeSizeLimit()

Cache

@ByVal
public Status Cache(@StdVector
                           ReadRange ranges)

\brief Cache the given ranges in the background. The caller must ensure that the ranges do not overlap with each other, nor with previously cached ranges. Otherwise, behaviour will be undefined.

Read

@ByVal
public BufferResult Read(@ByVal
                                ReadRange range)

\brief Read a range previously given to Cache().

Wait

@ByVal
public Future Wait()

\brief Wait until all ranges added so far have been cached.