(low priority) core,netty,interop-testing: stabilize maxInboundMessageSize API #4399
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
On server side, `maxMessageSize` is deprecated for `maxInboundMessageSize` to match the channel builder. Update usages to use new setter.
zpencer
changed the title
ejona86
reviewed
Apr 27, 2018
| * @return this | ||
| * @throws IllegalArgumentException if max is negative. |
| * | ||
| * @param bytes the maximum number of bytes a single message can be. | ||
| * @return this | ||
| * @throws IllegalArgumentException if max is negative. |
| * @since 1.1.0 | ||
| */ | ||
| @ExperimentalApi("https://github.com/grpc/grpc-java/issues/2307") | ||
| public T maxInboundMessageSize(int max) { | ||
| public T maxInboundMessageSize(int bytes) { | ||
| // intentional nop |
There was a problem hiding this comment.
Probably should add in a checkArgument for bytes >= 0.
| * @since 1.13.0 | ||
| */ | ||
| public T maxInboundMessageSize(int bytes) { | ||
| throw new UnsupportedOperationException(); |
There was a problem hiding this comment.
Client-side doesn't throw. Since this is advisory, that seems the better approach?
There was a problem hiding this comment.
Changed and added comment.
ejona86
approved these changes
Apr 27, 2018
| public T maxInboundMessageSize(int max) { | ||
| // intentional nop | ||
| public T maxInboundMessageSize(int bytes) { | ||
| // intentional noop rather than throw, this method is only advisory. |
There was a problem hiding this comment.
I think you need to have both methods for a short time. We typically have one release with deprecation before removing it.
Also, this makes it easier to make internal users update before removal.
There was a problem hiding this comment.
No methods were removed in this PR.
There was a problem hiding this comment.
Yes, I just renamed max to bytes to be consistent.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
On server side,
maxMessageSizeis deprecated formaxInboundMessageSizeto match the channel builder.Update usages to use new setter.
fixes #2563