Package io.deephaven.extensions.barrage

Class BarrageMessageWriterImpl

java.lang.Object

io.deephaven.extensions.barrage.BarrageMessageWriterImpl

All Implemented Interfaces:

BarrageMessageWriter, SafeCloseable, AutoCloseable

public class BarrageMessageWriterImpl
extends Object
implements BarrageMessageWriter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BarrageMessageWriterImpl.ArrowFactory	This factory writes data in Arrow's IPC format which has a terse header and no room for metadata.
static class	BarrageMessageWriterImpl.BitSetWriter
static class	BarrageMessageWriterImpl.ByteArrayWriter
static class	BarrageMessageWriterImpl.Factory
static class	BarrageMessageWriterImpl.ModColumnWriter
static class	BarrageMessageWriterImpl.RecordBatchMessageView	A view that writes a message as RecordBatches, each preceded by the DictionaryBatches its rows need: the rows and columns that one subscription or snapshot is sent.
static class	BarrageMessageWriterImpl.RowSetShiftDataWriter
static class	BarrageMessageWriterImpl.RowSetWriter
protected static class	BarrageMessageWriterImpl.SingleUseMessageView	A view of a message that may be visited only once: visiting it writes the message, and releases what the message was written from.
protected class	BarrageMessageWriterImpl.SnapshotView
protected class	BarrageMessageWriterImpl.SubView

Nested classes/interfaces inherited from interface io.deephaven.extensions.barrage.BarrageMessageWriter

BarrageMessageWriter.MessageView, BarrageMessageWriter.WriteMetricsConsumer

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_BATCH_SIZE

Constructor Summary

Constructors

Constructor	Description
BarrageMessageWriterImpl(@NotNull BarrageMessage message, @NotNull ChunkWriter<Chunk<Values>>[] chunkWriters, BarrageMessageWriter.WriteMetricsConsumer writeConsumer)	Create a barrage stream writer that can slice and dice the barrage message for delivery to clients.

Method Summary

