Package com.linkedin.venice.client.store.streaming

Class ReadEnvelopeChunkedDeserializer<V>

java.lang.Object

com.linkedin.venice.client.store.streaming.ReadEnvelopeChunkedDeserializer<V>

Type Parameters:

V -

Direct Known Subclasses:

ComputeResponseRecordV1ChunkedDeserializer, MultiGetResponseRecordV1ChunkedDeserializer

public abstract class ReadEnvelopeChunkedDeserializer<V>
extends Object

This class provides support to deserialize customized records even the input doesn't contain the full record. The user could use write(ByteBuffer) to keep writing more data, and the user can use consume() to consume all the available records so far. All the records can only be consumed once, and after the consumption, the underlying byte array might be freed to reduce GC.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReadEnvelopeChunkedDeserializer.NotEnoughBytesException	Exception when the deserialization hits partial record.
protected static class	ReadEnvelopeChunkedDeserializer.ValueContainer<V>	This class contains two fields: 1.

Field Summary

Fields

Modifier and Type	Field	Description
static final ReadEnvelopeChunkedDeserializer.NotEnoughBytesException	NOT_ENOUGH_BYTES_EXCEPTION

Constructor Summary

Constructors

Constructor	Description
ReadEnvelopeChunkedDeserializer()

Method Summary

Modifier and Type	Method	Description
List<V>	consume()
protected byte[]	readBytes(int bytesStartOffset, int bytesLen)	Utility method to read byte arrays.
protected ReadEnvelopeChunkedDeserializer.ValueContainer<Integer>	readBytesMeta(int currentOffset)	Utility method to read bytes array metadata, which contains the byte length and the byte length to store the serialized byte-length.
protected abstract ReadEnvelopeChunkedDeserializer.ValueContainer<V>	tryDeserializeRecord(int currentPos)	All the derived class will implement this function to provide the customized logic to deserialize a record, and when hitting partial record, it should throw ReadEnvelopeChunkedDeserializer.NotEnoughBytesException.
protected ReadEnvelopeChunkedDeserializer.ValueContainer<Integer>	tryReadInt(int currentOffset)	The following implementation is equivalent to BinaryDecoder.readIndex()
void	write(ByteBuffer bytes)

Methods inherited from class java.lang.Object

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

Field Details

NOT_ENOUGH_BYTES_EXCEPTION

public static final ReadEnvelopeChunkedDeserializer.NotEnoughBytesException NOT_ENOUGH_BYTES_EXCEPTION

Constructor Details

ReadEnvelopeChunkedDeserializer

public ReadEnvelopeChunkedDeserializer()

Method Details

consume

public List<V> consume()

write

public void write(ByteBuffer bytes)

tryDeserializeRecord

protected abstract ReadEnvelopeChunkedDeserializer.ValueContainer<V> tryDeserializeRecord(int currentPos)
                                                                                   throws ReadEnvelopeChunkedDeserializer.NotEnoughBytesException

All the derived class will implement this function to provide the customized logic to deserialize a record, and when hitting partial record, it should throw ReadEnvelopeChunkedDeserializer.NotEnoughBytesException.

Parameters:

currentPos - : current global offset to deserialize

Returns:

Throws:

ReadEnvelopeChunkedDeserializer.NotEnoughBytesException

tryReadInt

protected ReadEnvelopeChunkedDeserializer.ValueContainer<Integer> tryReadInt(int currentOffset)
                                                                      throws ReadEnvelopeChunkedDeserializer.NotEnoughBytesException

The following implementation is equivalent to BinaryDecoder.readIndex()

Throws:

ReadEnvelopeChunkedDeserializer.NotEnoughBytesException

readBytesMeta

protected ReadEnvelopeChunkedDeserializer.ValueContainer<Integer> readBytesMeta(int currentOffset)
                                                                         throws ReadEnvelopeChunkedDeserializer.NotEnoughBytesException

Utility method to read bytes array metadata, which contains the byte length and the byte length to store the serialized byte-length. The reason to introduce this method is to avoid the unnecessary byte array copy until current record is a full record.

Parameters:

currentOffset -

Returns:

Throws:

ReadEnvelopeChunkedDeserializer.NotEnoughBytesException

readBytes

protected byte[] readBytes(int bytesStartOffset,
 int bytesLen)
                    throws ReadEnvelopeChunkedDeserializer.NotEnoughBytesException

Utility method to read byte arrays. We could not reuse the underlying byte array even the requested bytes are fully contained by one single ReadEnvelopeChunkedDeserializer.BytesContainer since the internal ByteBuffer is read-only since ByteBuffer.array() will throw ReadOnlyBufferException. You could refer to ByteString.asByteBuffer() to find more details, which is being used by D2TransportClient.

Parameters:

bytesStartOffset -

bytesLen -

Returns:

Throws:

ReadEnvelopeChunkedDeserializer.NotEnoughBytesException