Package io.deephaven.extensions.barrage.chunk

Class DictionaryWriterRegistryImpl

java.lang.Object

io.deephaven.extensions.barrage.chunk.DictionaryWriterRegistryImpl

All Implemented Interfaces:

DictionaryWriterRegistry

public final class DictionaryWriterRegistryImpl
extends Object
implements DictionaryWriterRegistry

The server-side DictionaryWriterRegistry implementation, backed by fastutil maps.

Two construction modes:

• Local (default constructor) — for viewport subscriptions and snapshots. Each registry creates LocalDictionaryWriterState instances that are fully private to this stream.
• Shared-backed (DictionaryWriterRegistryImpl(Long2ObjectOpenHashMap) constructor) — for full subscriptions and growing subscriptions targeting a full subscription. Each registry creates SharedDictionaryWriterState instances that delegate index lookups to the table-level SharedWriterDictionary, so all full subscribers share the same value-to-index mapping.

Nested Class Summary

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

DictionaryWriterRegistry.Entry

Constructor Summary

Constructors

Constructor	Description
DictionaryWriterRegistryImpl()	Creates a local registry for viewport subscriptions and snapshots.
DictionaryWriterRegistryImpl(@NotNull it.unimi.dsi.fastutil.longs.Long2ObjectOpenHashMap<SharedWriterDictionary> sharedDictionaries)	Creates a shared-backed registry for full subscriptions and growing subscriptions targeting a full subscription.

Method Summary

Modifier and Type	Method	Description
@NotNull Collection<DictionaryWriterRegistry.Entry>	entries()	Returns all registered entries.
@Nullable DictionaryWriterRegistry.Entry	getEntry(long dictId)	Returns the entry registered for dictId, or null if there is none yet.
@NotNull DictionaryWriterState	getOrCreate(long dictId, @NotNull ChunkWriter<Chunk<Values>> valuesWriter, @NotNull ChunkType valuesChunkType)	Returns (or creates) the DictionaryWriterState for the given dictionary id.
boolean	hasAnyDelta()	Returns true if any registered dictionary has a pending delta that needs a DictionaryBatch message.
void	maybeResetEntries(@NotNull LongUnaryOperator maxSizeForDictId)	Resets each registered DictionaryWriterState whose totalSize exceeds the limit maxSizeForDictId gives for its dictionary id, so the next DictionaryBatch will be isDelta=false with a compacted dictionary.
void	resetDeltas()	Accepts the batch just written, calling DictionaryWriterState.resetDelta() on every registered state, whether or not the batch carried a DictionaryBatch for it.
@Nullable it.unimi.dsi.fastutil.longs.Long2ObjectOpenHashMap<SharedWriterDictionary>	sharedDictionaries()	The producer's shared dictionaries that this registry's states are backed by, or null for a local registry.

Methods inherited from class java.lang.Object

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

Constructor Details

DictionaryWriterRegistryImpl

public DictionaryWriterRegistryImpl()

Creates a local registry for viewport subscriptions and snapshots.

DictionaryWriterRegistryImpl

public DictionaryWriterRegistryImpl(@NotNull
 @NotNull it.unimi.dsi.fastutil.longs.Long2ObjectOpenHashMap<SharedWriterDictionary> sharedDictionaries)

Creates a shared-backed registry for full subscriptions and growing subscriptions targeting a full subscription. The sharedDictionaries map is owned by the io.deephaven.server.barrage.BarrageMessageProducer and lives for the lifetime of the table's producer; it is never cleared. Registries over the same map are used by different subscribers simultaneously, and add to it only while holding its lock. The producer resets dictionaries that have outgrown the table *before* a propagation phase's writes begin, when no registry is adding to it.

Method Details

getOrCreate

@NotNull
public @NotNull DictionaryWriterState getOrCreate(long dictId,
 @NotNull
 @NotNull ChunkWriter<Chunk<Values>> valuesWriter,
 @NotNull
 @NotNull ChunkType valuesChunkType)

Description copied from interface: DictionaryWriterRegistry

Returns (or creates) the DictionaryWriterState for the given dictionary id.

The first call for a given dictId registers the valuesWriter for that id and creates the appropriate state type. Subsequent calls for the same id return the existing state.

Specified by:

getOrCreate in interface DictionaryWriterRegistry

sharedDictionaries

@InternalUseOnly
@Nullable
public @Nullable it.unimi.dsi.fastutil.longs.Long2ObjectOpenHashMap<SharedWriterDictionary> sharedDictionaries()

The producer's shared dictionaries that this registry's states are backed by, or null for a local registry.

getEntry

@InternalUseOnly
@Nullable
public @Nullable DictionaryWriterRegistry.Entry getEntry(long dictId)

Returns the entry registered for dictId, or null if there is none yet.

entries

@NotNull
public @NotNull Collection<DictionaryWriterRegistry.Entry> entries()

Description copied from interface: DictionaryWriterRegistry

Returns all registered entries.

Specified by:

entries in interface DictionaryWriterRegistry

hasAnyDelta

public boolean hasAnyDelta()

Description copied from interface: DictionaryWriterRegistry

Returns true if any registered dictionary has a pending delta that needs a DictionaryBatch message.

Specified by:

hasAnyDelta in interface DictionaryWriterRegistry

resetDeltas

public void resetDeltas()

Description copied from interface: DictionaryWriterRegistry

Accepts the batch just written, calling DictionaryWriterState.resetDelta() on every registered state, whether or not the batch carried a DictionaryBatch for it.

Specified by:

resetDeltas in interface DictionaryWriterRegistry

maybeResetEntries

public void maybeResetEntries(@NotNull
 @NotNull LongUnaryOperator maxSizeForDictId)

Description copied from interface: DictionaryWriterRegistry

Resets each registered DictionaryWriterState whose totalSize exceeds the limit maxSizeForDictId gives for its dictionary id, so the next DictionaryBatch will be isDelta=false with a compacted dictionary. This applies to local (viewport/snapshot) registries only; a shared-backed registry ignores this call, as its SharedWriterDictionary is reset externally.

Specified by:

maybeResetEntries in interface DictionaryWriterRegistry

Parameters:

maxSizeForDictId - the most values the dictionary with a given id may hold before it is reset; typically no more than the live row count visible to the subscription