Modifier and Type	Method	Description
protected static ChunkWriter.DrainableColumn	addDict(BarrageMessageWriterImpl.RecordBatchMessageView view, ChunkWriter.FieldNodeListener fieldNodeListener, ChunkWriter.BufferListener bufferListener, ColumnChunksWriter<Chunk<Values>> chunkListWriter, int chunkIdx, long shift, WritableRowSet myAddedOffsets, RowSet adjustedOffsets, @NotNull DictionaryChunkWriter dictWriter, @NotNull DictionaryWriterState state)
protected static ChunkWriter.DrainableColumn	addEmpty(BarrageMessageWriterImpl.RecordBatchMessageView view, ChunkWriter.FieldNodeListener fieldNodeListener, ChunkWriter.BufferListener bufferListener, ColumnChunksWriter<Chunk<Values>> chunkListWriter)
protected static ChunkWriter.DrainableColumn	addNonEmpty(BarrageMessageWriterImpl.RecordBatchMessageView view, ChunkWriter.FieldNodeListener fieldNodeListener, ChunkWriter.BufferListener bufferListener, ColumnChunksWriter<Chunk<Values>> chunkListWriter, int chunkIdx, long shift, WritableRowSet myAddedOffsets, RowSet adjustedOffsets)
protected int	appendAddColumns(BarrageMessageWriterImpl.RecordBatchMessageView view, long startRange, int targetBatchSize, Consumer<DefensiveDrainable> addStream, ChunkWriter.FieldNodeListener fieldNodeListener, ChunkWriter.BufferListener bufferListener)
protected int	appendAddColumns(BarrageMessageWriterImpl.RecordBatchMessageView view, long startRange, int targetBatchSize, Consumer<DefensiveDrainable> addStream, ChunkWriter.FieldNodeListener fieldNodeListener, ChunkWriter.BufferListener bufferListener, ColumnChunksWriter<Chunk<Values>>[] addColumnData)
protected int	appendModColumns(BarrageMessageWriterImpl.RecordBatchMessageView view, long startRange, int targetBatchSize, Consumer<DefensiveDrainable> addStream, ChunkWriter.FieldNodeListener fieldNodeListener, ChunkWriter.BufferListener bufferListener)
void	close()
protected static int	findWriterForOffset(ChunkWriter.Context[] chunks, long offset)
BarrageMessageWriter.MessageView	getDictionaryBatchView(BarrageOptions options, long dictId, ChunkWriter<Chunk<Values>> valuesWriter, WritableChunk<Values> values, boolean isDelta)	Obtain a BarrageMessageWriter.MessageView of standalone DictionaryBatches carrying values for dictionary dictId, framed like this writer's other messages.
BarrageMessage	getMessage()
BarrageMessageWriter.MessageView	getSnapshotView(BarrageSnapshotOptions options)	Obtain a Full-Snapshot BarrageMessageWriter.MessageView of this BarrageMessageWriter that can be sent to a single requestor.
BarrageMessageWriter.MessageView	getSnapshotView(BarrageSnapshotOptions options, @Nullable RowSet viewport, boolean reverseViewport, @Nullable RowSet keyspaceViewport, @Nullable BitSet snapshotColumns)	Obtain a BarrageMessageWriter.MessageView of this BarrageMessageWriter that can be sent to a single requestor.
BarrageMessageWriter.MessageView	getSnapshotView(BarrageSnapshotOptions options, @Nullable RowSet viewport, boolean reverseViewport, @Nullable RowSet keyspaceViewport, @Nullable BitSet snapshotColumns, @Nullable DictionaryWriterRegistry dictionaryRegistry)	Obtain a BarrageMessageWriter.MessageView of this BarrageMessageWriter that can be sent to a single requestor, with a DictionaryWriterRegistry for any dictionary-encoded columns in the snapshot.
BarrageMessageWriter.MessageView	getSubView(BarrageSubscriptionOptions options, boolean isInitialSnapshot)	Obtain a Full-Subscription BarrageMessageWriter.MessageView of this BarrageMessageWriter that can be sent to a single subscriber.
BarrageMessageWriter.MessageView	getSubView(BarrageSubscriptionOptions options, boolean isInitialSnapshot, boolean isFullSubscription, @Nullable RowSet viewport, boolean reverseViewport, @Nullable RowSet keyspaceViewportPrev, @Nullable RowSet keyspaceViewport, @Nullable BitSet subscribedColumns)	Obtain a BarrageMessageWriter.MessageView of this BarrageMessageWriter that can be sent to a single subscriber.
BarrageMessageWriter.MessageView	getSubView(BarrageSubscriptionOptions options, boolean isInitialSnapshot, boolean isFullSubscription, @Nullable RowSet viewport, boolean reverseViewport, @Nullable RowSet keyspaceViewportPrev, @Nullable RowSet keyspaceViewport, @Nullable BitSet subscribedColumns, @Nullable DictionaryWriterRegistry dictionaryRegistry)	Obtain a BarrageMessageWriter.MessageView of this BarrageMessageWriter that can be sent to a single subscriber, with a persistent per-subscription DictionaryWriterRegistry that survives across multiple ticking updates.
protected void	setRecordBatchLength(BarrageMessageWriterImpl.RecordBatchMessageView view, com.google.flatbuffers.FlatBufferBuilder header, int numRows)
protected void	writeHeader(ByteBuffer metadata, MutableInt size, com.google.flatbuffers.FlatBufferBuilder header, ExposedByteArrayOutputStream baos)	This implementation prepares the protobuf FlightData header.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_BATCH_SIZE

public static final int DEFAULT_BATCH_SIZE

Constructor Details

BarrageMessageWriterImpl

public BarrageMessageWriterImpl(@NotNull
 @NotNull BarrageMessage message,
 @NotNull
 @NotNull ChunkWriter<Chunk<Values>>[] chunkWriters,
 @NotNull
 BarrageMessageWriter.WriteMetricsConsumer writeConsumer)

Create a barrage stream writer that can slice and dice the barrage message for delivery to clients.

Parameters:

message - the writer takes ownership of the message and its internal objects

chunkWriters - the chunk chunkWriters

writeConsumer - a method that can be used to record write time

Method Details

getMessage

public BarrageMessage getMessage()

Specified by:

getMessage in interface BarrageMessageWriter

Returns:

the BarrageMessage that this writer is operating on

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SafeCloseable

getSubView

public BarrageMessageWriter.MessageView getSubView(BarrageSubscriptionOptions options,
 boolean isInitialSnapshot,
 boolean isFullSubscription,
 @Nullable
 @Nullable RowSet viewport,
 boolean reverseViewport,
 @Nullable
 @Nullable RowSet keyspaceViewportPrev,
 @Nullable
 @Nullable RowSet keyspaceViewport,
 @Nullable
 @Nullable BitSet subscribedColumns)

Description copied from interface: BarrageMessageWriter

Obtain a BarrageMessageWriter.MessageView of this BarrageMessageWriter that can be sent to a single subscriber.

Note that all passed in arguments are owned by the caller and may be modified external to this method.

Specified by:

getSubView in interface BarrageMessageWriter

Parameters:

options - serialization options for this specific view

isInitialSnapshot - indicates whether this is the first snapshot for the listener

