Go to file
Norman Maurer ec8e8bd515
Fix event loop shutdown timing fragility (#9639)
Motivation

The current event loop shutdown logic is quite fragile and in the
epoll/NIO cases relies on the default 1 second wait/select timeout that
applies when there are no scheduled tasks. Without this default timeout
the shutdown would hang indefinitely.

The timeout only takes effect in this case because queued scheduled
tasks are first cancelled in
SingleThreadEventExecutor#confirmShutdown(), but I _think_ even this
isn't robust, since the main task queue is subsequently serviced which
could result in some new scheduled task being queued with much later
deadline.

It also means shutdowns are unnecessarily delayed by up to 1 second.

Modifications

- Add/extend unit tests to expose the issue
- Adjust SingleThreadEventExecutor shutdown and confirmShutdown methods
to explicitly add no-op tasks to the taskQueue so that the subsequent
event loop iteration doesn't enter blocking wait (as looks like was
originally intended)

Results

Faster and more robust shutdown of event loops, allows removal of the default wait timeout.
This is a port of https://github.com/netty/netty/pull/9616
2019-10-08 12:00:59 +04:00
.github Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:10:14 +02:00
.mvn support publishing snapshots from docker based ci (#8634) 2018-12-07 06:16:39 +01:00
all Include native-image properties in the netty-all jar (#9518) 2019-08-28 08:09:14 +02:00
bom Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:10:14 +02:00
buffer Fix for incorrect values from CompositeByteBuf#component(int) (#9525) 2019-09-02 13:52:47 +02:00
codec Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:10:14 +02:00
codec-dns Detect truncated responses caused by EDNS0 and MTU miss-match (#9468) 2019-08-17 09:58:40 +02:00
codec-haproxy HAProxyMessageDecoder not correctly handle delimiter in all cases (#9282) 2019-06-27 21:59:09 +02:00
codec-http Fix incorrect comment (#9598) 2019-09-24 10:01:20 +02:00
codec-http2 Add io.netty.handler.codec.http2.Http2ConnectionHandler for runtime GraalVM compilation (#9621) 2019-10-07 11:02:13 +04:00
codec-memcache codec-memcache: copy metadata in binary full request response (#9160) 2019-05-22 11:06:16 +02:00
codec-mqtt MqttConnectPayload.toString() should use Arrays.toString() instead of [].toString() (#9292) 2019-06-27 21:55:28 +02: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 FIX : Unpacking causes socks5proxy init failure (#9582) 2019-09-20 10:17:13 +02:00
codec-stomp use checkPositive/checkPositiveOrZero (#8835) 2019-02-04 15:55:07 +01:00
codec-xml Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:10:14 +02:00
common Fix event loop shutdown timing fragility (#9639) 2019-10-08 12:00:59 +04:00
dev-tools Update version number to start working on Netty 5 2018-11-20 15:49:57 +01:00
docker Cleanup docker / docker-compose configs (#9473) 2019-08-16 14:00:18 +02:00
example Use allocator when constructing ByteBufHolder sub-types or use Unpool… (#9377) 2019-07-18 10:36:03 +02:00
handler Reference-counted SslEngines retain a reference to their parent SslContext (#9626) 2019-10-07 08:13:05 +02:00
handler-proxy Remove code that accounts for changing EventExecutors in DefaultPromise (#8996) 2019-04-03 10:36:55 +02:00
license Use Table lookup for HPACK decoder (#9307) 2019-07-02 20:13:19 +02:00
microbench Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:10:14 +02:00
resolver Close delegate resolver from RoundRobinInetAddressResolver (#9214) 2019-06-04 05:14:28 -07:00
resolver-dns Make some inner classes static (#9624) 2019-10-07 10:13:48 +04:00
tarball Update version number to start working on Netty 5 2018-11-20 15:49:57 +01:00
testsuite Fix event loop shutdown timing fragility (#9639) 2019-10-08 12:00:59 +04:00
testsuite-autobahn Use allocator when constructing ByteBufHolder sub-types or use Unpool… (#9377) 2019-07-18 10:36:03 +02:00
testsuite-http2 Use allocator when constructing ByteBufHolder sub-types or use Unpool… (#9377) 2019-07-18 10:36:03 +02:00
testsuite-native-image remove unused imports (#9287) 2019-06-26 21:16:16 +02:00
testsuite-osgi Adjust testsuite-osgi to resolve bundles from local build (#8944) 2019-03-18 09:56:08 +01:00
testsuite-shading Allow to build on powerpc 2019-09-13 22:21:36 +02:00
transport Fix event loop shutdown timing fragility (#9639) 2019-10-08 12:00:59 +04:00
transport-native-epoll Fix event loop shutdown timing fragility (#9639) 2019-10-08 12:00:59 +04:00
transport-native-kqueue Fix event loop shutdown timing fragility (#9639) 2019-10-08 12:00:59 +04:00
transport-native-unix-common Enable Netty on a big endian platform 2019-09-27 12:26:31 +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 Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:10:14 +02: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 Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:10:14 +02:00
pom.xml Allow to build on s390_64 2019-09-27 12:26:31 +02:00
README.md Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:10:14 +02: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.