Go to file
unknown cb420a9ffc Including the setup code in the benchmark method to avoid JMH Invocation level hiccups.
Motivation:

The usage of Invocation level for JMH fixture methods (setup/teardown) inccurs in a significant impact in
in the benchmark time (see org.openjdk.jmh.annotations.Level documentation).

When the benchmark and the setup/teardown is too small (less than a milisecond) the Invocation level might saturate the system with
timestamp requests and iteration synchronizations which introduce artificial latency, throughput, and scalability bottlenecks.

In the HeadersBenchmark, all benchmarks take less than 100ns and the Invocation level setup offsets the measurement considerably.
As fixture methods is defined for the entire class, this overhead also impacts every single benchmark in this class, not only
the ones that use the emptyHttpHeaders object (cleaned in the setup).

The recommended fix patch here is to include the setup/teardown code in the benchmark where the object is used.

Modifications:

Include the setup/teardown code in the relevant benchmark methods.
Remove the setup/teardown method of Invocation level from the benchmark class.

Result:

We run all benchmarks from HeadersBenchmark 10 times with default parameter, we observe:
- Benchmarks that were not directly affected by the fix patch, improved execution time.
    For instance, http2Remove with (exampleHeader = THREE) had its median reported as 2x faster than the original version.
- Benchmarks that had the setup code inserted (eg. http2AddAllFastest) did not suffer a significant punch in the execution time,
as the benchmarks are not dominated by the clear().

Environment:
Tests run on a Computational server with CPU: E5-1660-3.3GHZ  (6 cores + HT), 64 GB RAM.
2018-06-21 12:21:19 +02: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-05-14 11:11:45 +00:00
bom [maven-release-plugin] prepare for next development iteration 2018-05-14 11:11:45 +00:00
buffer Reduce array allocations during CompositeByteBuf construction 2018-06-20 16:09:23 +02:00
codec Fix CharSequenceValueConverter.convertToByte implementation for AsciiString (#7994) 2018-06-01 21:15:08 +02:00
codec-dns [maven-release-plugin] prepare for next development iteration 2018-05-14 11:11:45 +00:00
codec-haproxy [maven-release-plugin] prepare for next development iteration 2018-05-14 11:11:45 +00:00
codec-http Print correct invalid character after unwrapping value in CookieEncoder 2018-06-21 08:19:01 +02:00
codec-http2 Don't fail the deregistration promise in Http2MultiplexCodec 2018-06-21 10:20:54 +02:00
codec-memcache [maven-release-plugin] prepare for next development iteration 2018-05-14 11:11:45 +00:00
codec-mqtt [maven-release-plugin] prepare for next development iteration 2018-05-14 11:11:45 +00:00
codec-redis [maven-release-plugin] prepare for next development iteration 2018-05-14 11:11:45 +00:00
codec-smtp [maven-release-plugin] prepare for next development iteration 2018-05-14 11:11:45 +00:00
codec-socks [maven-release-plugin] prepare for next development iteration 2018-05-14 11:11:45 +00:00
codec-stomp [maven-release-plugin] prepare for next development iteration 2018-05-14 11:11:45 +00:00
codec-xml [maven-release-plugin] prepare for next development iteration 2018-05-14 11:11:45 +00:00
common Check if Log level is enabled before creating log statements (#8022) 2018-06-13 23:21:53 -07:00
dev-tools [maven-release-plugin] prepare for next development iteration 2018-05-14 11:11:45 +00:00
docker Use java 11+ea18 (#8034) 2018-06-18 20:31:15 +02:00
example We should re-use the same handler instance as its sharable in the example 2018-05-30 09:09:18 +02:00
handler Remove some cipher protocol combos for tests due removal in more recent versions of OpenSSL (#8033) 2018-06-19 08:12:02 +02:00
handler-proxy [maven-release-plugin] prepare for next development iteration 2018-05-14 11:11:45 +00:00
license Add the NOTICE of the forked portion of Apache Harmony 2018-01-30 11:22:51 +01:00
microbench Including the setup code in the benchmark method to avoid JMH Invocation level hiccups. 2018-06-21 12:21:19 +02:00
resolver Check if Log level is enabled before creating log statements (#8022) 2018-06-13 23:21:53 -07:00
resolver-dns [maven-release-plugin] prepare for next development iteration 2018-05-14 11:11:45 +00:00
tarball [maven-release-plugin] prepare for next development iteration 2018-05-14 11:11:45 +00:00
testsuite Revert "Ignore some test-flakiness when using Java11+ due outstanding Java11 bug. (#7984)" (#8035) 2018-06-19 08:11:10 +02:00
testsuite-autobahn [maven-release-plugin] prepare for next development iteration 2018-05-14 11:11:45 +00:00
testsuite-http2 [maven-release-plugin] prepare for next development iteration 2018-05-14 11:11:45 +00:00
testsuite-osgi [maven-release-plugin] prepare for next development iteration 2018-05-14 11:11:45 +00:00
transport fix grammar in javadoc 2018-06-20 10:45:49 +02:00
transport-native-epoll Epoll and Kqueue shouldn't read by default (#8024) 2018-06-15 10:28:50 +02:00
transport-native-kqueue Epoll and Kqueue shouldn't read by default (#8024) 2018-06-15 10:28:50 +02:00
transport-native-unix-common [maven-release-plugin] prepare for next development iteration 2018-05-14 11:11:45 +00:00
transport-native-unix-common-tests Read until all data is consumed when EOF is detected even if readPend… (#7961) 2018-05-24 20:29:29 +02:00
transport-rxtx [maven-release-plugin] prepare for next development iteration 2018-05-14 11:11:45 +00:00
transport-sctp Check if Log level is enabled before creating log statements (#8022) 2018-06-13 23:21:53 -07:00
transport-udt [maven-release-plugin] prepare for next development iteration 2018-05-14 11:11:45 +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 docker-sync files to .gitignore 2018-05-15 10:39:14 +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 to netty-tcnative 2.0.10.Final as 2.0.9.Final did not contain all native libs for boringssl. (#8031) 2018-06-17 10:55:43 +02: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.