Package io.deephaven.extensions.barrage

Class BarrageStreamGeneratorImpl

java.lang.Object

io.deephaven.extensions.barrage.BarrageStreamGeneratorImpl

All Implemented Interfaces:

BarrageStreamGenerator<BarrageStreamGeneratorImpl.View>, SafeCloseable, AutoCloseable

public class BarrageStreamGeneratorImpl
extends Object
implements BarrageStreamGenerator<BarrageStreamGeneratorImpl.View>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BarrageStreamGeneratorImpl.ArrowFactory	This factory writes data in Arrow's IPC format which has a terse header and no room for metadata.
static class	BarrageStreamGeneratorImpl.BitSetGenerator
static class	BarrageStreamGeneratorImpl.ByteArrayGenerator
static class	BarrageStreamGeneratorImpl.ChunkListInputStreamGenerator
static class	BarrageStreamGeneratorImpl.ConsecutiveDrainableStreams
static class	BarrageStreamGeneratorImpl.DrainableByteArrayInputStream
static class	BarrageStreamGeneratorImpl.Factory
static class	BarrageStreamGeneratorImpl.ModColumnData
static class	BarrageStreamGeneratorImpl.RowSetGenerator
static class	BarrageStreamGeneratorImpl.RowSetShiftDataGenerator
static class	BarrageStreamGeneratorImpl.SchemaView
static class	BarrageStreamGeneratorImpl.SnapshotView
static class	BarrageStreamGeneratorImpl.SubView
static interface	BarrageStreamGeneratorImpl.View

Field Summary

Fields

Modifier and Type	Field	Description
final BarrageStreamGeneratorImpl.ChunkListInputStreamGenerator[]	addColumnData
int	addGeneratorCount
final long	firstSeq
final boolean	isSnapshot
final long	lastSeq
final BarrageMessage	message
final BarrageStreamGeneratorImpl.ModColumnData[]	modColumnData
final BarrageStreamGeneratorImpl.RowSetGenerator	rowsAdded
final BarrageStreamGeneratorImpl.RowSetGenerator	rowsIncluded
final BarrageStreamGeneratorImpl.RowSetGenerator	rowsRemoved
final BarrageStreamGeneratorImpl.RowSetShiftDataGenerator	shifted
final long	step
final BarragePerformanceLog.WriteMetricsConsumer	writeConsumer

Constructor Summary

Constructors

Constructor	Description
BarrageStreamGeneratorImpl(BarrageMessage message, BarragePerformanceLog.WriteMetricsConsumer writeConsumer)	Create a barrage stream generator that can slice and dice the barrage message for delivery to clients.

Method Summary

