andreacavalli/netty5
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fix incorrect javadocs in Http2RemoteFlowController

Browse Source 
Motivation:

The javadocs of Http2RemoteFlowController.isWritable(...) are incorrect.

Modifications:

Update javadocs to reflect reality.

Result:

Correct javadocs.
This commit is contained in:
Norman Maurer 2017-08-04 19:52:01 +02:00
parent 0f8ecdcad5
commit 348745608f
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
codec-http2/src/main/java/io/netty/handler/codec/http2/Http2RemoteFlowController.java
View File

@ -67,11 +67,12 @@ public interface Http2RemoteFlowController extends Http2FlowController {
/** /**
* Determine if the {@code stream} has bytes remaining for use in the flow control window. * Determine if the {@code stream} has bytes remaining for use in the flow control window.
* <p> * <p>
* Note that this only takes into account HTTP/2 flow control. It does <strong>not</strong> take into account * Note that this method respects channel writability. The channel must be writable for this method to
* the underlying {@link io.netty.channel.Channel#isWritable()}. * return {@code true}.
*
* @param stream The stream to test. * @param stream The stream to test.
* @return {@code true} if if the {@code stream} has bytes remaining for use in the flow control window. * @return {@code true} if the {@code stream} has bytes remaining for use in the flow control window and the
* {@code false} otherwise. * channel is writable, {@code false} otherwise.
*/ */
boolean isWritable(Http2Stream stream); boolean isWritable(Http2Stream stream);