Go to file
Paulo Lopes f5c0d2eb56 Add SVM metadata and minimal substitutions to build graalvm native image applications. (#8963)
Motivation:

GraalVM native images are a new way to deliver java applications. Netty is one of the most popular libraries however there are a few limitations that make it impossible to use with native images out of the box. Adding a few metadata (in specific modules will allow the compilation to success and produce working binaries)

Modification:

Added properties files in `META-INF` and substitutions classes (under `internal.svm`) will solve the compilation issues. The substitutions classes are not visible and do not have a public constructor so they are not visible to end users.

Result:

Fixes #8959

This fix is very conservative as it applies the minimum config required to build:

* pure netty servers
* vert.x applications
* grpc applications

The build is having trouble due to checkstyle which does not seem to be able to find the copyright notice on property files.
2019-04-29 09:12:09 +02: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 06:16:39 +01:00
all Use maven plugin to prevent API/ABI breakage as part of build process (#8904) 2019-03-01 19:48:29 +01:00
bom Remove OIO transport (and transports that depend on it). (#8580) 2018-11-21 15:23:18 +01:00
buffer Fix regression in CompositeByteBuf.discard*ReadBytes() (#9068) 2019-04-17 18:03:29 +02:00
codec DefaultHeaders#valueIterator doesn't remove from the in bucket list (#9090) 2019-04-27 21:16:04 +02:00
codec-dns use checkPositive/checkPositiveOrZero (#8835) 2019-02-04 15:55:07 +01:00
codec-haproxy migrate java8: use requireNonNull (#8840) 2019-02-04 10:32:25 +01:00
codec-http Add SVM metadata and minimal substitutions to build graalvm native image applications. (#8963) 2019-04-29 09:12:09 +02:00
codec-http2 Add SVM metadata and minimal substitutions to build graalvm native image applications. (#8963) 2019-04-29 09:12:09 +02:00
codec-memcache use checkPositive/checkPositiveOrZero (#8835) 2019-02-04 15:55:07 +01:00
codec-mqtt migrate java8: use requireNonNull (#8840) 2019-02-04 10:32:25 +01:00
codec-redis migrate java8: use requireNonNull (#8840) 2019-02-04 10:32:25 +01:00
codec-smtp SmtpRequestEncoderTest ByteBuf leak (#9075) 2019-04-19 08:47:28 +02:00
codec-socks migrate java8: use requireNonNull (#8840) 2019-02-04 10:32:25 +01:00
codec-stomp use checkPositive/checkPositiveOrZero (#8835) 2019-02-04 15:55:07 +01:00
codec-xml Update to new checkstyle plugin (#8777) 2019-01-24 16:24:19 +01:00
common Add SVM metadata and minimal substitutions to build graalvm native image applications. (#8963) 2019-04-29 09:12:09 +02:00
dev-tools Update version number to start working on Netty 5 2018-11-20 15:49:57 +01:00
docker Add docker-compose file to compile / test with graalvm (#9072) 2019-04-29 08:33:50 +02:00
example Carefully manage Keep-Alive/Close connection headers in all examples (#8966) 2019-04-02 21:11:39 +02:00
handler Throw SignatureException if OpenSslPrivateKeyMethod.* return null to prevent segfault (#9100) 2019-04-29 08:31:56 +02:00
handler-proxy Remove code that accounts for changing EventExecutors in DefaultPromise (#8996) 2019-04-03 10:36:55 +02:00
license Add the NOTICE of the forked portion of Apache Harmony 2018-01-30 11:22:51 +01:00
microbench The benchmark is not taking into account nanoTime granularity (#9033) 2019-04-15 15:15:08 +02:00
resolver migrate java8: use requireNonNull (#8840) 2019-02-04 10:32:25 +01:00
resolver-dns DnsNameResolver.resolve(...) should notify future as soon as one preferred record was resolved (#9050) 2019-04-15 21:50:28 +02:00
tarball Update version number to start working on Netty 5 2018-11-20 15:49:57 +01:00
testsuite Make Multicast tests more robust (#9053) 2019-04-15 21:40:35 +02:00
testsuite-autobahn Deprecate ChannelInboundHandlerAdapter and ChannelOutboundHandlerAdapter (#8929) 2019-03-13 09:46:10 +01:00
testsuite-http2 Deprecate ChannelInboundHandlerAdapter and ChannelOutboundHandlerAdapter (#8929) 2019-03-13 09:46:10 +01:00
testsuite-native-image Add SVM metadata and minimal substitutions to build graalvm native image applications. (#8963) 2019-04-29 09:12:09 +02:00
testsuite-osgi Adjust testsuite-osgi to resolve bundles from local build (#8944) 2019-03-18 09:56:08 +01:00
testsuite-shading Use maven plugin to prevent API/ABI breakage as part of build process (#8904) 2019-03-01 19:48:29 +01:00
transport Add SVM metadata and minimal substitutions to build graalvm native image applications. (#8963) 2019-04-29 09:12:09 +02:00
transport-native-epoll Remove static wildcard imports in EpollDomainSocketChannelConfig (#9066) 2019-04-18 07:34:08 +02:00
transport-native-kqueue Have (Epoll|KQueue)RecvByteAllocatorHandle extend DelegatingHandle (#9060) 2019-04-16 09:21:43 +02:00
transport-native-unix-common Correctly handle overflow in Native.kevent(...) when EINTR is detected (#9024) 2019-04-10 11:32:26 +02:00
transport-native-unix-common-tests Merge ChannelInboundHandler and ChannelOutboundHandler into ChannelHa… (#8957) 2019-03-28 09:28:27 +00:00
transport-sctp Deprecate ChannelInboundHandlerAdapter and ChannelOutboundHandlerAdapter (#8929) 2019-03-13 09:46:10 +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 Add .gitignore for docker-sync stuff 2019-03-19 14:04:21 +01: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 Add SVM metadata and minimal substitutions to build graalvm native image applications. (#8963) 2019-04-29 09:12:09 +02: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 Drop SPDY support (#8845) 2019-02-07 09:25:31 +01: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.