Modifier and Type	Method	Description
void	close()
BarrageMessage	getMessage()
BarrageStreamGeneratorImpl.SnapshotView	getSnapshotView(BarrageSnapshotOptions options)	Obtain a Full-Snapshot View of this StreamGenerator that can be sent to a single snapshot requestor.
BarrageStreamGeneratorImpl.SnapshotView	getSnapshotView(BarrageSnapshotOptions options, @Nullable RowSet viewport, boolean reverseViewport, @Nullable RowSet keyspaceViewport, @Nullable BitSet snapshotColumns)	Obtain a View of this StreamGenerator that can be sent to a single snapshot requestor.
BarrageStreamGeneratorImpl.SubView	getSubView(BarrageSubscriptionOptions options, boolean isInitialSnapshot)	Obtain a Full-Subscription View of this StreamGenerator that can be sent to a single subscriber.
BarrageStreamGeneratorImpl.SubView	getSubView(BarrageSubscriptionOptions options, boolean isInitialSnapshot, @Nullable RowSet viewport, boolean reverseViewport, @Nullable RowSet keyspaceViewport, @Nullable BitSet subscribedColumns)	Obtain a View of this StreamGenerator that can be sent to a single subscriber.
protected void	writeHeader(ByteBuffer metadata, org.apache.commons.lang3.mutable.MutableInt size, com.google.flatbuffers.FlatBufferBuilder header, BarrageProtoUtil.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

message

public final BarrageMessage message

writeConsumer

public final BarragePerformanceLog.WriteMetricsConsumer writeConsumer

firstSeq

public final long firstSeq

lastSeq

public final long lastSeq

step

public final long step

isSnapshot

public final boolean isSnapshot

rowsAdded

public final BarrageStreamGeneratorImpl.RowSetGenerator rowsAdded

rowsIncluded

public final BarrageStreamGeneratorImpl.RowSetGenerator rowsIncluded

rowsRemoved

public final BarrageStreamGeneratorImpl.RowSetGenerator rowsRemoved

shifted

public final BarrageStreamGeneratorImpl.RowSetShiftDataGenerator shifted

addColumnData

public final BarrageStreamGeneratorImpl.ChunkListInputStreamGenerator[] addColumnData

addGeneratorCount

public int addGeneratorCount

modColumnData

public final BarrageStreamGeneratorImpl.ModColumnData[] modColumnData

Constructor Details

BarrageStreamGeneratorImpl

public BarrageStreamGeneratorImpl(BarrageMessage message,
 BarragePerformanceLog.WriteMetricsConsumer writeConsumer)

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

Parameters:

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

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

Method Details

getMessage

public BarrageMessage getMessage()

Specified by:

getMessage in interface BarrageStreamGenerator<BarrageStreamGeneratorImpl.View>

Returns:

the BarrageMessage that this generator is operating on

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SafeCloseable

getSubView

public BarrageStreamGeneratorImpl.SubView getSubView(BarrageSubscriptionOptions options,
 boolean isInitialSnapshot,
 @Nullable
 @Nullable RowSet viewport,
 boolean reverseViewport,
 @Nullable
 @Nullable RowSet keyspaceViewport,
 @Nullable
 @Nullable BitSet subscribedColumns)

Obtain a View of this StreamGenerator that can be sent to a single subscriber.

Specified by:

getSubView in interface BarrageStreamGenerator<BarrageStreamGeneratorImpl.View>

Parameters:

options - serialization options for this specific view

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

viewport - is the position-space viewport

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

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 BarrageStreamGeneratorImpl.SubView getSubView(BarrageSubscriptionOptions options,
 boolean isInitialSnapshot)

Obtain a Full-Subscription View of this StreamGenerator that can be sent to a single subscriber.

Specified by:

getSubView in interface BarrageStreamGenerator<BarrageStreamGeneratorImpl.View>

Parameters:

options - serialization options for this specific view

isInitialSnapshot - indicates whether or not 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 BarrageStreamGeneratorImpl.SnapshotView getSnapshotView(BarrageSnapshotOptions options,
 @Nullable
 @Nullable RowSet viewport,
 boolean reverseViewport,
 @Nullable
 @Nullable RowSet keyspaceViewport,
 @Nullable
 @Nullable BitSet snapshotColumns)

Obtain a View of this StreamGenerator that can be sent to a single snapshot requestor.

Specified by:

getSnapshotView in interface BarrageStreamGenerator<BarrageStreamGeneratorImpl.View>

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)

keyspaceViewport - is the key-space viewport

snapshotColumns - are the columns subscribed for this view

Returns:

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

getSnapshotView

public BarrageStreamGeneratorImpl.SnapshotView getSnapshotView(BarrageSnapshotOptions options)

Obtain a Full-Snapshot View of this StreamGenerator that can be sent to a single snapshot requestor.

Specified by:

getSnapshotView in interface BarrageStreamGenerator<BarrageStreamGeneratorImpl.View>

Parameters:

options - serialization options for this specific view

Returns:

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

writeHeader

protected void writeHeader(ByteBuffer metadata,
 org.apache.commons.lang3.mutable.MutableInt size,
 com.google.flatbuffers.FlatBufferBuilder header,
 BarrageProtoUtil.ExposedByteArrayOutputStream baos)
                    throws IOException

This implementation prepares the protobuf FlightData header.

Throws:

IOException