Go to file
Chris Vest 782d70281e
Reduce reliance on ScheduledFuture (#11635)
Motivation:
If we don't need the scheduled future, then it will be one less complication when we change Netty Future to no longer extend JDK Future.
It would also result in fewer elements in our API.

Modification:
There was only one real use of ScheduledFuture in our code, in Cache.
This has been changed to wrap an ordinary future with a deadline for implementing the Delayed interface.
All other places were effectively overspecifying by relying on ScheduledFuture.
A few places were also specifying JDK Futures - these have been changed to specify Netty Futures.

Result:
Reduced dependency on the ScheduledFuture interfaces.
2021-08-31 16:06:34 +02:00
.github Replace master with main branch (#11629) 2021-08-30 15:37:49 +02:00
.mvn/wrapper Use MAVEN_OPTS to setup timeouts for dependency downloads (#11250) 2021-05-12 18:04:33 +02:00
all Use the standard `japicmp.skip` instead of the custom `skipJapicmp` (#11558) 2021-08-10 09:07:04 +02:00
bom Add version for netty-tcnative* to bom (#11609) 2021-08-25 08:54:26 +02:00
buffer Don't throw if null is given as ByteBuf when adding components. (#11613) 2021-08-26 08:21:06 +02:00
codec Adjust usage of ChannelFutureListeners.CLOSE to use the ChannelHandlerContext (#11631) 2021-08-31 12:49:30 +02:00
codec-dns Fix leak in TcpDnsTest (#11632) 2021-08-31 08:06:45 +02:00
codec-haproxy Change `!future.isSuccess()` to `future.isFailed()` where it makes sense (#11616) 2021-08-26 09:43:17 +02:00
codec-http Reduce reliance on ScheduledFuture (#11635) 2021-08-31 16:06:34 +02:00
codec-http2 Reduce reliance on ScheduledFuture (#11635) 2021-08-31 16:06:34 +02:00
codec-memcache Don't take Promise as argument in Channel API. (#11346) 2021-08-25 14:12:33 +02:00
codec-mqtt Make variables final (#11548) 2021-08-06 09:28:12 +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 Remove unnecessary toString calls (#11550) 2021-08-05 14:17:23 +02:00
codec-xml Migrate codec-xml tests to JUnit 5 (#11311) 2021-05-26 10:06:05 +02:00
common Add cascadeTo methods to Future (#11623) 2021-08-29 15:44:34 +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 Add CI job for JDK17 (#11584) 2021-08-18 10:13:20 +02:00
example Adjust usage of ChannelFutureListeners.CLOSE to use the ChannelHandlerContext (#11631) 2021-08-31 12:49:30 +02:00
handler Reduce reliance on ScheduledFuture (#11635) 2021-08-31 16:06:34 +02:00
handler-proxy Reduce reliance on ScheduledFuture (#11635) 2021-08-31 16:06:34 +02:00
license Introduce BrotliEncoder (#11256) 2021-07-08 12:01:28 +02:00
microbench Reduce reliance on ScheduledFuture (#11635) 2021-08-31 16:06:34 +02:00
resolver Clean up Future/Promises API (#11575) 2021-08-20 09:55:16 +02:00
resolver-dns Reduce reliance on ScheduledFuture (#11635) 2021-08-31 16:06:34 +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 Adjust usage of ChannelFutureListeners.CLOSE to use the ChannelHandlerContext (#11631) 2021-08-31 12:49:30 +02:00
testsuite-autobahn Adjust usage of ChannelFutureListeners.CLOSE to use the ChannelHandlerContext (#11631) 2021-08-31 12:49:30 +02:00
testsuite-http2 Adjust usage of ChannelFutureListeners.CLOSE to use the ChannelHandlerContext (#11631) 2021-08-31 12:49:30 +02:00
testsuite-native Use the standard `japicmp.skip` instead of the custom `skipJapicmp` (#11558) 2021-08-10 09:07:04 +02:00
testsuite-native-image Adjust usage of ChannelFutureListeners.CLOSE to use the ChannelHandlerContext (#11631) 2021-08-31 12:49:30 +02:00
testsuite-native-image-client Use the standard `japicmp.skip` instead of the custom `skipJapicmp` (#11558) 2021-08-10 09:07:04 +02:00
testsuite-native-image-client-runtime-init Use the standard `japicmp.skip` instead of the custom `skipJapicmp` (#11558) 2021-08-10 09:07:04 +02:00
testsuite-osgi Use the standard `japicmp.skip` instead of the custom `skipJapicmp` (#11558) 2021-08-10 09:07:04 +02:00
testsuite-shading Use the standard `japicmp.skip` instead of the custom `skipJapicmp` (#11558) 2021-08-10 09:07:04 +02:00
transport Reduce reliance on ScheduledFuture (#11635) 2021-08-31 16:06:34 +02:00
transport-blockhound-tests Reduce reliance on ScheduledFuture (#11635) 2021-08-31 16:06:34 +02:00
transport-native-epoll Reduce reliance on ScheduledFuture (#11635) 2021-08-31 16:06:34 +02:00
transport-native-kqueue Reduce reliance on ScheduledFuture (#11635) 2021-08-31 16:06:34 +02:00
transport-native-unix-common Fix a problem with IP protocol version confusion on MacOS when TCP FastOpen is enabled (#11588) 2021-08-18 20:47:56 +02:00
transport-native-unix-common-tests Clean up Future/Promises API (#11575) 2021-08-20 09:55:16 +02:00
transport-sctp Add executor() to ChannelOutboundInvoker and let it replace eventLoop() (#11617) 2021-08-25 18:31:24 +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
.gitattributes
.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 Fix url in README.md (#10915) 2021-01-11 07:50:43 +01: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 Allow server initiated renegotiate when using OpenSSL / BoringSSL based SSLEngine (#11601) 2021-08-20 18:52:43 +02:00
run-example.sh Add license header to our scripts and workflows (#11282) 2021-05-19 14:07:00 +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.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.