Package io.deephaven.kafka

Class StreamPublisherBase

java.lang.Object

io.deephaven.util.referencecounting.ReferenceCounted

io.deephaven.engine.liveness.ReferenceCountedLivenessReferent

io.deephaven.engine.liveness.ReferenceCountedLivenessNode

io.deephaven.kafka.StreamPublisherBase

All Implemented Interfaces:

LogOutputAppendable, LivenessManager, LivenessNode, LivenessReferent, StreamPublisher

Direct Known Subclasses:

KafkaStreamPublisher

public abstract class StreamPublisherBase
extends ReferenceCountedLivenessNode
implements StreamPublisher

Re-usable abstract implementation of StreamPublisher for stream ingestion to column-chunks.

Users must register a consumer before allowing other threads or objects to interact with a StreamPublisherBase.

Implementations should override shutdown to ensure that their upstream source is properly shutdown, and synchronize on this if they have a need to prevent concurrent calls to flush.

Field Summary

Fields

Modifier and Type	Field	Description
protected WritableChunk<Values>[]	chunks
protected StreamConsumer	consumer

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StreamPublisherBase(@NotNull TableDefinition tableDefinition)

Method Summary

Modifier and Type	Method	Description
void	flush()	Flush any accumulated data in this publisher to the consumer, by invoking its accept method.
protected WritableChunk<Values>[]	getChunksToFill()
void	register(@NotNull StreamConsumer consumer)	Register a consumer whose accept method will be used when sufficient data is accumulated, or on StreamPublisher.flush().

Methods inherited from class io.deephaven.engine.liveness.ReferenceCountedLivenessNode

getWeakReference, initializeTransientFieldsForLiveness, onReferenceCountAtZero, tryManage, tryUnmanage, tryUnmanage

Methods inherited from class io.deephaven.engine.liveness.ReferenceCountedLivenessReferent

destroy, dropReference, tryRetainReference

Methods inherited from class io.deephaven.util.referencecounting.ReferenceCounted

append, decrementReferenceCount, forceReferenceCountToZero, getReferenceCountDebug, incrementReferenceCount, resetReferenceCount, toString, tryDecrementReferenceCount, tryIncrementReferenceCount

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.deephaven.engine.liveness.LivenessManager

manage, unmanage, unmanage

Methods inherited from interface io.deephaven.engine.liveness.LivenessReferent

dropReference, getReferentDescription, retainReference, tryRetainReference

Methods inherited from interface io.deephaven.stream.StreamPublisher

shutdown

Field Details

consumer

protected StreamConsumer consumer

chunks

protected WritableChunk<Values>[] chunks

Constructor Details

StreamPublisherBase

protected StreamPublisherBase(@NotNull
 @NotNull TableDefinition tableDefinition)

Method Details

register

public void register(@NotNull
 @NotNull StreamConsumer consumer)

Description copied from interface: StreamPublisher

Register a consumer whose accept method will be used when sufficient data is accumulated, or on StreamPublisher.flush(). Implementations should also be sure to deliver errors to the registered consumer via its acceptFailure method.

consumer must typically be primed to accept the same chunk types that this produces, in the same order.

consumer should ensure that this is shutdown when it is no longer needed.

Specified by:

register in interface StreamPublisher

Parameters:

consumer - The consumer

getChunksToFill

protected WritableChunk<Values>[] getChunksToFill()

flush

public void flush()

Description copied from interface: StreamPublisher

Flush any accumulated data in this publisher to the consumer, by invoking its accept method.

Specified by:

flush in interface StreamPublisher