Go to file
Norman Maurer c10ccc5dec
Tighten contract between Channel and EventLoop by require the EventLoop on Channel construction. (#8587)
Motivation:

At the moment it’s possible to have a Channel in Netty that is not registered / assigned to an EventLoop until register(...) is called. This is suboptimal as if the Channel is not registered it is also not possible to do anything useful with a ChannelFuture that belongs to the Channel. We should think about if we should have the EventLoop as a constructor argument of a Channel and have the register / deregister method only have the effect of add a Channel to KQueue/Epoll/... It is also currently possible to deregister a Channel from one EventLoop and register it with another EventLoop. This operation defeats the threading model assumptions that are wide spread in Netty, and requires careful user level coordination to pull off without any concurrency issues. It is not a commonly used feature in practice, may be better handled by other means (e.g. client side load balancing), and therefore we propose removing this feature.

Modifications:

- Change all Channel implementations to require an EventLoop for construction ( + an EventLoopGroup for all ServerChannel implementations)
- Remove all register(...) methods from EventLoopGroup
- Add ChannelOutboundInvoker.register(...) which now basically means we want to register on the EventLoop for IO.
- Change ChannelUnsafe.register(...) to not take an EventLoop as parameter (as the EventLoop is supplied on custruction).
- Change ChannelFactory to take an EventLoop to create new Channels and introduce ServerChannelFactory which takes an EventLoop and one EventLoopGroup to create new ServerChannel instances.
- Add ServerChannel.childEventLoopGroup()
- Ensure all operations on the accepted Channel is done in the EventLoop of the Channel in ServerBootstrap
- Change unit tests for new behaviour

Result:

A Channel always has an EventLoop assigned which will never change during its life-time. This ensures we are always be able to call any operation on the Channel once constructed (unit the EventLoop is shutdown). This also simplifies the logic in DefaultChannelPipeline a lot as we can always call handlerAdded / handlerRemoved directly without the need to wait for register() to happen.

Also note that its still possible to deregister a Channel and register it again. It's just not possible anymore to move from one EventLoop to another (which was not really safe anyway).

Fixes https://github.com/netty/netty/issues/8513.
2019-01-14 20:11:13 +01:00
.github Use GitHub Issue/PR Template Feature 2016-12-07 11:40:26 -08:00
.mvn support publishing snapshots from docker based ci (#8634) 2018-12-07 06:16:39 +01:00
all Remove OIO transport (and transports that depend on it). (#8580) 2018-11-21 15:23:18 +01:00
bom Remove OIO transport (and transports that depend on it). (#8580) 2018-11-21 15:23:18 +01:00
buffer Updating ByteBuf Javadocs to represent actual behaviour. (#8709) 2019-01-14 20:09:18 +01:00
codec Fix minor spelling issues in javadocs (#8701) 2019-01-14 07:25:13 +01:00
codec-dns Correcting Maven Dependencies (#8622) 2018-12-06 09:02:00 +01:00
codec-haproxy Correcting Maven Dependencies (#8622) 2018-12-06 09:02:00 +01:00
codec-http Tighten contract between Channel and EventLoop by require the EventLoop on Channel construction. (#8587) 2019-01-14 20:11:13 +01:00
codec-http2 Tighten contract between Channel and EventLoop by require the EventLoop on Channel construction. (#8587) 2019-01-14 20:11:13 +01:00
codec-memcache Correcting Maven Dependencies (#8622) 2018-12-06 09:02:00 +01:00
codec-mqtt Correcting Maven Dependencies (#8622) 2018-12-06 09:02:00 +01:00
codec-redis Correcting Maven Dependencies (#8622) 2018-12-06 09:02:00 +01:00
codec-smtp Correcting Maven Dependencies (#8622) 2018-12-06 09:02:00 +01:00
codec-socks Remove support for marking reader and writerIndex in ByteBuf to reduce overhead and complexity. (#8636) 2018-12-11 14:00:49 +01:00
codec-stomp Remove support for marking reader and writerIndex in ByteBuf to reduce overhead and complexity. (#8636) 2018-12-11 14:00:49 +01:00
codec-xml Correcting Maven Dependencies (#8622) 2018-12-06 09:02:00 +01:00
common Fix minor spelling issues in javadocs (#8701) 2019-01-14 07:25:13 +01:00
dev-tools Update version number to start working on Netty 5 2018-11-20 15:49:57 +01:00
docker Use OpenJDK 12 EA 27 when running CI jobs for JDK 12. (#8715) 2019-01-14 13:36:03 +01:00
example Remove support for marking reader and writerIndex in ByteBuf to reduce overhead and complexity. (#8636) 2018-12-11 14:00:49 +01:00
handler Tighten contract between Channel and EventLoop by require the EventLoop on Channel construction. (#8587) 2019-01-14 20:11:13 +01:00
handler-proxy Correcting Maven Dependencies (#8622) 2018-12-06 09:02:00 +01:00
license Add the NOTICE of the forked portion of Apache Harmony 2018-01-30 11:22:51 +01:00
microbench Tighten contract between Channel and EventLoop by require the EventLoop on Channel construction. (#8587) 2019-01-14 20:11:13 +01:00
resolver Adding support for whitespace in resource path in tests (#8606) 2018-12-12 10:29:19 +01:00
resolver-dns Tighten contract between Channel and EventLoop by require the EventLoop on Channel construction. (#8587) 2019-01-14 20:11:13 +01:00
tarball Update version number to start working on Netty 5 2018-11-20 15:49:57 +01:00
testsuite Tighten contract between Channel and EventLoop by require the EventLoop on Channel construction. (#8587) 2019-01-14 20:11:13 +01:00
testsuite-autobahn Upgrade to new version of autobahntestsuite maven plugin. (#8668) 2018-12-17 17:26:00 +01:00
testsuite-http2 Correcting Maven Dependencies (#8622) 2018-12-06 09:02:00 +01:00
testsuite-osgi Update to OpenJDK 12 ea22 (#8618) 2018-12-04 11:59:23 +01:00
testsuite-shading Update version number to start working on Netty 5 2018-11-20 15:49:57 +01:00
transport Tighten contract between Channel and EventLoop by require the EventLoop on Channel construction. (#8587) 2019-01-14 20:11:13 +01:00
transport-native-epoll Tighten contract between Channel and EventLoop by require the EventLoop on Channel construction. (#8587) 2019-01-14 20:11:13 +01:00
transport-native-kqueue Tighten contract between Channel and EventLoop by require the EventLoop on Channel construction. (#8587) 2019-01-14 20:11:13 +01:00
transport-native-unix-common Fix minor spelling issues in javadocs (#8701) 2019-01-14 07:25:13 +01:00
transport-native-unix-common-tests Correcting Maven Dependencies (#8622) 2018-12-06 09:02:00 +01:00
transport-sctp Tighten contract between Channel and EventLoop by require the EventLoop on Channel construction. (#8587) 2019-01-14 20:11:13 +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 Exclude mainframer related files from git 2018-10-14 13:20:18 +02: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 to OpenJDK 12 ea22 (#8618) 2018-12-04 11:59:23 +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.