Merge pull request #2827 from xfxyjwf/i1251

Update comments for setSizeLimit.
This commit is contained in:
Feng Xiao 2017-03-10 15:02:52 -08:00 committed by GitHub
commit 81f4fe5aab

View File

@ -354,9 +354,9 @@ public abstract class CodedInputStream {
*
* <p>Set the maximum message size. In order to prevent malicious messages from exhausting memory
* or causing integer overflows, {@code CodedInputStream} limits how large a message may be. The
* default limit is 64MB. You should set this limit as small as you can without harming your app's
* functionality. Note that size limits only apply when reading from an {@code InputStream}, not
* when constructed around a raw byte array (nor with {@link ByteString#newCodedInput}).
* default limit is {@code Integer.MAX_INT}. You should set this limit as small as you can without
* harming your app's functionality. Note that size limits only apply when reading from an
* {@code InputStream}, not when constructed around a raw byte array.
*
* <p>If you want to read several messages from a single CodedInputStream, you could call {@link
* #resetSizeCounter()} after each one to avoid hitting the size limit.