io.deephaven.barrage.flatbuf

Class BarrageSubscriptionOptions

java.lang.Object

com.google.flatbuffers.Table

io.deephaven.barrage.flatbuf.BarrageSubscriptionOptions

public final class BarrageSubscriptionOptions
extends com.google.flatbuffers.Table

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BarrageSubscriptionOptions.Vector

Field Summary

Fields inherited from class com.google.flatbuffers.Table

bb, bb_pos

Constructor Summary

Constructors

Constructor and Description
BarrageSubscriptionOptions()

Method Summary

Modifier and Type	Method and Description
BarrageSubscriptionOptions	__assign(int _i, ByteBuffer _bb)
void	__init(int _i, ByteBuffer _bb)
static void	addBatchSize(com.google.flatbuffers.FlatBufferBuilder builder, int batchSize)
static void	addColumnConversionMode(com.google.flatbuffers.FlatBufferBuilder builder, byte columnConversionMode)
static void	addColumnsAsList(com.google.flatbuffers.FlatBufferBuilder builder, boolean columnsAsList)
static void	addMaxMessageSize(com.google.flatbuffers.FlatBufferBuilder builder, int maxMessageSize)
static void	addMinUpdateIntervalMs(com.google.flatbuffers.FlatBufferBuilder builder, int minUpdateIntervalMs)
static void	addUseDeephavenNulls(com.google.flatbuffers.FlatBufferBuilder builder, boolean useDeephavenNulls)
int	batchSize() Specify a preferred batch size.
byte	columnConversionMode() see enum for details
boolean	columnsAsList() If true, the server will wrap columns with a list.
static int	createBarrageSubscriptionOptions(com.google.flatbuffers.FlatBufferBuilder builder, byte column_conversion_mode, boolean use_deephaven_nulls, int min_update_interval_ms, int batch_size, int max_message_size, boolean columns_as_list)
static int	endBarrageSubscriptionOptions(com.google.flatbuffers.FlatBufferBuilder builder)
static BarrageSubscriptionOptions	getRootAsBarrageSubscriptionOptions(ByteBuffer _bb)
static BarrageSubscriptionOptions	getRootAsBarrageSubscriptionOptions(ByteBuffer _bb, BarrageSubscriptionOptions obj)
int	maxMessageSize() Specify a maximum allowed message size.
int	minUpdateIntervalMs() Explicitly set the update interval for this subscription.
static void	startBarrageSubscriptionOptions(com.google.flatbuffers.FlatBufferBuilder builder)
boolean	useDeephavenNulls() Deephaven reserves a value in the range of primitives as a custom NULL value.
static void	ValidateVersion()

Methods inherited from class com.google.flatbuffers.Table

__has_identifier, __indirect, __indirect, __offset, __offset, __reset, __reset, __string, __string, __union, __union, __vector_as_bytebuffer, __vector_in_bytebuffer, __vector_len, __vector, compareStrings, compareStrings, getByteBuffer, keysCompare, sortTables

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BarrageSubscriptionOptions

public BarrageSubscriptionOptions()

Method Detail

ValidateVersion

public static void ValidateVersion()

getRootAsBarrageSubscriptionOptions

public static BarrageSubscriptionOptions getRootAsBarrageSubscriptionOptions(ByteBuffer _bb)

getRootAsBarrageSubscriptionOptions

public static BarrageSubscriptionOptions getRootAsBarrageSubscriptionOptions(ByteBuffer _bb,
                                                                             BarrageSubscriptionOptions obj)

__init

public void __init(int _i,
                   ByteBuffer _bb)

__assign

public BarrageSubscriptionOptions __assign(int _i,
                                           ByteBuffer _bb)

columnConversionMode

public byte columnConversionMode()

see enum for details

useDeephavenNulls

public boolean useDeephavenNulls()

Deephaven reserves a value in the range of primitives as a custom NULL value. This enables more efficient transmission by eliminating the additional complexity of the validity buffer.

minUpdateIntervalMs

public int minUpdateIntervalMs()

Explicitly set the update interval for this subscription. Note that subscriptions with different update intervals cannot share intermediary state with other subscriptions and greatly increases the footprint of the non-conforming subscription. Note: if not supplied (default of zero) then the server uses a consistent value to be efficient and fair to all clients

batchSize

public int batchSize()

Specify a preferred batch size. Server is allowed to be configured to restrict possible values. Too small of a batch size may be dominated with header costs as each batch is wrapped into a separate RecordBatch. Too large of a payload and it may not fit within the maximum payload size. A good default might be 4096. a batch_size of -1 indicates that the server should avoid batching a single logical message

maxMessageSize

public int maxMessageSize()

Specify a maximum allowed message size. Server will enforce this limit by reducing batch size (to a lower limit of one row per batch). If the message size limit cannot be met due to large row sizes, the server will throw a `Status.RESOURCE_EXHAUSTED` exception

columnsAsList

public boolean columnsAsList()

If true, the server will wrap columns with a list. This is useful for clients that do not support modified batches with columns of differing lengths.

createBarrageSubscriptionOptions

public static int createBarrageSubscriptionOptions(com.google.flatbuffers.FlatBufferBuilder builder,
                                                   byte column_conversion_mode,
                                                   boolean use_deephaven_nulls,
                                                   int min_update_interval_ms,
                                                   int batch_size,
                                                   int max_message_size,
                                                   boolean columns_as_list)

startBarrageSubscriptionOptions

public static void startBarrageSubscriptionOptions(com.google.flatbuffers.FlatBufferBuilder builder)

addColumnConversionMode

public static void addColumnConversionMode(com.google.flatbuffers.FlatBufferBuilder builder,
                                           byte columnConversionMode)

addUseDeephavenNulls

public static void addUseDeephavenNulls(com.google.flatbuffers.FlatBufferBuilder builder,
                                        boolean useDeephavenNulls)

addMinUpdateIntervalMs

public static void addMinUpdateIntervalMs(com.google.flatbuffers.FlatBufferBuilder builder,
                                          int minUpdateIntervalMs)

addBatchSize

public static void addBatchSize(com.google.flatbuffers.FlatBufferBuilder builder,
                                int batchSize)

addMaxMessageSize

public static void addMaxMessageSize(com.google.flatbuffers.FlatBufferBuilder builder,
                                     int maxMessageSize)

addColumnsAsList

public static void addColumnsAsList(com.google.flatbuffers.FlatBufferBuilder builder,
                                    boolean columnsAsList)

endBarrageSubscriptionOptions

public static int endBarrageSubscriptionOptions(com.google.flatbuffers.FlatBufferBuilder builder)