Go to file
Andrea Cavalli c0ddce316b Rename package 2021-09-17 16:28:14 +02:00
bom Rename package 2021-09-17 16:28:14 +02:00
buffer Rename package 2021-09-17 16:28:14 +02:00
codec/src/test/resources Rename package 2021-09-17 16:28:14 +02:00
common Rename package 2021-09-17 16:28:14 +02:00
dev-tools Rename package 2021-09-17 16:28:14 +02:00
example/src/main/resources/io/net5/example/http2/tiles Rename package 2021-09-17 16:28:14 +02:00
handler/src Rename package 2021-09-17 16:28:14 +02:00
license Introduce BrotliEncoder (#11256) 2021-07-08 12:01:28 +02:00
transport-udt/lib/bin/lib/x86_64-MacOSX-gpp/jni Replace reflection usage with MethodHandles when performance matters (#10097) 2020-03-11 21:04:40 +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 Ignore `.shelf/` folder generated by IntelliJ IDEA (#10445) 2020-08-03 07:52:18 +02:00
.lgtm.yml Enables lgtm.com to process this project and create a CodeQL database 2020-01-20 19:22:49 +01:00
CONTRIBUTING.md Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:10:14 +02:00
LICENSE.txt Enable nohttp check during the build (#10708) 2020-10-23 15:26:25 +02:00
NOTICE.txt Introduce BrotliEncoder (#11256) 2021-07-08 12:01:28 +02:00
README.md Rename package 2021-09-17 16:28:14 +02:00
SECURITY.md Added a security policy (#10692) 2020-10-15 20:40:05 +02:00
mvnw Enable nohttp check during the build (#10708) 2020-10-23 15:26:25 +02:00
mvnw.cmd Enable nohttp check during the build (#10708) 2020-10-23 15:26:25 +02:00
nohttp-checkstyle-suppressions.xml Ensure Checkstyle suppression for dependency-reduced-pom.xml on Windows (#10899) 2021-01-01 19:31:01 +01:00
nohttp-checkstyle.xml Enable nohttp check during the build (#10708) 2020-10-23 15:26:25 +02:00
pom.xml Rename package 2021-09-17 16:28:14 +02:00
run-example.sh Rename package 2021-09-17 16:28:14 +02:00

README.md

Build project

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+ / 4.1+) 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.1 resides in the branch '3.9' and the branch '4.1' 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.net5.all
  • io.net5.buffer
  • io.net5.codec
  • io.net5.codec.dns
  • io.net5.codec.haproxy
  • io.net5.codec.http
  • io.net5.codec.http2
  • io.net5.codec.memcache
  • io.net5.codec.mqtt
  • io.net5.codec.redis
  • io.net5.codec.smtp
  • io.net5.codec.socks
  • io.net5.codec.stomp
  • io.net5.codec.xml
  • io.net5.common
  • io.net5.handler
  • io.net5.handler.proxy
  • io.net5.resolver
  • io.net5.resolver.dns
  • io.net5.transport
  • io.net5.transport.epoll (native omitted - reserved keyword in Java)
  • io.net5.transport.kqueue (native omitted - reserved keyword in Java)
  • io.net5.transport.unix.common (native omitted - reserved keyword in Java)
  • io.net5.transport.rxtx
  • io.net5.transport.sctp
  • io.net5.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.