Package com.google.protobuf
Class CodedInputStream.IterableDirectByteBufferDecoder
java.lang.Object
com.google.protobuf.CodedInputStream
com.google.protobuf.CodedInputStream.IterableDirectByteBufferDecoder
- Enclosing class:
- CodedInputStream
private static final class CodedInputStream.IterableDirectByteBufferDecoder
extends CodedInputStream
Implementation of
CodedInputStream that uses an as the
data source. Requires the use of sun.misc.Unsafe to perform fast reads on the buffer.-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate intThe amount of available data in the input beyondcurrentLimit.private longIf the current ByteBuffer is unsafe-direct based, currentAddress is the start address of this ByteBuffer; otherwise should be zero.private ByteBufferThe current ByteBuffer;private longThe limit position for current ByteBufferprivate longThe current position for current ByteBufferprivate longprivate intThe absolute position of the end of the current message.private booleanIftrue, indicates that calls to readByteStringorbyte[]may return slices of the underlying buffer, rather than copies.private final booleanIftrue, indicates that all the buffers are backing aByteStringand are therefore considered to be an immutable input source.private final Iterable<ByteBuffer>The object that need to decode.private final Iterator<ByteBuffer>private intThe last tag that was read from this stream.private intThe start position offset of the whole message, used as to reset the totalBytesReadprivate intThe global total message length limitprivate intTotal Bytes have been Read from theIterableByteBufferFields inherited from class com.google.protobuf.CodedInputStream
recursionDepth, recursionLimit, sizeLimit, wrapper -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivateIterableDirectByteBufferDecoder(Iterable<ByteBuffer> inputBufs, int size, boolean immutableFlag) The constructor ofIterable<ByteBuffer>decoder. -
Method Summary
Modifier and TypeMethodDescriptionvoidcheckLastTagWas(int value) Verifies that the last call to readTag() returned the given tag value.private longTry to get the number of remaining bytes incurrentByteBuffer.voidenableAliasing(boolean enabled) EnablesByteStringaliasing of the underlying buffer, trading off on buffer pinning for data copies.intReturns the number of bytes to be read before the current limit.intprivate voidTo get the next ByteBuffer frominput, and then update the parametersintThe total bytes read up to the current position.booleanisAtEnd()Returns true if the stream has reached the end of the input.voidpopLimit(int oldLimit) Discards the current limit, returning to the previous limit.intpushLimit(int byteLimit) SetscurrentLimitto (current position) +byteLimit.booleanreadBool()Read aboolfield value from the stream.byte[]Read abytesfield value from the stream.Read abytesfield value from the stream.Read abytesfield value from the stream.doubleRead adoublefield value from the stream.intreadEnum()Read an enum field value from the stream.intRead afixed32field value from the stream.longRead afixed64field value from the stream.floatRead afloatfield value from the stream.voidreadGroup(int fieldNumber, MessageLite.Builder builder, ExtensionRegistryLite extensionRegistry) Read agroupfield value from the stream.<T extends MessageLite>
TreadGroup(int fieldNumber, Parser<T> parser, ExtensionRegistryLite extensionRegistry) Read agroupfield value from the stream.intRead anint32field value from the stream.longRead anint64field value from the stream.voidreadMessage(MessageLite.Builder builder, ExtensionRegistryLite extensionRegistry) Read an embedded message field value from the stream.<T extends MessageLite>
TreadMessage(Parser<T> parser, ExtensionRegistryLite extensionRegistry) Read an embedded message field value from the stream.byteRead one byte from the input.byte[]readRawBytes(int length) Read a fixed size of bytes from the input.private voidreadRawBytesTo(byte[] bytes, int offset, int length) Try to get raw bytes frominputwith the size oflengthand copy tobytesarray.intRead a 32-bit little-endian integer from the stream.longRead a 64-bit little-endian integer from the stream.intRead a raw Varint from the stream.longRead a raw Varint from the stream.(package private) longVariant of readRawVarint64 for when uncomfortably close to the limit.intRead ansfixed32field value from the stream.longRead ansfixed64field value from the stream.intRead ansint32field value from the stream.longRead ansint64field value from the stream.Read astringfield value from the stream.Read astringfield value from the stream.intreadTag()Attempt to read a field tag, returning zero if we have reached EOF.intRead auint32field value from the stream.longRead auint64field value from the stream.voidreadUnknownGroup(int fieldNumber, MessageLite.Builder builder) Deprecated.private voidprivate intTry to get the number of remaining bytes ininput.voidResets the current size counter to zero (seeCodedInputStream.setSizeLimit(int)).booleanskipField(int tag) Reads and discards a single field, given its tag value.booleanskipField(int tag, CodedOutputStream output) Reads a single field and writes it to output in wire format, given its tag value.voidReads and discards an entire message.voidskipMessage(CodedOutputStream output) Reads an entire message and writes it to output in wire format.voidskipRawBytes(int length) Reads and discardssizebytes.private voidprivate ByteBufferslice(int begin, int end) private voidMethods inherited from class com.google.protobuf.CodedInputStream
checkRecursionLimit, decodeZigZag32, decodeZigZag64, discardUnknownFields, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, readRawVarint32, readRawVarint32, setRecursionLimit, setSizeLimit, shouldDiscardUnknownFields, unsetDiscardUnknownFields
-
Field Details
-
input
The object that need to decode. -
iterator
-
currentByteBuffer
The current ByteBuffer; -
immutable
private final boolean immutableIftrue, indicates that all the buffers are backing aByteStringand are therefore considered to be an immutable input source. -
enableAliasing
private boolean enableAliasingIftrue, indicates that calls to readByteStringorbyte[]may return slices of the underlying buffer, rather than copies. -
totalBufferSize
private int totalBufferSizeThe global total message length limit -
bufferSizeAfterCurrentLimit
private int bufferSizeAfterCurrentLimitThe amount of available data in the input beyondcurrentLimit. -
currentLimit
private int currentLimitThe absolute position of the end of the current message. -
lastTag
private int lastTagThe last tag that was read from this stream. -
totalBytesRead
private int totalBytesReadTotal Bytes have been Read from theIterableByteBuffer -
startOffset
private int startOffsetThe start position offset of the whole message, used as to reset the totalBytesRead -
currentByteBufferPos
private long currentByteBufferPosThe current position for current ByteBuffer -
currentByteBufferStartPos
private long currentByteBufferStartPos -
currentAddress
private long currentAddressIf the current ByteBuffer is unsafe-direct based, currentAddress is the start address of this ByteBuffer; otherwise should be zero. -
currentByteBufferLimit
private long currentByteBufferLimitThe limit position for current ByteBuffer
-
-
Constructor Details
-
IterableDirectByteBufferDecoder
private IterableDirectByteBufferDecoder(Iterable<ByteBuffer> inputBufs, int size, boolean immutableFlag) The constructor ofIterable<ByteBuffer>decoder.- Parameters:
inputBufs- The input data.size- The total size of the input data.immutableFlag- whether the input data is immutable.
-
-
Method Details
-
getNextByteBuffer
To get the next ByteBuffer frominput, and then update the parameters- Throws:
InvalidProtocolBufferException
-
tryGetNextByteBuffer
private void tryGetNextByteBuffer() -
readTag
Description copied from class:CodedInputStreamAttempt to read a field tag, returning zero if we have reached EOF. Protocol message parsers use this to read tags, since a protocol message may legally end wherever a tag occurs, and zero is not a valid tag number.- Specified by:
readTagin classCodedInputStream- Throws:
IOException
-
checkLastTagWas
Description copied from class:CodedInputStreamVerifies that the last call to readTag() returned the given tag value. This is used to verify that a nested group ended with the correct end tag.- Specified by:
checkLastTagWasin classCodedInputStream- Throws:
InvalidProtocolBufferException-valuedoes not match the last tag.
-
getLastTag
public int getLastTag()- Specified by:
getLastTagin classCodedInputStream
-
skipField
Description copied from class:CodedInputStreamReads and discards a single field, given its tag value.- Specified by:
skipFieldin classCodedInputStream- Returns:
falseif the tag is an endgroup tag, in which case nothing is skipped. Otherwise, returnstrue.- Throws:
IOException
-
skipField
Description copied from class:CodedInputStreamReads a single field and writes it to output in wire format, given its tag value.- Specified by:
skipFieldin classCodedInputStream- Returns:
falseif the tag is an endgroup tag, in which case nothing is skipped. Otherwise, returnstrue.- Throws:
IOException
-
skipMessage
Description copied from class:CodedInputStreamReads and discards an entire message. This will read either until EOF or until an endgroup tag, whichever comes first.- Specified by:
skipMessagein classCodedInputStream- Throws:
IOException
-
skipMessage
Description copied from class:CodedInputStreamReads an entire message and writes it to output in wire format. This will read either until EOF or until an endgroup tag, whichever comes first.- Specified by:
skipMessagein classCodedInputStream- Throws:
IOException
-
readDouble
Description copied from class:CodedInputStreamRead adoublefield value from the stream.- Specified by:
readDoublein classCodedInputStream- Throws:
IOException
-
readFloat
Description copied from class:CodedInputStreamRead afloatfield value from the stream.- Specified by:
readFloatin classCodedInputStream- Throws:
IOException
-
readUInt64
Description copied from class:CodedInputStreamRead auint64field value from the stream.- Specified by:
readUInt64in classCodedInputStream- Throws:
IOException
-
readInt64
Description copied from class:CodedInputStreamRead anint64field value from the stream.- Specified by:
readInt64in classCodedInputStream- Throws:
IOException
-
readInt32
Description copied from class:CodedInputStreamRead anint32field value from the stream.- Specified by:
readInt32in classCodedInputStream- Throws:
IOException
-
readFixed64
Description copied from class:CodedInputStreamRead afixed64field value from the stream.- Specified by:
readFixed64in classCodedInputStream- Throws:
IOException
-
readFixed32
Description copied from class:CodedInputStreamRead afixed32field value from the stream.- Specified by:
readFixed32in classCodedInputStream- Throws:
IOException
-
readBool
Description copied from class:CodedInputStreamRead aboolfield value from the stream.- Specified by:
readBoolin classCodedInputStream- Throws:
IOException
-
readString
Description copied from class:CodedInputStreamRead astringfield value from the stream. If the stream contains malformed UTF-8, replace the offending bytes with the standard UTF-8 replacement character.- Specified by:
readStringin classCodedInputStream- Throws:
IOException
-
readStringRequireUtf8
Description copied from class:CodedInputStreamRead astringfield value from the stream. If the stream contains malformed UTF-8, throw exceptionInvalidProtocolBufferException.- Specified by:
readStringRequireUtf8in classCodedInputStream- Throws:
IOException
-
readGroup
public void readGroup(int fieldNumber, MessageLite.Builder builder, ExtensionRegistryLite extensionRegistry) throws IOException Description copied from class:CodedInputStreamRead agroupfield value from the stream.- Specified by:
readGroupin classCodedInputStream- Throws:
IOException
-
readGroup
public <T extends MessageLite> T readGroup(int fieldNumber, Parser<T> parser, ExtensionRegistryLite extensionRegistry) throws IOException Description copied from class:CodedInputStreamRead agroupfield value from the stream.- Specified by:
readGroupin classCodedInputStream- Throws:
IOException
-
readUnknownGroup
@Deprecated public void readUnknownGroup(int fieldNumber, MessageLite.Builder builder) throws IOException Deprecated.Description copied from class:CodedInputStreamReads agroupfield value from the stream and merges it into the givenUnknownFieldSet.- Specified by:
readUnknownGroupin classCodedInputStream- Throws:
IOException
-
readMessage
public void readMessage(MessageLite.Builder builder, ExtensionRegistryLite extensionRegistry) throws IOException Description copied from class:CodedInputStreamRead an embedded message field value from the stream.- Specified by:
readMessagein classCodedInputStream- Throws:
IOException
-
readMessage
public <T extends MessageLite> T readMessage(Parser<T> parser, ExtensionRegistryLite extensionRegistry) throws IOException Description copied from class:CodedInputStreamRead an embedded message field value from the stream.- Specified by:
readMessagein classCodedInputStream- Throws:
IOException
-
readBytes
Description copied from class:CodedInputStreamRead abytesfield value from the stream.- Specified by:
readBytesin classCodedInputStream- Throws:
IOException
-
readByteArray
Description copied from class:CodedInputStreamRead abytesfield value from the stream.- Specified by:
readByteArrayin classCodedInputStream- Throws:
IOException
-
readByteBuffer
Description copied from class:CodedInputStreamRead abytesfield value from the stream.- Specified by:
readByteBufferin classCodedInputStream- Throws:
IOException
-
readUInt32
Description copied from class:CodedInputStreamRead auint32field value from the stream.- Specified by:
readUInt32in classCodedInputStream- Throws:
IOException
-
readEnum
Description copied from class:CodedInputStreamRead an enum field value from the stream. Caller is responsible for converting the numeric value to an actual enum.- Specified by:
readEnumin classCodedInputStream- Throws:
IOException
-
readSFixed32
Description copied from class:CodedInputStreamRead ansfixed32field value from the stream.- Specified by:
readSFixed32in classCodedInputStream- Throws:
IOException
-
readSFixed64
Description copied from class:CodedInputStreamRead ansfixed64field value from the stream.- Specified by:
readSFixed64in classCodedInputStream- Throws:
IOException
-
readSInt32
Description copied from class:CodedInputStreamRead ansint32field value from the stream.- Specified by:
readSInt32in classCodedInputStream- Throws:
IOException
-
readSInt64
Description copied from class:CodedInputStreamRead ansint64field value from the stream.- Specified by:
readSInt64in classCodedInputStream- Throws:
IOException
-
readRawVarint32
Description copied from class:CodedInputStreamRead a raw Varint from the stream. If larger than 32 bits, discard the upper bits.- Specified by:
readRawVarint32in classCodedInputStream- Throws:
IOException
-
readRawVarint64
Description copied from class:CodedInputStreamRead a raw Varint from the stream.- Specified by:
readRawVarint64in classCodedInputStream- Throws:
IOException
-
readRawVarint64SlowPath
Description copied from class:CodedInputStreamVariant of readRawVarint64 for when uncomfortably close to the limit.- Specified by:
readRawVarint64SlowPathin classCodedInputStream- Throws:
IOException
-
readRawLittleEndian32
Description copied from class:CodedInputStreamRead a 32-bit little-endian integer from the stream.- Specified by:
readRawLittleEndian32in classCodedInputStream- Throws:
IOException
-
readRawLittleEndian64
Description copied from class:CodedInputStreamRead a 64-bit little-endian integer from the stream.- Specified by:
readRawLittleEndian64in classCodedInputStream- Throws:
IOException
-
enableAliasing
public void enableAliasing(boolean enabled) Description copied from class:CodedInputStreamEnablesByteStringaliasing of the underlying buffer, trading off on buffer pinning for data copies. Only valid for buffer-backed streams.- Specified by:
enableAliasingin classCodedInputStream
-
resetSizeCounter
public void resetSizeCounter()Description copied from class:CodedInputStreamResets the current size counter to zero (seeCodedInputStream.setSizeLimit(int)). Only valid forInputStream-backed streams.- Specified by:
resetSizeCounterin classCodedInputStream
-
pushLimit
Description copied from class:CodedInputStreamSetscurrentLimitto (current position) +byteLimit. This is called when descending into a length-delimited embedded message.Note that
pushLimit()does NOT affect how many bytes theCodedInputStreamreads from an underlyingInputStreamwhen refreshing its buffer. If you need to prevent reading past a certain point in the underlyingInputStream(e.g. because you expect it to contain more data after the end of the message which you need to handle differently) then you must place a wrapper around yourInputStreamwhich limits the amount of data that can be read from it.- Specified by:
pushLimitin classCodedInputStream- Returns:
- the old limit.
- Throws:
InvalidProtocolBufferException
-
recomputeBufferSizeAfterLimit
private void recomputeBufferSizeAfterLimit() -
popLimit
public void popLimit(int oldLimit) Description copied from class:CodedInputStreamDiscards the current limit, returning to the previous limit.- Specified by:
popLimitin classCodedInputStream- Parameters:
oldLimit- The old limit, as returned bypushLimit.
-
getBytesUntilLimit
public int getBytesUntilLimit()Description copied from class:CodedInputStreamReturns the number of bytes to be read before the current limit. If no limit is set, returns -1.- Specified by:
getBytesUntilLimitin classCodedInputStream
-
isAtEnd
Description copied from class:CodedInputStreamReturns true if the stream has reached the end of the input. This is the case if either the end of the underlying input source has been reached or if the stream has reached a limit created usingCodedInputStream.pushLimit(int). This function may get blocked when using StreamDecoder as it invokesCodedInputStream.StreamDecoder.tryRefillBuffer(int)in this function which will try to read bytes from input.- Specified by:
isAtEndin classCodedInputStream- Throws:
IOException
-
getTotalBytesRead
public int getTotalBytesRead()Description copied from class:CodedInputStreamThe total bytes read up to the current position. CallingCodedInputStream.resetSizeCounter()resets this value to zero.- Specified by:
getTotalBytesReadin classCodedInputStream
-
readRawByte
Description copied from class:CodedInputStreamRead one byte from the input.- Specified by:
readRawBytein classCodedInputStream- Throws:
InvalidProtocolBufferException- The end of the stream or the current limit was reached.IOException
-
readRawBytes
Description copied from class:CodedInputStreamRead a fixed size of bytes from the input.- Specified by:
readRawBytesin classCodedInputStream- Throws:
InvalidProtocolBufferException- The end of the stream or the current limit was reached.IOException
-
readRawBytesTo
Try to get raw bytes frominputwith the size oflengthand copy tobytesarray. If the size is bigger than the number of remaining bytes in the input, then throwtruncatedMessageexception.- Throws:
IOException
-
skipRawBytes
Description copied from class:CodedInputStreamReads and discardssizebytes.- Specified by:
skipRawBytesin classCodedInputStream- Throws:
InvalidProtocolBufferException- The end of the stream or the current limit was reached.IOException
-
skipRawVarint
- Throws:
IOException
-
remaining
private int remaining()Try to get the number of remaining bytes ininput.- Returns:
- the number of remaining bytes in
input.
-
currentRemaining
private long currentRemaining()Try to get the number of remaining bytes incurrentByteBuffer.- Returns:
- the number of remaining bytes in
currentByteBuffer
-
slice
- Throws:
IOException
-