org.bytedeco.arrow

Class CacheOptions

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.CacheOptions

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow::io")
 @Properties(inherit=arrow.class)
public class CacheOptions
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

Modifier and Type	Field and Description
static double	kDefaultIdealBandwidthUtilizationFrac
static long	kDefaultMaxIdealRequestSizeMib

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
CacheOptions() Default native constructor.
CacheOptions(long size) Native array allocator.
CacheOptions(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
static CacheOptions	Defaults()
boolean	equals(CacheOptions other)
CacheOptions	getPointer(long i)
long	hole_size_limit() /brief The maximum distance in bytes between two consecutive ranges; beyond this value, ranges are not combined
CacheOptions	hole_size_limit(long setter)
static double	kDefaultIdealBandwidthUtilizationFrac()
static long	kDefaultMaxIdealRequestSizeMib()
static CacheOptions	MakeFromNetworkMetrics(long time_to_first_byte_millis, long transfer_bandwidth_mib_per_sec)
static CacheOptions	MakeFromNetworkMetrics(long time_to_first_byte_millis, long transfer_bandwidth_mib_per_sec, double ideal_bandwidth_utilization_frac, long max_ideal_request_size_mib) \brief Construct CacheOptions from network storage metrics (e.g.
CacheOptions	position(long position)
long	range_size_limit() /brief The maximum size in bytes of a combined range; if combining two consecutive ranges would produce a range of a size greater than this, they are not combined
CacheOptions	range_size_limit(long 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, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, 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

Field Detail

kDefaultIdealBandwidthUtilizationFrac

public static final double kDefaultIdealBandwidthUtilizationFrac

kDefaultMaxIdealRequestSizeMib

public static final long kDefaultMaxIdealRequestSizeMib

Constructor Detail

CacheOptions

public CacheOptions()

Default native constructor.

CacheOptions

public CacheOptions(long size)

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

CacheOptions

public CacheOptions(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

position

public CacheOptions position(long position)

Overrides:

position in class Pointer

getPointer

public CacheOptions getPointer(long i)

Overrides:

getPointer in class Pointer

kDefaultIdealBandwidthUtilizationFrac

@MemberGetter
public static double kDefaultIdealBandwidthUtilizationFrac()

kDefaultMaxIdealRequestSizeMib

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

hole_size_limit

@Cast(value="int64_t")
public long hole_size_limit()

/brief The maximum distance in bytes between two consecutive ranges; beyond this value, ranges are not combined

hole_size_limit

public CacheOptions hole_size_limit(long setter)

range_size_limit

@Cast(value="int64_t")
public long range_size_limit()

/brief The maximum size in bytes of a combined range; if combining two consecutive ranges would produce a range of a size greater than this, they are not combined

range_size_limit

public CacheOptions range_size_limit(long setter)

equals

@Cast(value="bool")
 @Name(value="operator ==")
public boolean equals(@Const @ByRef
                                                                        CacheOptions other)

MakeFromNetworkMetrics

@ByVal
public static CacheOptions MakeFromNetworkMetrics(@Cast(value="int64_t")
                                                          long time_to_first_byte_millis,
                                                          @Cast(value="int64_t")
                                                          long transfer_bandwidth_mib_per_sec,
                                                          double ideal_bandwidth_utilization_frac,
                                                          @Cast(value="int64_t")
                                                          long max_ideal_request_size_mib)

\brief Construct CacheOptions from network storage metrics (e.g. S3).

Parameters:

time_to_first_byte_millis - [in] Seek-time or Time-To-First-Byte (TTFB) in milliseconds, also called call setup latency of a new S3 request. The value is a positive integer.

transfer_bandwidth_mib_per_sec - [in] Data transfer Bandwidth (BW) in MiB/sec. The value is a positive integer.

ideal_bandwidth_utilization_frac - [in] Transfer bandwidth utilization fraction (per connection) to maximize the net data load. The value is a positive double precision number less than 1.

max_ideal_request_size_mib - [in] The maximum single data request size (in MiB) to maximize the net data load. The value is a positive integer.

Returns:

A new instance of CacheOptions.

MakeFromNetworkMetrics

@ByVal
public static CacheOptions MakeFromNetworkMetrics(@Cast(value="int64_t")
                                                          long time_to_first_byte_millis,
                                                          @Cast(value="int64_t")
                                                          long transfer_bandwidth_mib_per_sec)

Defaults

@ByVal
public static CacheOptions Defaults()