Go to file
Nick Hill 170e4deee6 Fix event loop shutdown timing fragility (#9616)
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
2019-10-07 11:06:01 +04:00
.github Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:09:42 +02:00
.mvn support publishing snapshots from docker based ci (#8634) 2018-12-07 05:43:06 +01:00
all [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +00:00
bom [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +00:00
buffer [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +00:00
codec [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +00:00
codec-dns [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +00:00
codec-haproxy [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +00:00
codec-http [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +00:00
codec-http2 Add io.netty.handler.codec.http2.Http2ConnectionHandler for runtime GraalVM compilation (#9621) 2019-10-07 09:03:07 +02:00
codec-memcache [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +00:00
codec-mqtt [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +00:00
codec-redis [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +00:00
codec-smtp [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +00:00
codec-socks [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +00:00
codec-stomp [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +00:00
codec-xml [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +00:00
common Fix event loop shutdown timing fragility (#9616) 2019-10-07 11:06:01 +04:00
dev-tools [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +00:00
docker Cleanup docker / docker-compose configs (#9473) 2019-08-16 13:59:36 +02:00
example [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +00:00
handler Reference-counted SslEngines retain a reference to their parent SslContext (#9626) 2019-10-07 10:12:54 +04:00
handler-proxy [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +00:00
license Use Table lookup for HPACK decoder (#9307) 2019-07-02 20:09:44 +02:00
microbench [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +00:00
resolver [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +00:00
resolver-dns Make some inner classes static (#9624) 2019-10-07 08:14:02 +02:00
tarball [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +00:00
testsuite Fix event loop shutdown timing fragility (#9616) 2019-10-07 11:06:01 +04:00
testsuite-autobahn [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +00:00
testsuite-http2 [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +00:00
testsuite-native-image [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +00:00
testsuite-osgi [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +00:00
testsuite-shading [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +00:00
transport Fix event loop shutdown timing fragility (#9616) 2019-10-07 11:06:01 +04:00
transport-native-epoll Fix event loop shutdown timing fragility (#9616) 2019-10-07 11:06:01 +04:00
transport-native-kqueue Fix event loop shutdown timing fragility (#9616) 2019-10-07 11:06:01 +04:00
transport-native-unix-common Enable Netty on a big endian platform 2019-09-27 12:27:37 +02:00
transport-native-unix-common-tests [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +00:00
transport-rxtx [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +00:00
transport-sctp [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +00:00
transport-udt [maven-release-plugin] prepare for next development iteration 2019-09-25 06:15:31 +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 Add .gitignore for docker-sync stuff 2019-03-19 14:03:15 +01:00
CONTRIBUTING.md Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:09:42 +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:09:42 +02:00
pom.xml Allow to build on s390_64 2019-09-27 12:27:45 +02:00
README.md Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:09:42 +02:00
run-example.sh Add UptimeServer and adjust UptimeClient's code style. 2017-04-28 07:41:07 +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.