Go to file
Alex Vasiliev e2d9665707 Added comments to LineBasedFrameDecoder, JsonObjectDecoder and XmlFrameDecoder that they are only compatible with UTF-8 encoded streams. (#8651)
Motivation:

LineBasedFrameDecoder, JsonObjectDecoder and XmlFrameDecoder upon investigation of the
sourcecode appeared to only support ASCII or UTF-8 input. It is an important characteristic
and ont reflected in any documentation. This could lead to improper usage and bugs.

Modifications:

Javadoc comment is addedd to all three classes to state that implementation is only
compatible with UTF-8 or ASCII input streams and brifly touches on implementaion details.

Result:

The end user of the netty library would not have to study sorcecode to deterime character
encoding limitations for given classes.
2018-12-20 07:40:06 +01:00
.github Use GitHub Issue/PR Template Feature 2016-12-07 11:40:26 -08:00
.mvn support publishing snapshots from docker based ci (#8634) 2018-12-07 05:43:06 +01:00
all [maven-release-plugin] prepare for next development iteration 2018-11-29 11:15:09 +00:00
bom [maven-release-plugin] prepare for next development iteration 2018-11-29 11:15:09 +00:00
buffer Loosen bounds check on CompositeByteBuf's maxNumComponents (#8621) 2018-12-05 08:42:23 +01:00
codec Added comments to LineBasedFrameDecoder, JsonObjectDecoder and XmlFrameDecoder that they are only compatible with UTF-8 encoded streams. (#8651) 2018-12-20 07:40:06 +01:00
codec-dns Correcting Maven Dependencies (#8622) 2018-12-06 09:01:14 +01:00
codec-haproxy Correcting Maven Dependencies (#8622) 2018-12-06 09:01:14 +01:00
codec-http Support 1012, 1013 and 1014 WebSocket close status code (#8664) 2018-12-17 19:42:50 +01:00
codec-http2 Explict always call ctx.read() when AUTO_READ is false and HTTP/2 is used. (#8647) 2018-12-13 19:02:20 +01:00
codec-memcache Correcting Maven Dependencies (#8622) 2018-12-06 09:01:14 +01:00
codec-mqtt Correcting Maven Dependencies (#8622) 2018-12-06 09:01:14 +01:00
codec-redis Correcting Maven Dependencies (#8622) 2018-12-06 09:01:14 +01:00
codec-smtp Correcting Maven Dependencies (#8622) 2018-12-06 09:01:14 +01:00
codec-socks Correcting Maven Dependencies (#8622) 2018-12-06 09:01:14 +01:00
codec-stomp Correcting Maven Dependencies (#8622) 2018-12-06 09:01:14 +01:00
codec-xml Correcting Maven Dependencies (#8622) 2018-12-06 09:01:14 +01:00
common Adding support for whitespace in resource path in tests (#8606) 2018-12-12 10:29:02 +01:00
dev-tools [maven-release-plugin] prepare for next development iteration 2018-11-29 11:15:09 +00:00
docker Update to use OpenJDK 12 EA24 when building with Java 12 (#8672) 2018-12-19 11:28:43 +01:00
example Correcting Maven Dependencies (#8622) 2018-12-06 09:01:14 +01:00
handler Add test for correctly handling SSLSessionBindingEvent when acting on th… (#8649) 2018-12-19 12:55:48 +01:00
handler-proxy Correcting Maven Dependencies (#8622) 2018-12-06 09:01:14 +01:00
license Add the NOTICE of the forked portion of Apache Harmony 2018-01-30 11:22:51 +01:00
microbench Adding an execute burst cost benchmark for Netty executors (#8594) 2018-12-04 15:46:25 +01:00
resolver Adding support for whitespace in resource path in tests (#8606) 2018-12-12 10:29:02 +01:00
resolver-dns NoClassDefFoundError on Android platform when try to use DefaultDnsServerAddressStreamProvider. (#8656) 2018-12-14 21:31:21 +01:00
tarball [maven-release-plugin] prepare for next development iteration 2018-11-29 11:15:09 +00:00
testsuite Skip test on windows as the semantics we expect are only true on Linux / Unix / BSD / MacOS (#8629) 2018-12-06 20:43:40 +01:00
testsuite-autobahn Upgrade to new version of autobahntestsuite maven plugin. (#8668) 2018-12-17 17:25:22 +01:00
testsuite-http2 Correcting Maven Dependencies (#8622) 2018-12-06 09:01:14 +01:00
testsuite-osgi Update to OpenJDK 12 ea22 (#8618) 2018-12-04 11:59:10 +01:00
testsuite-shading [maven-release-plugin] prepare for next development iteration 2018-11-29 11:15:09 +00:00
transport More correct fix for using ChannelInitializer with custom EventExecutor. (#8633) 2018-12-07 19:12:06 +01:00
transport-native-epoll Correcting Maven Dependencies (#8622) 2018-12-06 09:01:14 +01:00
transport-native-kqueue Fix ClassCastException and native crash when using kqueue transport. (#8665) 2018-12-19 12:13:56 +01:00
transport-native-unix-common Correcting Maven Dependencies (#8622) 2018-12-06 09:01:14 +01:00
transport-native-unix-common-tests Correcting Maven Dependencies (#8622) 2018-12-06 09:01:14 +01:00
transport-rxtx [maven-release-plugin] prepare for next development iteration 2018-11-29 11:15:09 +00:00
transport-sctp Correcting Maven Dependencies (#8622) 2018-12-06 09:01:14 +01:00
transport-udt Correcting Maven Dependencies (#8622) 2018-12-06 09:01:14 +01:00
.fbprefs Updated Find Bugs configuration 2009-03-04 10:33:09 +00:00
.gitattributes Include mvn wrapper to make setup of development env easier 2018-01-26 08:13:17 +01:00
.gitignore Exclude mainframer related files from git 2018-10-14 13:20:18 +02: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
mvnw Include mvn wrapper to make setup of development env easier 2018-01-26 08:13:17 +01:00
mvnw.cmd Include mvn wrapper to make setup of development env easier 2018-01-26 08:13:17 +01:00
NOTICE.txt Add the NOTICE of the forked portion of Apache Harmony 2018-01-30 11:22:51 +01:00
pom.xml Update to OpenJDK 12 ea22 (#8618) 2018-12-04 11:59:10 +01:00
README.md Provide an Automatic-Module-Name for the netty-all artifact fixes #7644 2018-01-27 20:31:16 +01:00
run-example.sh Add UptimeServer and adjust UptimeClient's code style. 2017-04-28 07:41:07 +02: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.

Usage with JDK 9

Netty can be used in modular JDK9 applications as a collection of automatic modules. The module names follow the reverse-DNS style, and are derived from subproject names rather than root packages due to historical reasons. They are listed below:

  • io.netty.all
  • io.netty.buffer
  • io.netty.codec
  • io.netty.codec.dns
  • io.netty.codec.haproxy
  • io.netty.codec.http
  • io.netty.codec.http2
  • io.netty.codec.memcache
  • io.netty.codec.mqtt
  • io.netty.codec.redis
  • io.netty.codec.smtp
  • io.netty.codec.socks
  • io.netty.codec.stomp
  • io.netty.codec.xml
  • io.netty.common
  • io.netty.handler
  • io.netty.handler.proxy
  • io.netty.resolver
  • io.netty.resolver.dns
  • io.netty.transport
  • io.netty.transport.epoll (native omitted - reserved keyword in Java)
  • io.netty.transport.kqueue (native omitted - reserved keyword in Java)
  • io.netty.transport.unix.common (native omitted - reserved keyword in Java)
  • io.netty.transport.rxtx
  • io.netty.transport.sctp
  • io.netty.transport.udt

Automatic modules do not provide any means to declare dependencies, so you need to list each used module separately in your module-info file.