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 interface	BarrageMessageWriterImpl.RecordBatchMessageView
static class	BarrageMessageWriterImpl.RowSetShiftDataWriter
static class	BarrageMessageWriterImpl.RowSetWriter

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

BarrageMessageWriter.MessageView

Constructor Summary

Constructors

Constructor	Description
BarrageMessageWriterImpl(@NotNull BarrageMessage message, @NotNull ChunkWriter<Chunk<Values>>[] chunkWriters, BarragePerformanceLog.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	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)
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	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.
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

Constructor Details

BarrageMessageWriterImpl

public BarrageMessageWriterImpl(@NotNull
 @NotNull BarrageMessage message,
 @NotNull
 @NotNull ChunkWriter<Chunk<Values>>[] chunkWriters,
 @NotNull
 BarragePerformanceLog.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)

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)

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

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

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