Go to file
Christopher O'Toole f6c16f4897 Attempt at improving docs in HttpObjectAggregator
Motivation:

Documentation was added in #2401 to aid developers in understanding
how HttpObjectAggregator works and that it needs an encoder before it.

In #2471 it was pointed out that the documentation added can actually
add to the confusion and that it might have a typo.

This is an attempt at clearing up that confusion.  Feedback is welcome.

Modifications:

- Adjust class level javadoc for HttpObjectAggregator
  * Remove reference to HttpRequestEncoder
  * Point out when HttpResponseEncoder is needed
  * Point out that either HttpRequestDecoder or HttpResponseDecoder is needed
  * Make clear everything must be added before HttpObjectAggregator
  * Mention HttpServerCodec

Result:

Avoid confusion about dependencies for HttpObjectAggregator on the pipeline.
2016-08-30 22:10:51 +02:00
all [maven-release-plugin] prepare release netty-4.1.5.Final 2016-08-26 04:59:35 +02:00
buffer [#5718] Result of ByteBufUtil.compare(ByteBuf a, ByteBuf b) is dependent on ByteOrder of supplied ByteBufs 2016-08-26 15:36:06 +02:00
codec [maven-release-plugin] prepare release netty-4.1.5.Final 2016-08-26 04:59:35 +02:00
codec-dns [maven-release-plugin] prepare release netty-4.1.5.Final 2016-08-26 04:59:35 +02:00
codec-haproxy [maven-release-plugin] prepare release netty-4.1.5.Final 2016-08-26 04:59:35 +02:00
codec-http Attempt at improving docs in HttpObjectAggregator 2016-08-30 22:10:51 +02:00
codec-http2 [maven-release-plugin] prepare release netty-4.1.5.Final 2016-08-26 04:59:35 +02:00
codec-memcache [maven-release-plugin] prepare release netty-4.1.5.Final 2016-08-26 04:59:35 +02:00
codec-mqtt [maven-release-plugin] prepare release netty-4.1.5.Final 2016-08-26 04:59:35 +02:00
codec-redis [maven-release-plugin] prepare release netty-4.1.5.Final 2016-08-26 04:59:35 +02:00
codec-smtp [maven-release-plugin] prepare release netty-4.1.5.Final 2016-08-26 04:59:35 +02:00
codec-socks [maven-release-plugin] prepare release netty-4.1.5.Final 2016-08-26 04:59:35 +02:00
codec-stomp [maven-release-plugin] prepare release netty-4.1.5.Final 2016-08-26 04:59:35 +02:00
codec-xml [maven-release-plugin] prepare release netty-4.1.5.Final 2016-08-26 04:59:35 +02:00
common [maven-release-plugin] prepare release netty-4.1.5.Final 2016-08-26 04:59:35 +02:00
example [maven-release-plugin] prepare release netty-4.1.5.Final 2016-08-26 04:59:35 +02:00
handler Expose SniHandler's replaceHandler() so that users can implement custom behavior. 2016-08-29 13:18:54 -07:00
handler-proxy [maven-release-plugin] prepare release netty-4.1.5.Final 2016-08-26 04:59:35 +02:00
license added support for Protobuf codec nano runtime 2016-01-19 21:39:17 +01:00
microbench [maven-release-plugin] prepare release netty-4.1.5.Final 2016-08-26 04:59:35 +02:00
resolver [maven-release-plugin] prepare release netty-4.1.5.Final 2016-08-26 04:59:35 +02:00
resolver-dns [maven-release-plugin] prepare release netty-4.1.5.Final 2016-08-26 04:59:35 +02:00
tarball [maven-release-plugin] prepare release netty-4.1.5.Final 2016-08-26 04:59:35 +02:00
testsuite Make NIO and EPOLL transport connect errors more consistent with the JDK 2016-08-27 20:57:36 +02:00
testsuite-osgi [maven-release-plugin] prepare release netty-4.1.5.Final 2016-08-26 04:59:35 +02:00
transport Make NIO and EPOLL transport connect errors more consistent with the JDK 2016-08-27 20:57:36 +02:00
transport-native-epoll Correctly guard against NotYetConnectedExceptions when handling RDHUP. 2016-08-29 12:43:11 +02:00
transport-rxtx [maven-release-plugin] prepare release netty-4.1.5.Final 2016-08-26 04:59:35 +02:00
transport-sctp [maven-release-plugin] prepare release netty-4.1.5.Final 2016-08-26 04:59:35 +02:00
transport-udt [maven-release-plugin] prepare release netty-4.1.5.Final 2016-08-26 04:59:35 +02:00
.fbprefs Updated Find Bugs configuration 2009-03-04 10:33:09 +00:00
.gitignore Use shaded dependency on JCTools instead of copy and paste 2016-06-10 13:19:45 +02:00
.travis.yml Travis CI branch whitelisting 2013-03-11 09:55:43 +09:00
CONTRIBUTING.md Move the pull request guide to the developer guide 2014-03-12 13:13:58 +09:00
LICENSE.txt Relicensed to Apache License v2 2009-08-28 07:15:49 +00:00
NOTICE.txt added support for Protobuf codec nano runtime 2016-01-19 21:39:17 +01:00
pom.xml Update CertificateRequestCallback usage to match new tcnative 2016-08-28 20:26:15 +02:00
README.md Updating Branches to look section to match the current branching structure of the project 2016-03-10 22:08:01 +01:00
run-example.sh Add an example client for codec-redis 2016-04-23 11:18:12 -07:00

Netty Project

Netty is an asynchronous event-driven network application framework for rapid development of maintainable high performance protocol servers & clients.

How to build

For the detailed information about building and developing Netty, please visit the developer guide. This page only gives very basic information.

You require the following to build Netty:

Note that this is build-time requirement. JDK 5 (for 3.x) or 6 (for 4.0+) is enough to run your Netty-based application.

Branches to look

Development of all versions takes place in each branch whose name is identical to <majorVersion>.<minorVersion>. For example, the development of 3.9 and 4.0 resides in the branch '3.9' and the branch '4.0' respectively.