Package io.deephaven.extensions.barrage

Class BarrageMessageWriterImpl.SubView

java.lang.Object

io.deephaven.extensions.barrage.BarrageMessageWriterImpl.SingleUseMessageView

io.deephaven.extensions.barrage.BarrageMessageWriterImpl.RecordBatchMessageView

io.deephaven.extensions.barrage.BarrageMessageWriterImpl.SubView

All Implemented Interfaces:

BarrageMessageWriter.MessageView

Enclosing class:

BarrageMessageWriterImpl

protected class BarrageMessageWriterImpl.SubView
extends BarrageMessageWriterImpl.RecordBatchMessageView

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SubView(BarrageSubscriptionOptions options, boolean isInitialSnapshot, boolean isFullSubscription, @Nullable RowSet viewport, boolean reverseViewport, @Nullable RowSet keyspaceViewportPrev, @Nullable RowSet keyspaceViewport, @Nullable BitSet subscribedColumns, @Nullable DictionaryWriterRegistry dictionaryRegistry)

Method Summary

Modifier and Type	Method	Description
RowSet	addRowOffsets()
@Nullable DictionaryWriterRegistry	dictionaryRegistry()	Returns the DictionaryWriterRegistry for this stream, or null if no columns use dictionary encoding.
protected void	encodeBatches(Consumer<DefensiveDrainable> visitor)	Encodes the message one batch at a time, handing each batch to visitor as a stream, in order.
protected ByteBuffer	getSubscriptionMetadata()	Generate the metadata for this subscription.
final boolean	isColumnIncluded(int col)	Whether this view writes the data of column col.
RowSet	modRowOffsets(int col)
BarrageOptions	options()

Methods inherited from class io.deephaven.extensions.barrage.BarrageMessageWriterImpl.SingleUseMessageView

forEachStream

Methods inherited from class java.lang.Object

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

Constructor Details

SubView

protected SubView(BarrageSubscriptionOptions options,
 boolean isInitialSnapshot,
 boolean isFullSubscription,
 @Nullable
 @Nullable RowSet viewport,
 boolean reverseViewport,
 @Nullable
 @Nullable RowSet keyspaceViewportPrev,
 @Nullable
 @Nullable RowSet keyspaceViewport,
 @Nullable
 @Nullable BitSet subscribedColumns,
 @Nullable
 @Nullable DictionaryWriterRegistry dictionaryRegistry)

Method Details

encodeBatches

protected void encodeBatches(Consumer<DefensiveDrainable> visitor)
                      throws IOException

Description copied from class: BarrageMessageWriterImpl.SingleUseMessageView

Encodes the message one batch at a time, handing each batch to visitor as a stream, in order. Called at most once.

Specified by:

encodeBatches in class BarrageMessageWriterImpl.SingleUseMessageView

Parameters:

visitor - the visitor, which takes ownership of each stream it is handed

Throws:

IOException

options

public BarrageOptions options()

Specified by:

options in class BarrageMessageWriterImpl.RecordBatchMessageView

addRowOffsets

public RowSet addRowOffsets()

Specified by:

addRowOffsets in class BarrageMessageWriterImpl.RecordBatchMessageView

modRowOffsets

public RowSet modRowOffsets(int col)

Specified by:

modRowOffsets in class BarrageMessageWriterImpl.RecordBatchMessageView

isColumnIncluded

public final boolean isColumnIncluded(int col)

Whether this view writes the data of column col. A column the view leaves out still gets a field node in every batch, as the schema requires, but no rows: it is written as if the message held no data for it.

A producer's message carries data for every column that any of its subscriptions needs, so a subscription's view writes only the columns in its subscribedColumns. Final, as the constructor relies on it.

Specified by:

isColumnIncluded in class BarrageMessageWriterImpl.RecordBatchMessageView

Parameters:

col - the column's index in the message

Returns:

whether the view writes the column's added and modified rows

dictionaryRegistry

@Nullable
public @Nullable DictionaryWriterRegistry dictionaryRegistry()

Description copied from class: BarrageMessageWriterImpl.RecordBatchMessageView

Returns the DictionaryWriterRegistry for this stream, or null if no columns use dictionary encoding. The manager is shared across all batches of the same stream so that DictionaryWriterState instances survive across batch boundaries.

Specified by:

dictionaryRegistry in class BarrageMessageWriterImpl.RecordBatchMessageView

getSubscriptionMetadata

protected ByteBuffer getSubscriptionMetadata()
                                      throws IOException

Generate the metadata for this subscription. For a standard subscription, this is a flatbuffer representing a BarrageMessageWrapper containing a payload of BarrageUpdateMetadata.

Returns:

a ByteBuffer representing the metadata for this subscription

Throws:

IOException - if the metadata could not be serialized