Package com.google.protobuf
Class CodedInputStream.StreamDecoder
java.lang.Object
com.google.protobuf.CodedInputStream
com.google.protobuf.CodedInputStream.StreamDecoder
- Enclosing class:
- CodedInputStream
Implementation of
CodedInputStream that uses an InputStream as the data source.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static interfaceprivate classCollects the bytes skipped and returns the data in a ByteBuffer. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final byte[]private intbufferSize represents how many bytes are currently filled in the bufferprivate intprivate intThe absolute position of the end of the current message.private final InputStreamprivate intprivate intprivate intThe total number of bytes read before the current buffer.Fields inherited from class com.google.protobuf.CodedInputStream
recursionDepth, recursionLimit, sizeLimit, wrapper -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate static intavailable(InputStream input) voidcheckLastTagWas(int value) Verifies that the last call to readTag() returned the given tag value.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.intintThe 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.private static intread(InputStream input, byte[] data, int offset, int length) 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.private ByteStringreadBytesSlowPath(int size) Like readBytes, but caller must have already checked the fast path: (size <= (bufferSize - pos) && size > 0 || size == 0)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 size) Read a fixed size of bytes from the input.private byte[]readRawBytesSlowPath(int size, boolean ensureNoLeakedReferences) Exactly like readRawBytes, but caller must have already checked the fast path: (size <= (bufferSize - pos) && size > 0) If ensureNoLeakedReferences is true, the value is guaranteed to have not escaped to untrusted code.private byte[]readRawBytesSlowPathOneChunk(int size) Attempts to read the data in one byte array when it's safe to do.private List<byte[]>readRawBytesSlowPathRemainingChunks(int sizeLeft) Reads the remaining data in small chunks from the input stream.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 voidrefillBuffer(int n) Reads more bytes from the input, making at leastnbytes available in the buffer.voidResets the current size counter to zero (seeCodedInputStream.setSizeLimit(int)).private static longskip(InputStream input, long length) 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 size) Reads and discardssizebytes.private voidskipRawBytesSlowPath(int size) Exactly like skipRawBytes, but caller must have already checked the fast path: (size <= (bufferSize - pos) && size >= 0)private voidprivate voidprivate voidprivate booleantryRefillBuffer(int n) Tries to read more bytes from the input, making at leastnbytes available in the buffer.Methods 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
-
buffer
private final byte[] buffer -
bufferSize
private int bufferSizebufferSize represents how many bytes are currently filled in the buffer -
bufferSizeAfterLimit
private int bufferSizeAfterLimit -
pos
private int pos -
lastTag
private int lastTag -
totalBytesRetired
private int totalBytesRetiredThe total number of bytes read before the current buffer. The total bytes read up to the current position can be computed astotalBytesRetired + pos. This value may be negative if reading started in the middle of the current buffer (e.g. if the constructor that takes a byte array and an offset was used). -
currentLimit
private int currentLimitThe absolute position of the end of the current message. -
refillCallback
-
-
Constructor Details
-
StreamDecoder
-
-
Method Details
-
read
- Throws:
IOException
-
skip
- Throws:
IOException
-
available
- Throws:
IOException
-
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
-
skipRawVarint
- Throws:
IOException
-
skipRawVarintFastPath
- Throws:
IOException
-
skipRawVarintSlowPath
- 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 invokestryRefillBuffer(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
-
refillBuffer
Reads more bytes from the input, making at leastnbytes available in the buffer. Caller must ensure that the requested space is not yet available, and that the requested space is less than BUFFER_SIZE.- Throws:
InvalidProtocolBufferException- The end of the stream or the current limit was reached.IOException
-
tryRefillBuffer
Tries to read more bytes from the input, making at leastnbytes available in the buffer. Caller must ensure that the requested space is not yet available, and that the requested space is less than BUFFER_SIZE.- Returns:
trueIf the bytes could be made available;false1. Current at the end of the stream 2. The current limit was reached 3. The total size limit was reached- Throws:
IOException
-
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
-
readRawBytesSlowPath
Exactly like readRawBytes, but caller must have already checked the fast path: (size <= (bufferSize - pos) && size > 0) If ensureNoLeakedReferences is true, the value is guaranteed to have not escaped to untrusted code.- Throws:
IOException
-
readRawBytesSlowPathOneChunk
Attempts to read the data in one byte array when it's safe to do. Returns null if the size to read is too large and needs to be allocated in smaller chunks for security reasons.Returns a byte[] that may have escaped to user code via InputStream APIs.
- Throws:
IOException
-
readRawBytesSlowPathRemainingChunks
Reads the remaining data in small chunks from the input stream. Returns a byte[] that may have escaped to user code via InputStream APIs.- Throws:
IOException
-
readBytesSlowPath
Like readBytes, but caller must have already checked the fast path: (size <= (bufferSize - pos) && size > 0 || size == 0)- 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
-
skipRawBytesSlowPath
Exactly like skipRawBytes, but caller must have already checked the fast path: (size <= (bufferSize - pos) && size >= 0)- Throws:
IOException
-