Package io.deephaven.extensions.barrage.util

Interface BarrageMessageReader

All Superinterfaces:

AutoCloseable, SafeCloseable

All Known Implementing Classes:

BarrageMessageReaderImpl

public interface BarrageMessageReader
extends SafeCloseable

A gRPC streaming reader that keeps stream specific context and converts InputStreams to BarrageMessages.

Readers may retain stream-lifetime resources (e.g. dictionary value chunks); call close() when the stream ends.

Method Summary

Modifier and Type	Method	Description
default void	close()
BarrageMessage	safelyParseFrom(BarrageOptions options, ChunkType[] columnChunkTypes, Class<?>[] columnTypes, Class<?>[] componentTypes, InputStream stream)	Converts an InputStream to a BarrageMessage in the context of the provided parameters.

Method Details

close

default void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SafeCloseable

safelyParseFrom

BarrageMessage safelyParseFrom(BarrageOptions options,
 ChunkType[] columnChunkTypes,
 Class<?>[] columnTypes,
 Class<?>[] componentTypes,
 InputStream stream)

Converts an InputStream to a BarrageMessage in the context of the provided parameters.

Parameters:

options - the options related to parsing this message

columnChunkTypes - the types to use for each column chunk

columnTypes - the actual type for the column

componentTypes - the actual component type for the column

stream - the input stream that holds the message to be parsed

Returns:

a BarrageMessage filled out by the stream's payload