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

[#2401] Improve documentation of HttpObjectAggregator

Browse Source 
Motivation:
Make it more clear what the output of HttpObjectAggregator is and that it need to come after the encoder in the pipeline.

Modifications:
Change javadocs to make things more clear.

Result:
Better docs
This commit is contained in:
Norman Maurer 2014-04-17 15:42:47 +02:00
parent 9b670d819f
commit 18e2a45d7c
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
codec-http/src/main/java/io/netty/handler/codec/http/HttpObjectAggregator.java
View File

@ -35,8 +35,9 @@ import static io.netty.handler.codec.http.HttpHeaders.*;
/** /**
* A {@link ChannelHandler} that aggregates an {@link HttpMessage} * A {@link ChannelHandler} that aggregates an {@link HttpMessage}
* and its following {@link HttpContent}s into a single {@link HttpMessage} with * and its following {@link HttpContent}s into a single {@link FullHttpRequest}
* no following {@link HttpContent}s. It is useful when you don't want to take * or {@link FullHttpResponse} (depending on if it used to handle requests or responses)
* with no following {@link HttpContent}s. It is useful when you don't want to take
* care of HTTP messages whose transfer encoding is 'chunked'. Insert this * care of HTTP messages whose transfer encoding is 'chunked'. Insert this
* handler after {@link HttpObjectDecoder} in the {@link ChannelPipeline}: * handler after {@link HttpObjectDecoder} in the {@link ChannelPipeline}:
* <pre> * <pre>
@ -48,6 +49,8 @@ import static io.netty.handler.codec.http.HttpHeaders.*;
* ... * ...
* p.addLast("handler", new HttpRequestHandler()); * p.addLast("handler", new HttpRequestHandler());
* </pre> * </pre>
* Be aware that you need to have the {@link HttpResponseEncoder} or {@link HttpRequestEncoder}
* before the {@link HttpObjectAggregator} in the {@link ChannelPipeline}.
*/ */
public class HttpObjectAggregator extends MessageToMessageDecoder<HttpObject> { public class HttpObjectAggregator extends MessageToMessageDecoder<HttpObject> {