Go to file
Scott Mitchell d2d3e6ef0c
KQueue write filter initial state (#7738)
Motivation:
KQueue implementations current have inconsistent behavior with Epoll implementations with respect to asynchronous sockets and connecting. In the Epoll transport we attempt to connect, if the connect call does not synchornously fail/succeed we set the EPOLLOUT which will be triggered by the kernel if the connection attempt succeeds or an error occurs. The connect API provides no way to asynchronously communicate an error so the Epoll implementation fires a EPOLLOUT event and puts the connect status in getsockopt(SO_ERROR). KQueue provides the same APIs but different behavior. If the EVFILT_WRITE is not enabled and the EVFILT_READ is enabled before connect is called, and there is an error the kernel may fire the EVFILT_READ filter and provide the Connection Refused error via read(). This is even true if we set the EVFILT_WRITE filter after calling connect because connect didn't synchornously complete. After the error has been delievered via read() a call to getsockopt(SO_ERROR) will return 0 indicating there is no error. This means we cannot rely upon the KQueue based kernel to deliver connection errors via the EVFILT_WRITE filter in the same way that the linux kernel does with the EPOLLOUT flag.
ce241bd introduced a change which depends upon the behavior of the EVFILT_WRITE being set and may prematurely stop writing to the OS as a result, becaues we assume the OS will notify us when the socket is writable. However the current work around for the above described behavior is to initialize the EVFILT_WRITE to true for connection oriented protocols. This leads to prematurely exiting from the flush() which may lead to deadlock.

Modifications:
- KQueue should check when an error is obtained from read() if the connectPromise has not yet been completed, and if not complete it with a ConnectException

Result:
No more deadlock in KQueue due to asynchronous connect workaround.
2018-02-20 11:01:49 -08:00
.github Use GitHub Issue/PR Template Feature 2016-12-07 11:40:26 -08:00
.mvn/wrapper Include mvn wrapper to make setup of development env easier 2018-01-26 08:13:17 +01:00
all [maven-release-plugin] prepare for next development iteration 2018-02-05 12:02:35 +00:00
bom [maven-release-plugin] prepare for next development iteration 2018-02-05 12:02:35 +00:00
buffer Added exact utf8 length estimator and exposed writeUtf8 with custom space reservation on destination buffer 2018-02-16 11:52:35 +01:00
codec Fix Snappy decoding of large 2-byte literal lengths and copy offsets 2018-02-20 11:42:23 +01:00
codec-dns [maven-release-plugin] prepare for next development iteration 2018-02-05 12:02:35 +00:00
codec-haproxy Fix typos in docs. 2018-02-14 08:44:07 +01:00
codec-http Fix typos in docs. 2018-02-14 08:44:07 +01:00
codec-http2 Fix typos in docs. 2018-02-14 08:44:07 +01:00
codec-memcache [maven-release-plugin] prepare for next development iteration 2018-02-05 12:02:35 +00:00
codec-mqtt [maven-release-plugin] prepare for next development iteration 2018-02-05 12:02:35 +00:00
codec-redis [maven-release-plugin] prepare for next development iteration 2018-02-05 12:02:35 +00:00
codec-smtp [maven-release-plugin] prepare for next development iteration 2018-02-05 12:02:35 +00:00
codec-socks [maven-release-plugin] prepare for next development iteration 2018-02-05 12:02:35 +00:00
codec-stomp [maven-release-plugin] prepare for next development iteration 2018-02-05 12:02:35 +00:00
codec-xml [maven-release-plugin] prepare for next development iteration 2018-02-05 12:02:35 +00:00
common Propagate full Unsafe unavailability reason in PlatformDependent 2018-02-16 10:43:06 -08:00
dev-tools [maven-release-plugin] prepare for next development iteration 2018-02-05 12:02:35 +00:00
docker Provide a Docker image for reproducible builds 2018-01-22 20:02:17 +01:00
example Use long for http2 ping payload. 2018-02-08 10:23:34 +01:00
handler SSL connection not closed properly after handshake failure 2018-02-16 08:25:47 -08:00
handler-proxy [maven-release-plugin] prepare for next development iteration 2018-02-05 12:02:35 +00:00
license Add the NOTICE of the forked portion of Apache Harmony 2018-01-30 11:22:51 +01:00
microbench [maven-release-plugin] prepare for next development iteration 2018-02-05 12:02:35 +00:00
resolver [maven-release-plugin] prepare for next development iteration 2018-02-05 12:02:35 +00:00
resolver-dns Ensure we always release the AddressEnvelope when doing DNS queries. 2018-02-20 12:06:21 +01:00
tarball [maven-release-plugin] prepare for next development iteration 2018-02-05 12:02:35 +00:00
testsuite Epoll flush/writabilityChange deadlock 2018-02-20 11:40:58 +01:00
testsuite-autobahn [maven-release-plugin] prepare for next development iteration 2018-02-05 12:02:35 +00:00
testsuite-http2 Use long for http2 ping payload. 2018-02-08 10:23:34 +01:00
testsuite-osgi [maven-release-plugin] prepare for next development iteration 2018-02-05 12:02:35 +00:00
transport Epoll flush/writabilityChange deadlock 2018-02-20 11:40:58 +01:00
transport-native-epoll Epoll flush/writabilityChange deadlock 2018-02-20 11:40:58 +01:00
transport-native-kqueue KQueue write filter initial state (#7738) 2018-02-20 11:01:49 -08:00
transport-native-unix-common [maven-release-plugin] prepare for next development iteration 2018-02-05 12:02:35 +00:00
transport-native-unix-common-tests [maven-release-plugin] prepare for next development iteration 2018-02-05 12:02:35 +00:00
transport-rxtx [maven-release-plugin] prepare for next development iteration 2018-02-05 12:02:35 +00:00
transport-sctp [maven-release-plugin] prepare for next development iteration 2018-02-05 12:02:35 +00:00
transport-udt [maven-release-plugin] prepare for next development iteration 2018-02-05 12:02:35 +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 Use shaded dependency on JCTools instead of copy and paste 2016-06-10 13:19:45 +02:00
.travis.yml Travis CI branch whitelisting 2013-03-11 09:55:43 +09: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 Update jetty-alpn-agent for latest java8 release. 2018-02-16 09:18:22 +01: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 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.