Go to file
Chris Vest 6b11f7fbc2
All *Bootstrap methods that used to return ChannelFuture now return Future<Channel> (#11517)
Bootstrap methods now return Future<Channel> instead of ChannelFuture

Motivation:
In #8516 it was proposed to at some point remove the specialised ChannelFuture and ChannelPromise.
Or at least make them not extend Future and Promise, respectively.
One pain point encountered in this discussion is the need to get access to the channel object after it has been initialised, but without waiting for the channel registration to propagate through the pipeline.

Modification:
Add a Bootstrap.createUnregistered method, which will return a Channel directly.
All other Bootstrap methods that previously returned ChannelFuture now return Future<Channel>

Result:
It's now possible to obtain an initialised but unregistered channel from a bootstrap, without blocking.
And the other bootstrap methods now only release their channels through the result of their futures, preventing racy access to the channels.
2021-08-03 19:43:38 +02:00
.github Ensure we include hs_err* files when build failed (#11525) 2021-07-29 08:48:31 +02:00
.mvn/wrapper Use MAVEN_OPTS to setup timeouts for dependency downloads (#11250) 2021-05-12 18:04:33 +02:00
all Fix netty-all artifact (#11274) 2021-05-19 11:18:43 +02:00
bom Fix classifier usage in bom 2020-12-08 14:56:38 +01:00
buffer Add an ByteBuf -> Buffer adaptor (#11518) 2021-07-28 11:16:55 +02:00
codec All *Bootstrap methods that used to return ChannelFuture now return Future<Channel> (#11517) 2021-08-03 19:43:38 +02:00
codec-dns Add @UnstableApi to TcpDnsResponseEncoder (#11526) 2021-07-28 19:53:30 +02:00
codec-haproxy All *Bootstrap methods that used to return ChannelFuture now return Future<Channel> (#11517) 2021-08-03 19:43:38 +02:00
codec-http All *Bootstrap methods that used to return ChannelFuture now return Future<Channel> (#11517) 2021-08-03 19:43:38 +02:00
codec-http2 All *Bootstrap methods that used to return ChannelFuture now return Future<Channel> (#11517) 2021-08-03 19:43:38 +02:00
codec-memcache Remove Progressive*Promise / Progressive*Future (#11374) 2021-06-09 08:32:38 +02:00
codec-mqtt Remove rest of junit4 usage (#11484) 2021-07-13 21:00:53 +02:00
codec-redis Migrate codec-redis to junit5 (#11426) 2021-06-30 14:00:13 +02:00
codec-smtp Migrate codec-smtp tests to JUnit 5 (#11309) 2021-05-26 09:44:06 +02:00
codec-socks Migrate codec-socks tests to JUnit 5 (#11314) 2021-05-26 10:39:13 +02:00
codec-stomp Migrate codec-stomp tests to JUnit 5 (#11312) 2021-05-26 10:17:27 +02:00
codec-xml Migrate codec-xml tests to JUnit 5 (#11311) 2021-05-26 10:06:05 +02:00
common All *Bootstrap methods that used to return ChannelFuture now return Future<Channel> (#11517) 2021-08-03 19:43:38 +02:00
dev-tools Use http in xmlns URIs to make maven release plugin happy again (#10788) 2020-11-10 10:51:05 +01:00
docker Introduce alternative Buffer API (#11347) 2021-06-28 12:06:44 +02:00
example All *Bootstrap methods that used to return ChannelFuture now return Future<Channel> (#11517) 2021-08-03 19:43:38 +02:00
handler All *Bootstrap methods that used to return ChannelFuture now return Future<Channel> (#11517) 2021-08-03 19:43:38 +02:00
handler-proxy All *Bootstrap methods that used to return ChannelFuture now return Future<Channel> (#11517) 2021-08-03 19:43:38 +02:00
license Introduce BrotliEncoder (#11256) 2021-07-08 12:01:28 +02:00
microbench All *Bootstrap methods that used to return ChannelFuture now return Future<Channel> (#11517) 2021-08-03 19:43:38 +02:00
resolver Migrate resolver to junit5 (#11425) 2021-06-30 12:20:27 +02:00
resolver-dns All *Bootstrap methods that used to return ChannelFuture now return Future<Channel> (#11517) 2021-08-03 19:43:38 +02:00
resolver-dns-native-macos Ensure we fail if native lib can not be loaded on macos (#11261) 2021-05-18 08:14:01 +02:00
scripts Remove tarball module (#11377) 2021-06-10 10:20:32 +02:00
testsuite All *Bootstrap methods that used to return ChannelFuture now return Future<Channel> (#11517) 2021-08-03 19:43:38 +02:00
testsuite-autobahn All *Bootstrap methods that used to return ChannelFuture now return Future<Channel> (#11517) 2021-08-03 19:43:38 +02:00
testsuite-http2 All *Bootstrap methods that used to return ChannelFuture now return Future<Channel> (#11517) 2021-08-03 19:43:38 +02:00
testsuite-native Skip deployment of testsuite jars (#11127) 2021-03-30 19:06:34 +02:00
testsuite-native-image All *Bootstrap methods that used to return ChannelFuture now return Future<Channel> (#11517) 2021-08-03 19:43:38 +02:00
testsuite-native-image-client Change reflection config to match constructor (#11453) 2021-07-05 21:05:06 +02:00
testsuite-native-image-client-runtime-init Update graal annotations dependencies GAV to allow license GPL2+CE (#11404) 2021-06-21 16:11:57 +02:00
testsuite-osgi Skip deployment of testsuite jars (#11127) 2021-03-30 19:06:34 +02:00
testsuite-shading Migrate testsuite-shading tests to JUnit 5 (#11323) 2021-05-27 15:59:36 +02:00
transport All *Bootstrap methods that used to return ChannelFuture now return Future<Channel> (#11517) 2021-08-03 19:43:38 +02:00
transport-blockhound-tests All *Bootstrap methods that used to return ChannelFuture now return Future<Channel> (#11517) 2021-08-03 19:43:38 +02:00
transport-native-epoll All *Bootstrap methods that used to return ChannelFuture now return Future<Channel> (#11517) 2021-08-03 19:43:38 +02:00
transport-native-kqueue All *Bootstrap methods that used to return ChannelFuture now return Future<Channel> (#11517) 2021-08-03 19:43:38 +02:00
transport-native-unix-common Add support for Unix domain datagram sockets when using native epoll/kqueue transport (#11476) 2021-07-12 08:45:10 +02:00
transport-native-unix-common-tests All *Bootstrap methods that used to return ChannelFuture now return Future<Channel> (#11517) 2021-08-03 19:43:38 +02:00
transport-sctp All *Bootstrap methods that used to return ChannelFuture now return Future<Channel> (#11517) 2021-08-03 19:43:38 +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
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
NOTICE.txt Introduce BrotliEncoder (#11256) 2021-07-08 12:01:28 +02:00
pom.xml Add @UnstableApi to TcpDnsResponseEncoder (#11526) 2021-07-28 19:53:30 +02:00
README.md Fix url in README.md (#10915) 2021-01-11 07:50:43 +01:00
run-example.sh Add license header to our scripts and workflows (#11282) 2021-05-19 14:07:00 +02:00
SECURITY.md Added a security policy (#10692) 2020-10-15 20:40:05 +02:00

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.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.