isFullSubscription - whether this is a full subscription (possibly a growing viewport)

viewport - is the position-space viewport

reverseViewport - is the viewport reversed (relative to end of table instead of beginning)

keyspaceViewportPrev - is the key-space viewport prior to applying the update

keyspaceViewport - is the key-space viewport

subscribedColumns - are the columns subscribed for this view

Returns:

a MessageView filtered by the subscription properties that can be sent to that subscriber

getSubView

public BarrageMessageWriter.MessageView getSubView(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)

Description copied from interface: BarrageMessageWriter

Obtain a BarrageMessageWriter.MessageView of this BarrageMessageWriter that can be sent to a single subscriber, with a persistent per-subscription DictionaryWriterRegistry that survives across multiple ticking updates.

Note that all passed in arguments are owned by the caller and may be modified external to this method.

Specified by:

getSubView in interface BarrageMessageWriter

Parameters:

options - serialization options for this specific view

isInitialSnapshot - indicates whether this is the first snapshot for the listener

isFullSubscription - whether this is a full subscription (possibly a growing viewport)

viewport - is the position-space viewport

reverseViewport - is the viewport reversed (relative to end of table instead of beginning)

keyspaceViewportPrev - is the key-space viewport prior to applying the update

keyspaceViewport - is the key-space viewport

subscribedColumns - are the columns subscribed for this view

dictionaryRegistry - the persistent dictionary registry for this subscription, or null if unused

Returns:

a MessageView filtered by the subscription properties that can be sent to that subscriber

getSubView

public BarrageMessageWriter.MessageView getSubView(BarrageSubscriptionOptions options,
 boolean isInitialSnapshot)

Description copied from interface: BarrageMessageWriter

Obtain a Full-Subscription BarrageMessageWriter.MessageView of this BarrageMessageWriter that can be sent to a single subscriber.

Specified by:

getSubView in interface BarrageMessageWriter

Parameters:

options - serialization options for this specific view

isInitialSnapshot - indicates whether this is the first snapshot for the listener

Returns:

a MessageView filtered by the subscription properties that can be sent to that subscriber

getSnapshotView

public BarrageMessageWriter.MessageView getSnapshotView(BarrageSnapshotOptions options,
 @Nullable
 @Nullable RowSet viewport,
 boolean reverseViewport,
 @Nullable
 @Nullable RowSet keyspaceViewport,
 @Nullable
 @Nullable BitSet snapshotColumns)

Description copied from interface: BarrageMessageWriter

Obtain a BarrageMessageWriter.MessageView of this BarrageMessageWriter that can be sent to a single requestor.

Note that all passed in arguments are owned by the caller and may be modified external to this method.

Specified by:

getSnapshotView in interface BarrageMessageWriter

Parameters:

options - serialization options for this specific view

viewport - is the position-space viewport

reverseViewport - is the viewport reversed (relative to end of table instead of beginning)

snapshotColumns - are the columns included for this view

Returns:

a MessageView filtered by the snapshot properties that can be sent to that requestor

getSnapshotView

public BarrageMessageWriter.MessageView getSnapshotView(BarrageSnapshotOptions options,
 @Nullable
 @Nullable RowSet viewport,
 boolean reverseViewport,
 @Nullable
 @Nullable RowSet keyspaceViewport,
 @Nullable
 @Nullable BitSet snapshotColumns,
 @Nullable
 @Nullable DictionaryWriterRegistry dictionaryRegistry)

Description copied from interface: BarrageMessageWriter

Obtain a BarrageMessageWriter.MessageView of this BarrageMessageWriter that can be sent to a single requestor, with a DictionaryWriterRegistry for any dictionary-encoded columns in the snapshot.

Note that all passed in arguments are owned by the caller and may be modified external to this method.

Specified by:

getSnapshotView in interface BarrageMessageWriter

Parameters:

options - serialization options for this specific view

viewport - is the position-space viewport

reverseViewport - is the viewport reversed (relative to end of table instead of beginning)

snapshotColumns - are the columns included for this view

dictionaryRegistry - the dictionary registry for this snapshot, or null if unused

Returns:

a MessageView filtered by the snapshot properties that can be sent to that requestor

getSnapshotView

public BarrageMessageWriter.MessageView getSnapshotView(BarrageSnapshotOptions options)

Description copied from interface: BarrageMessageWriter

Obtain a Full-Snapshot BarrageMessageWriter.MessageView of this BarrageMessageWriter that can be sent to a single requestor.

Specified by:

getSnapshotView in interface BarrageMessageWriter

Parameters:

options - serialization options for this specific view

Returns:

