Go to file
Roman Puchkovskiy 80c28a3c33
Fix native image build for the cases when io.netty.util.NetUtil is initialized at run-time (#10799)
Motivation:

In #10630, field substitutions were introduced for NetUtil.LOCALHOST4, NetUtil.LOCALHOST6 and NetUtil.LOCALHOST fields. They were required to allow a native image be built with most of Netty (including NetUtil) initialized at build time.

The substitutions created in #10630 only define getters, so the 3 fields can only be read in a native image.

But when NetUtil is initialized at run-time (this is what happens in #10797), its static initialization block is executed, and this block writes to all 3 fields. As the substitutions do not provide any setters, field stores are not valid, and such builds fail.

Modifications:

- Add netty-testsuite-native-image-client-runtime-init Maven module that builds a native image deferring NetUtil class initialization till run-time; this module is used to demonstrate the problem and verify the problem is gone with the fix
- Add no-op setters to substitutions for NetUtil.LOCALHOST4, NetUtil.LOCALHOST6 and NetUtil.LOCALHOST

Result:

A native image initializing NetUtil at run-time builds successfully.

Fixes #10797
2020-12-07 18:16:30 +01:00
.github Smaller output in codeql build (#10787) 2020-11-09 15:32:18 +01:00
.mvn Use latest maven release (#9820) 2019-11-27 14:45:28 +01:00
all Use aarch_64 in a consistent way (#10845) 2020-12-07 12:14:23 +01:00
bom [maven-release-plugin] prepare for next development iteration 2020-11-11 05:47:51 +00:00
buffer Fix a bug in LongPriorityQueue internal remove (#10832) 2020-12-02 13:06:00 +01:00
codec Fix NPE in ByteToMessageDecoder if the user removes the handler while channelInputClosed(...) is processing the buffer. (#10817) 2020-11-24 14:08:32 +01:00
codec-dns [maven-release-plugin] prepare for next development iteration 2020-11-11 05:47:51 +00:00
codec-haproxy [maven-release-plugin] prepare for next development iteration 2020-11-11 05:47:51 +00:00
codec-http Enforce status code validation in CloseWebSocketFrame (#10846) 2020-12-07 13:20:08 +01:00
codec-http2 Let Http2ConnectionHandler close stream with voidPromise (#10819) 2020-12-02 10:11:39 +01:00
codec-memcache [maven-release-plugin] prepare for next development iteration 2020-11-11 05:47:51 +00:00
codec-mqtt [maven-release-plugin] prepare for next development iteration 2020-11-11 05:47:51 +00:00
codec-redis [maven-release-plugin] prepare for next development iteration 2020-11-11 05:47:51 +00:00
codec-smtp [maven-release-plugin] prepare for next development iteration 2020-11-11 05:47:51 +00:00
codec-socks [maven-release-plugin] prepare for next development iteration 2020-11-11 05:47:51 +00:00
codec-stomp Provide ability to extend StompSubframeEncoder and improve full stomp frame encoding (allocate one buffer for full frame considering the size of the headers) (#10778) 2020-12-07 09:00:52 +01:00
codec-xml [maven-release-plugin] prepare for next development iteration 2020-11-11 05:47:51 +00:00
common Fix native image build for the cases when io.netty.util.NetUtil is initialized at run-time (#10799) 2020-12-07 18:16:30 +01:00
dev-tools [maven-release-plugin] prepare for next development iteration 2020-11-11 05:47:51 +00:00
docker Use aarch_64 in a consistent way (#10845) 2020-12-07 12:14:23 +01:00
example Provide ability to extend StompSubframeEncoder and improve full stomp frame encoding (allocate one buffer for full frame considering the size of the headers) (#10778) 2020-12-07 09:00:52 +01:00
handler OpenSsl.memoryAddress(...) should use internalNioBuffer(...) if it can't access the memoryAddress (#10818) 2020-11-25 10:31:58 +01:00
handler-proxy [maven-release-plugin] prepare for next development iteration 2020-11-11 05:47:51 +00:00
license Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
microbench Provide ability to extend StompSubframeEncoder and improve full stomp frame encoding (allocate one buffer for full frame considering the size of the headers) (#10778) 2020-12-07 09:00:52 +01:00
resolver [maven-release-plugin] prepare for next development iteration 2020-11-11 05:47:51 +00:00
resolver-dns Don't use the cname cache when using DnsRecordResolveContext (#10808) 2020-11-26 15:34:56 +01:00
resolver-dns-native-macos [maven-release-plugin] prepare for next development iteration 2020-11-11 05:47:51 +00:00
tarball [maven-release-plugin] prepare for next development iteration 2020-11-11 05:47:51 +00:00
testsuite [maven-release-plugin] prepare for next development iteration 2020-11-11 05:47:51 +00:00
testsuite-autobahn [maven-release-plugin] prepare for next development iteration 2020-11-11 05:47:51 +00:00
testsuite-http2 [maven-release-plugin] prepare for next development iteration 2020-11-11 05:47:51 +00:00
testsuite-native-image [maven-release-plugin] prepare for next development iteration 2020-11-11 05:47:51 +00:00
testsuite-native-image-client Fix native image build for the cases when io.netty.util.NetUtil is initialized at run-time (#10799) 2020-12-07 18:16:30 +01:00
testsuite-native-image-client-runtime-init Fix native image build for the cases when io.netty.util.NetUtil is initialized at run-time (#10799) 2020-12-07 18:16:30 +01:00
testsuite-osgi [maven-release-plugin] prepare for next development iteration 2020-11-11 05:47:51 +00:00
testsuite-shading [maven-release-plugin] prepare for next development iteration 2020-11-11 05:47:51 +00:00
transport [maven-release-plugin] prepare for next development iteration 2020-11-11 05:47:51 +00:00
transport-blockhound-tests Add whitelist entry for SSLEngineImpl.wrap to BlockHound configuration (#10844) 2020-12-07 08:06:21 +01:00
transport-native-epoll Use aarch_64 in a consistent way (#10845) 2020-12-07 12:14:23 +01:00
transport-native-kqueue IovArray should support when there is no unsafe present (#10814) 2020-11-23 14:03:32 +01:00
transport-native-unix-common Use aarch_64 in a consistent way (#10845) 2020-12-07 12:14:23 +01:00
transport-native-unix-common-tests IovArray should support when there is no unsafe present (#10814) 2020-11-23 14:03:32 +01:00
transport-rxtx [maven-release-plugin] prepare for next development iteration 2020-11-11 05:47:51 +00:00
transport-sctp [maven-release-plugin] prepare for next development iteration 2020-11-11 05:47:51 +00:00
transport-udt [maven-release-plugin] prepare for next development iteration 2020-11-11 05:47:51 +00: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:51:53 +02:00
.lgtm.yml Enables lgtm.com to process this project and create a CodeQL database 2020-01-17 11:05:53 +01:00
CONTRIBUTING.md Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:09:42 +02:00
LICENSE.txt Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
mvnw Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
mvnw.cmd Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
nohttp-checkstyle-suppressions.xml Use http in xmlns URIs to make maven release plugin happy again (#10788) 2020-11-10 10:22:35 +01:00
nohttp-checkstyle.xml Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
NOTICE.txt Fix License type of dnsinfo (#10773) 2020-11-04 10:40:43 +01:00
pom.xml Fix native image build for the cases when io.netty.util.NetUtil is initialized at run-time (#10799) 2020-12-07 18:16:30 +01:00
README.md Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
run-example.sh Add DNS client examples for run-example.sh (#10283) 2020-05-14 12:10:32 +02:00
SECURITY.md Added a security policy (#10692) 2020-10-15 20:39:37 +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.