Package com.google.protobuf
Class CodedInputStream.StreamDecoder
- java.lang.Object
-
- com.google.protobuf.CodedInputStream
-
- com.google.protobuf.CodedInputStream.StreamDecoder
-
- Enclosing class:
- CodedInputStream
private static final class CodedInputStream.StreamDecoder extends CodedInputStream
Implementation ofCodedInputStream
that uses anInputStream
as the data source.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static interface
CodedInputStream.StreamDecoder.RefillCallback
private class
CodedInputStream.StreamDecoder.SkippedDataSink
Collects the bytes skipped and returns the data in a ByteBuffer.
-
Field Summary
Fields Modifier and Type Field Description private byte[]
buffer
private int
bufferSize
bufferSize represents how many bytes are currently filled in the bufferprivate int
bufferSizeAfterLimit
private int
currentLimit
The absolute position of the end of the current message.private java.io.InputStream
input
private int
lastTag
private int
pos
private CodedInputStream.StreamDecoder.RefillCallback
refillCallback
private int
totalBytesRetired
The total number of bytes read before the current buffer.-
Fields inherited from class com.google.protobuf.CodedInputStream
recursionDepth, recursionLimit, sizeLimit, wrapper
-
-
Constructor Summary
Constructors Modifier Constructor Description private
StreamDecoder(java.io.InputStream input, int bufferSize)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description private static int
available(java.io.InputStream input)
void
checkLastTagWas(int value)
Verifies that the last call to readTag() returned the given tag value.void
enableAliasing(boolean enabled)
EnablesByteString
aliasing of the underlying buffer, trading off on buffer pinning for data copies.int
getBytesUntilLimit()
Returns the number of bytes to be read before the current limit.int
getLastTag()
int
getTotalBytesRead()
The total bytes read up to the current position.boolean
isAtEnd()
Returns true if the stream has reached the end of the input.void
popLimit(int oldLimit)
Discards the current limit, returning to the previous limit.int
pushLimit(int byteLimit)
SetscurrentLimit
to (current position) +byteLimit
.private static int
read(java.io.InputStream input, byte[] data, int offset, int length)
boolean
readBool()
Read abool
field value from the stream.byte[]
readByteArray()
Read abytes
field value from the stream.java.nio.ByteBuffer
readByteBuffer()
Read abytes
field value from the stream.ByteString
readBytes()
Read abytes
field value from the stream.private ByteString
readBytesSlowPath(int size)
Like readBytes, but caller must have already checked the fast path: (size <= (bufferSize - pos) && size > 0 || size == 0)double
readDouble()
Read adouble
field value from the stream.int
readEnum()
Read an enum field value from the stream.int
readFixed32()
Read afixed32
field value from the stream.long
readFixed64()
Read afixed64
field value from the stream.float
readFloat()
Read afloat
field value from the stream.void
readGroup(int fieldNumber, MessageLite.Builder builder, ExtensionRegistryLite extensionRegistry)
Read agroup
field value from the stream.<T extends MessageLite>
TreadGroup(int fieldNumber, Parser<T> parser, ExtensionRegistryLite extensionRegistry)
Read agroup
field value from the stream.int
readInt32()
Read anint32
field value from the stream.long
readInt64()
Read anint64
field value from the stream.void
readMessage(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.byte
readRawByte()
Read 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 java.util.List<byte[]>
readRawBytesSlowPathRemainingChunks(int sizeLeft)
Reads the remaining data in small chunks from the input stream.int
readRawLittleEndian32()
Read a 32-bit little-endian integer from the stream.long
readRawLittleEndian64()
Read a 64-bit little-endian integer from the stream.int
readRawVarint32()
Read a raw Varint from the stream.long
readRawVarint64()
Read a raw Varint from the stream.(package private) long
readRawVarint64SlowPath()
Variant of readRawVarint64 for when uncomfortably close to the limit.int
readSFixed32()
Read ansfixed32
field value from the stream.long
readSFixed64()
Read ansfixed64
field value from the stream.int
readSInt32()
Read ansint32
field value from the stream.long
readSInt64()
Read ansint64
field value from the stream.java.lang.String
readString()
Read astring
field value from the stream.java.lang.String
readStringRequireUtf8()
Read astring
field value from the stream.int
readTag()
Attempt to read a field tag, returning zero if we have reached EOF.int
readUInt32()
Read auint32
field value from the stream.long
readUInt64()
Read auint64
field value from the stream.void
readUnknownGroup(int fieldNumber, MessageLite.Builder builder)
Deprecated.private void
recomputeBufferSizeAfterLimit()
private void
refillBuffer(int n)
Reads more bytes from the input, making at leastn
bytes available in the buffer.void
resetSizeCounter()
Resets the current size counter to zero (seeCodedInputStream.setSizeLimit(int)
).private static long
skip(java.io.InputStream input, long length)
boolean
skipField(int tag)
Reads and discards a single field, given its tag value.boolean
skipField(int tag, CodedOutputStream output)
Reads a single field and writes it to output in wire format, given its tag value.void
skipMessage()
Reads and discards an entire message.void
skipMessage(CodedOutputStream output)
Reads an entire message and writes it to output in wire format.void
skipRawBytes(int size)
Reads and discardssize
bytes.private void
skipRawBytesSlowPath(int size)
Exactly like skipRawBytes, but caller must have already checked the fast path: (size <= (bufferSize - pos) && size >= 0)private void
skipRawVarint()
private void
skipRawVarintFastPath()
private void
skipRawVarintSlowPath()
private boolean
tryRefillBuffer(int n)
Tries to read more bytes from the input, making at leastn
bytes available in the buffer.-
Methods inherited from class com.google.protobuf.CodedInputStream
decodeZigZag32, decodeZigZag64, discardUnknownFields, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, readRawVarint32, readRawVarint32, setRecursionLimit, setSizeLimit, shouldDiscardUnknownFields, unsetDiscardUnknownFields
-
-
-
-
Field Detail
-
input
private final java.io.InputStream input
-
buffer
private final byte[] buffer
-
bufferSize
private int bufferSize
bufferSize 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 totalBytesRetired
The 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 currentLimit
The absolute position of the end of the current message.
-
refillCallback
private CodedInputStream.StreamDecoder.RefillCallback refillCallback
-
-
Method Detail
-
read
private static int read(java.io.InputStream input, byte[] data, int offset, int length) throws java.io.IOException
- Throws:
java.io.IOException
-
skip
private static long skip(java.io.InputStream input, long length) throws java.io.IOException
- Throws:
java.io.IOException
-
available
private static int available(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
readTag
public int readTag() throws java.io.IOException
Description copied from class:CodedInputStream
Attempt 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:
readTag
in classCodedInputStream
- Throws:
java.io.IOException
-
checkLastTagWas
public void checkLastTagWas(int value) throws InvalidProtocolBufferException
Description copied from class:CodedInputStream
Verifies 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:
checkLastTagWas
in classCodedInputStream
- Throws:
InvalidProtocolBufferException
-value
does not match the last tag.
-
getLastTag
public int getLastTag()
- Specified by:
getLastTag
in classCodedInputStream
-
skipField
public boolean skipField(int tag) throws java.io.IOException
Description copied from class:CodedInputStream
Reads and discards a single field, given its tag value.- Specified by:
skipField
in classCodedInputStream
- Returns:
false
if the tag is an endgroup tag, in which case nothing is skipped. Otherwise, returnstrue
.- Throws:
java.io.IOException
-
skipField
public boolean skipField(int tag, CodedOutputStream output) throws java.io.IOException
Description copied from class:CodedInputStream
Reads a single field and writes it to output in wire format, given its tag value.- Specified by:
skipField
in classCodedInputStream
- Returns:
false
if the tag is an endgroup tag, in which case nothing is skipped. Otherwise, returnstrue
.- Throws:
java.io.IOException
-
skipMessage
public void skipMessage() throws java.io.IOException
Description copied from class:CodedInputStream
Reads and discards an entire message. This will read either until EOF or until an endgroup tag, whichever comes first.- Specified by:
skipMessage
in classCodedInputStream
- Throws:
java.io.IOException
-
skipMessage
public void skipMessage(CodedOutputStream output) throws java.io.IOException
Description copied from class:CodedInputStream
Reads 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:
skipMessage
in classCodedInputStream
- Throws:
java.io.IOException
-
readDouble
public double readDouble() throws java.io.IOException
Description copied from class:CodedInputStream
Read adouble
field value from the stream.- Specified by:
readDouble
in classCodedInputStream
- Throws:
java.io.IOException
-
readFloat
public float readFloat() throws java.io.IOException
Description copied from class:CodedInputStream
Read afloat
field value from the stream.- Specified by:
readFloat
in classCodedInputStream
- Throws:
java.io.IOException
-
readUInt64
public long readUInt64() throws java.io.IOException
Description copied from class:CodedInputStream
Read auint64
field value from the stream.- Specified by:
readUInt64
in classCodedInputStream
- Throws:
java.io.IOException
-
readInt64
public long readInt64() throws java.io.IOException
Description copied from class:CodedInputStream
Read anint64
field value from the stream.- Specified by:
readInt64
in classCodedInputStream
- Throws:
java.io.IOException
-
readInt32
public int readInt32() throws java.io.IOException
Description copied from class:CodedInputStream
Read anint32
field value from the stream.- Specified by:
readInt32
in classCodedInputStream
- Throws:
java.io.IOException
-
readFixed64
public long readFixed64() throws java.io.IOException
Description copied from class:CodedInputStream
Read afixed64
field value from the stream.- Specified by:
readFixed64
in classCodedInputStream
- Throws:
java.io.IOException
-
readFixed32
public int readFixed32() throws java.io.IOException
Description copied from class:CodedInputStream
Read afixed32
field value from the stream.- Specified by:
readFixed32
in classCodedInputStream
- Throws:
java.io.IOException
-
readBool
public boolean readBool() throws java.io.IOException
Description copied from class:CodedInputStream
Read abool
field value from the stream.- Specified by:
readBool
in classCodedInputStream
- Throws:
java.io.IOException
-
readString
public java.lang.String readString() throws java.io.IOException
Description copied from class:CodedInputStream
Read astring
field value from the stream. If the stream contains malformed UTF-8, replace the offending bytes with the standard UTF-8 replacement character.- Specified by:
readString
in classCodedInputStream
- Throws:
java.io.IOException
-
readStringRequireUtf8
public java.lang.String readStringRequireUtf8() throws java.io.IOException
Description copied from class:CodedInputStream
Read astring
field value from the stream. If the stream contains malformed UTF-8, throw exceptionInvalidProtocolBufferException
.- Specified by:
readStringRequireUtf8
in classCodedInputStream
- Throws:
java.io.IOException
-
readGroup
public void readGroup(int fieldNumber, MessageLite.Builder builder, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
Description copied from class:CodedInputStream
Read agroup
field value from the stream.- Specified by:
readGroup
in classCodedInputStream
- Throws:
java.io.IOException
-
readGroup
public <T extends MessageLite> T readGroup(int fieldNumber, Parser<T> parser, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
Description copied from class:CodedInputStream
Read agroup
field value from the stream.- Specified by:
readGroup
in classCodedInputStream
- Throws:
java.io.IOException
-
readUnknownGroup
@Deprecated public void readUnknownGroup(int fieldNumber, MessageLite.Builder builder) throws java.io.IOException
Deprecated.Description copied from class:CodedInputStream
Reads agroup
field value from the stream and merges it into the givenUnknownFieldSet
.- Specified by:
readUnknownGroup
in classCodedInputStream
- Throws:
java.io.IOException
-
readMessage
public void readMessage(MessageLite.Builder builder, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
Description copied from class:CodedInputStream
Read an embedded message field value from the stream.- Specified by:
readMessage
in classCodedInputStream
- Throws:
java.io.IOException
-
readMessage
public <T extends MessageLite> T readMessage(Parser<T> parser, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
Description copied from class:CodedInputStream
Read an embedded message field value from the stream.- Specified by:
readMessage
in classCodedInputStream
- Throws:
java.io.IOException
-
readBytes
public ByteString readBytes() throws java.io.IOException
Description copied from class:CodedInputStream
Read abytes
field value from the stream.- Specified by:
readBytes
in classCodedInputStream
- Throws:
java.io.IOException
-
readByteArray
public byte[] readByteArray() throws java.io.IOException
Description copied from class:CodedInputStream
Read abytes
field value from the stream.- Specified by:
readByteArray
in classCodedInputStream
- Throws:
java.io.IOException
-
readByteBuffer
public java.nio.ByteBuffer readByteBuffer() throws java.io.IOException
Description copied from class:CodedInputStream
Read abytes
field value from the stream.- Specified by:
readByteBuffer
in classCodedInputStream
- Throws:
java.io.IOException
-
readUInt32
public int readUInt32() throws java.io.IOException
Description copied from class:CodedInputStream
Read auint32
field value from the stream.- Specified by:
readUInt32
in classCodedInputStream
- Throws:
java.io.IOException
-
readEnum
public int readEnum() throws java.io.IOException
Description copied from class:CodedInputStream
Read an enum field value from the stream. Caller is responsible for converting the numeric value to an actual enum.- Specified by:
readEnum
in classCodedInputStream
- Throws:
java.io.IOException
-
readSFixed32
public int readSFixed32() throws java.io.IOException
Description copied from class:CodedInputStream
Read ansfixed32
field value from the stream.- Specified by:
readSFixed32
in classCodedInputStream
- Throws:
java.io.IOException
-
readSFixed64
public long readSFixed64() throws java.io.IOException
Description copied from class:CodedInputStream
Read ansfixed64
field value from the stream.- Specified by:
readSFixed64
in classCodedInputStream
- Throws:
java.io.IOException
-
readSInt32
public int readSInt32() throws java.io.IOException
Description copied from class:CodedInputStream
Read ansint32
field value from the stream.- Specified by:
readSInt32
in classCodedInputStream
- Throws:
java.io.IOException
-
readSInt64
public long readSInt64() throws java.io.IOException
Description copied from class:CodedInputStream
Read ansint64
field value from the stream.- Specified by:
readSInt64
in classCodedInputStream
- Throws:
java.io.IOException
-
readRawVarint32
public int readRawVarint32() throws java.io.IOException
Description copied from class:CodedInputStream
Read a raw Varint from the stream. If larger than 32 bits, discard the upper bits.- Specified by:
readRawVarint32
in classCodedInputStream
- Throws:
java.io.IOException
-
skipRawVarint
private void skipRawVarint() throws java.io.IOException
- Throws:
java.io.IOException
-
skipRawVarintFastPath
private void skipRawVarintFastPath() throws java.io.IOException
- Throws:
java.io.IOException
-
skipRawVarintSlowPath
private void skipRawVarintSlowPath() throws java.io.IOException
- Throws:
java.io.IOException
-
readRawVarint64
public long readRawVarint64() throws java.io.IOException
Description copied from class:CodedInputStream
Read a raw Varint from the stream.- Specified by:
readRawVarint64
in classCodedInputStream
- Throws:
java.io.IOException
-
readRawVarint64SlowPath
long readRawVarint64SlowPath() throws java.io.IOException
Description copied from class:CodedInputStream
Variant of readRawVarint64 for when uncomfortably close to the limit.- Specified by:
readRawVarint64SlowPath
in classCodedInputStream
- Throws:
java.io.IOException
-
readRawLittleEndian32
public int readRawLittleEndian32() throws java.io.IOException
Description copied from class:CodedInputStream
Read a 32-bit little-endian integer from the stream.- Specified by:
readRawLittleEndian32
in classCodedInputStream
- Throws:
java.io.IOException
-
readRawLittleEndian64
public long readRawLittleEndian64() throws java.io.IOException
Description copied from class:CodedInputStream
Read a 64-bit little-endian integer from the stream.- Specified by:
readRawLittleEndian64
in classCodedInputStream
- Throws:
java.io.IOException
-
enableAliasing
public void enableAliasing(boolean enabled)
Description copied from class:CodedInputStream
EnablesByteString
aliasing of the underlying buffer, trading off on buffer pinning for data copies. Only valid for buffer-backed streams.- Specified by:
enableAliasing
in classCodedInputStream
-
resetSizeCounter
public void resetSizeCounter()
Description copied from class:CodedInputStream
Resets the current size counter to zero (seeCodedInputStream.setSizeLimit(int)
). Only valid forInputStream
-backed streams.- Specified by:
resetSizeCounter
in classCodedInputStream
-
pushLimit
public int pushLimit(int byteLimit) throws InvalidProtocolBufferException
Description copied from class:CodedInputStream
SetscurrentLimit
to (current position) +byteLimit
. This is called when descending into a length-delimited embedded message.Note that
pushLimit()
does NOT affect how many bytes theCodedInputStream
reads from an underlyingInputStream
when 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 yourInputStream
which limits the amount of data that can be read from it.- Specified by:
pushLimit
in classCodedInputStream
- Returns:
- the old limit.
- Throws:
InvalidProtocolBufferException
-
recomputeBufferSizeAfterLimit
private void recomputeBufferSizeAfterLimit()
-
popLimit
public void popLimit(int oldLimit)
Description copied from class:CodedInputStream
Discards the current limit, returning to the previous limit.- Specified by:
popLimit
in classCodedInputStream
- Parameters:
oldLimit
- The old limit, as returned bypushLimit
.
-
getBytesUntilLimit
public int getBytesUntilLimit()
Description copied from class:CodedInputStream
Returns the number of bytes to be read before the current limit. If no limit is set, returns -1.- Specified by:
getBytesUntilLimit
in classCodedInputStream
-
isAtEnd
public boolean isAtEnd() throws java.io.IOException
Description copied from class:CodedInputStream
Returns 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:
isAtEnd
in classCodedInputStream
- Throws:
java.io.IOException
-
getTotalBytesRead
public int getTotalBytesRead()
Description copied from class:CodedInputStream
The total bytes read up to the current position. CallingCodedInputStream.resetSizeCounter()
resets this value to zero.- Specified by:
getTotalBytesRead
in classCodedInputStream
-
refillBuffer
private void refillBuffer(int n) throws java.io.IOException
Reads more bytes from the input, making at leastn
bytes 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.java.io.IOException
-
tryRefillBuffer
private boolean tryRefillBuffer(int n) throws java.io.IOException
Tries to read more bytes from the input, making at leastn
bytes 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:
true
If the bytes could be made available;false
1. Current at the end of the stream 2. The current limit was reached 3. The total size limit was reached- Throws:
java.io.IOException
-
readRawByte
public byte readRawByte() throws java.io.IOException
Description copied from class:CodedInputStream
Read one byte from the input.- Specified by:
readRawByte
in classCodedInputStream
- Throws:
InvalidProtocolBufferException
- The end of the stream or the current limit was reached.java.io.IOException
-
readRawBytes
public byte[] readRawBytes(int size) throws java.io.IOException
Description copied from class:CodedInputStream
Read a fixed size of bytes from the input.- Specified by:
readRawBytes
in classCodedInputStream
- Throws:
InvalidProtocolBufferException
- The end of the stream or the current limit was reached.java.io.IOException
-
readRawBytesSlowPath
private byte[] readRawBytesSlowPath(int size, boolean ensureNoLeakedReferences) throws java.io.IOException
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:
java.io.IOException
-
readRawBytesSlowPathOneChunk
private byte[] readRawBytesSlowPathOneChunk(int size) throws java.io.IOException
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:
java.io.IOException
-
readRawBytesSlowPathRemainingChunks
private java.util.List<byte[]> readRawBytesSlowPathRemainingChunks(int sizeLeft) throws java.io.IOException
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:
java.io.IOException
-
readBytesSlowPath
private ByteString readBytesSlowPath(int size) throws java.io.IOException
Like readBytes, but caller must have already checked the fast path: (size <= (bufferSize - pos) && size > 0 || size == 0)- Throws:
java.io.IOException
-
skipRawBytes
public void skipRawBytes(int size) throws java.io.IOException
Description copied from class:CodedInputStream
Reads and discardssize
bytes.- Specified by:
skipRawBytes
in classCodedInputStream
- Throws:
InvalidProtocolBufferException
- The end of the stream or the current limit was reached.java.io.IOException
-
skipRawBytesSlowPath
private void skipRawBytesSlowPath(int size) throws java.io.IOException
Exactly like skipRawBytes, but caller must have already checked the fast path: (size <= (bufferSize - pos) && size >= 0)- Throws:
java.io.IOException
-
-