a MessageView filtered by the snapshot properties that can be sent to that requestor

getDictionaryBatchView

public BarrageMessageWriter.MessageView getDictionaryBatchView(BarrageOptions options,
 long dictId,
 ChunkWriter<Chunk<Values>> valuesWriter,
 WritableChunk<Values> values,
 boolean isDelta)

Description copied from interface: BarrageMessageWriter

Obtain a BarrageMessageWriter.MessageView of standalone DictionaryBatches carrying values for dictionary dictId, framed like this writer's other messages. A producer that writes one message for several subscribers sends these first, to bring each subscriber's dictionary level with the others'.

The values make one DictionaryBatch, or several when one would reach the maximum message size options allow or carry more values than their batch size, as a message's rows are split into record batches. Only the first replaces the dictionary when isDelta is false; the rest append to it.

Takes ownership of values. The returned view must be visited exactly once.

Specified by:

getDictionaryBatchView in interface BarrageMessageWriter

Parameters:

options - serialization options for the values, including the maximum message size

dictId - the dictionary id

valuesWriter - the writer for the dictionary's values

values - the values to send

isDelta - whether the values append to the dictionary the subscriber holds, rather than replace it

Returns:

a MessageView of the DictionaryBatches, one stream each

setRecordBatchLength

protected void setRecordBatchLength(BarrageMessageWriterImpl.RecordBatchMessageView view,
 com.google.flatbuffers.FlatBufferBuilder header,
 int numRows)

writeHeader

protected void writeHeader(ByteBuffer metadata,
 MutableInt size,
 com.google.flatbuffers.FlatBufferBuilder header,
 ExposedByteArrayOutputStream baos)
                    throws IOException

This implementation prepares the protobuf FlightData header.

Throws:

IOException

findWriterForOffset

protected static int findWriterForOffset(ChunkWriter.Context[] chunks,
 long offset)

appendAddColumns

protected int appendAddColumns(BarrageMessageWriterImpl.RecordBatchMessageView view,
 long startRange,
 int targetBatchSize,
 Consumer<DefensiveDrainable> addStream,
 ChunkWriter.FieldNodeListener fieldNodeListener,
 ChunkWriter.BufferListener bufferListener)
                        throws IOException

Throws:

IOException

appendAddColumns

protected int appendAddColumns(BarrageMessageWriterImpl.RecordBatchMessageView view,
 long startRange,
 int targetBatchSize,
 Consumer<DefensiveDrainable> addStream,
 ChunkWriter.FieldNodeListener fieldNodeListener,
 ChunkWriter.BufferListener bufferListener,
 ColumnChunksWriter<Chunk<Values>>[] addColumnData)
                        throws IOException

Throws:

IOException

addDict

@NotNull
protected static ChunkWriter.DrainableColumn addDict(BarrageMessageWriterImpl.RecordBatchMessageView view,
 ChunkWriter.FieldNodeListener fieldNodeListener,
 ChunkWriter.BufferListener bufferListener,
 ColumnChunksWriter<Chunk<Values>> chunkListWriter,
 int chunkIdx,
 long shift,
 WritableRowSet myAddedOffsets,
 RowSet adjustedOffsets,
 @NotNull
 @NotNull DictionaryChunkWriter dictWriter,
 @NotNull
 @NotNull DictionaryWriterState state)
                                              throws IOException

Throws:

IOException

addNonEmpty

@NotNull
protected static ChunkWriter.DrainableColumn addNonEmpty(BarrageMessageWriterImpl.RecordBatchMessageView view,
 ChunkWriter.FieldNodeListener fieldNodeListener,
 ChunkWriter.BufferListener bufferListener,
 ColumnChunksWriter<Chunk<Values>> chunkListWriter,
 int chunkIdx,
 long shift,
 WritableRowSet myAddedOffsets,
 RowSet adjustedOffsets)
                                                  throws IOException

Throws:

IOException

addEmpty

@NotNull
protected static ChunkWriter.DrainableColumn addEmpty(BarrageMessageWriterImpl.RecordBatchMessageView view,
 ChunkWriter.FieldNodeListener fieldNodeListener,
 ChunkWriter.BufferListener bufferListener,
 ColumnChunksWriter<Chunk<Values>> chunkListWriter)
                                               throws IOException

Throws:

IOException

appendModColumns

protected int appendModColumns(BarrageMessageWriterImpl.RecordBatchMessageView view,
 long startRange,
 int targetBatchSize,
 Consumer<DefensiveDrainable> addStream,
 ChunkWriter.FieldNodeListener fieldNodeListener,
 ChunkWriter.BufferListener bufferListener)
                        throws IOException

Throws:

IOException