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

Complete documentation of StreamBufferingEncoder.

Browse Source 
Motivation:

The StreamBufferingEncoder is missing documentation of what happens
to buffered frames when it's closed.

Modifications:

Added this missing piece of documentation.

Result:

Improved documentation.
This commit is contained in:
buchgr 2016-09-23 22:42:05 +02:00 committed by Norman Maurer
parent 3a8b8c9219
commit 6a6d422702
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
codec-http2/src/main/java/io/netty/handler/codec/http2/StreamBufferingEncoder.java
View File

@ -47,6 +47,10 @@ import static io.netty.handler.codec.http2.Http2Exception.connectionError;
* with an ID less than the specified {@code lastStreamId} will immediately fail with a
* {@link Http2GoAwayException}.
* <p/>
* <p>
* If the channel/encoder gets closed, all new and buffered writes will immediately fail with a
* {@link Http2ChannelClosedException}.
* </p>
* <p>This implementation makes the buffering mostly transparent and is expected to be used as a
* drop-in decorator of {@link DefaultHttp2ConnectionEncoder}.
* </p>