Repository files navigation

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

• Web Site
• Downloads
• Documentation
• @netty_project
• Official Discord server

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

You will require the following to build Netty:

• Latest stableOpenJDK 11 for Netty 5,OpenJDK 8 for older releases.
• Latest stableApache Maven
• If you are on Linux or MacOS, you needadditional development packagesinstalled on your system, because you'll build the native transport.

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

Development of released versions takes place in each branch whose name is identical to<majorVersion>.<minorVersion>.For example, the development of 3.9 and 4.1 resides inthe branch '3.9' andthe branch '4.1' respectively. Development for Netty 5 resides on themain branch.

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

• io.netty5.all
• io.netty5.buffer
• io.netty5.codec
• io.netty5.codec.dns
• io.netty5.codec.http
• io.netty5.codec.http2
• io.netty5.codec.smtp
• io.netty5.codec.xml
• io.netty5.common
• io.netty5.handler
• io.netty5.handler.proxy
• io.netty5.resolver
• io.netty5.resolver.dns
• io.netty5.transport
• io.netty5.transport.epoll (native omitted - reserved keyword in Java)
• io.netty5.transport.kqueue (native omitted - reserved keyword in Java)
• io.netty5.transport.unix.common (native omitted - reserved keyword in Java)

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