Go to file
Nick Hill 9f2221ebd4 CompositeByteBuf optimizations and new addFlattenedComponents method (#8939)
Motivation:

The CompositeByteBuf discardReadBytes / discardReadComponents methods are currently quite inefficient, including when there are no read components to discard. We would like to call the latter more frequently in ByteToMessageDecoder#COMPOSITE_CUMULATOR.

In the same context it would be beneficial to perform a "shallow copy" of a composite buffer (for example when it has a refcount > 1) to avoid having to allocate and copy the contained bytes just to obtain an "independent" cumulation.

Modifications:

- Optimize discardReadBytes() and discardReadComponents() implementations (start at first comp rather than performing a binary search for the readerIndex).
- New addFlattenedComponents(boolean,ByteBuf) method which performs a shallow copy if the provided buffer is also composite and avoids adding any empty buffers, plus unit test.
- Other minor optimizations to avoid unnecessary checks.

Results:

discardReadXX methods are faster, composite buffers can be easily appended without deepening the buffer "tree" or retaining unused components.
2019-04-08 20:48:08 +02: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 05:43:06 +01:00
all [maven-release-plugin] prepare for next development iteration 2019-03-08 08:55:45 +00:00
bom [maven-release-plugin] prepare for next development iteration 2019-03-08 08:55:45 +00:00
buffer CompositeByteBuf optimizations and new addFlattenedComponents method (#8939) 2019-04-08 20:48:08 +02:00
codec [maven-release-plugin] prepare for next development iteration 2019-03-08 08:55:45 +00:00
codec-dns [maven-release-plugin] prepare for next development iteration 2019-03-08 08:55:45 +00:00
codec-haproxy [maven-release-plugin] prepare for next development iteration 2019-03-08 08:55:45 +00:00
codec-http Add user possibility to skip the evaluation of a certain websocket ex… (#8910) 2019-03-22 14:48:22 +01:00
codec-http2 Upgrade to new netty-build and com.puppycrawl.tools 8.18 (#8980) 2019-03-26 14:21:34 +01:00
codec-memcache [maven-release-plugin] prepare for next development iteration 2019-03-08 08:55:45 +00:00
codec-mqtt [maven-release-plugin] prepare for next development iteration 2019-03-08 08:55:45 +00:00
codec-redis [maven-release-plugin] prepare for next development iteration 2019-03-08 08:55:45 +00:00
codec-smtp [maven-release-plugin] prepare for next development iteration 2019-03-08 08:55:45 +00:00
codec-socks [maven-release-plugin] prepare for next development iteration 2019-03-08 08:55:45 +00:00
codec-stomp [maven-release-plugin] prepare for next development iteration 2019-03-08 08:55:45 +00:00
codec-xml [maven-release-plugin] prepare for next development iteration 2019-03-08 08:55:45 +00:00
common Allow to automatically trim the PoolThreadCache in a timely interval (#8941) 2019-03-22 11:08:37 +01:00
dev-tools [maven-release-plugin] prepare for next development iteration 2019-03-08 08:55:45 +00:00
docker Update to latest openjdk13 EA release (#8990) 2019-03-30 20:29:09 +01:00
example Carefully manage Keep-Alive/Close connection headers in all examples (#8966) 2019-04-02 21:10:11 +02:00
handler Allow to offload / customize key signing operations when using BoringSSL. (#8943) 2019-04-08 20:17:44 +02:00
handler-proxy [maven-release-plugin] prepare for next development iteration 2019-03-08 08:55:45 +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 2019-03-08 08:55:45 +00:00
resolver [maven-release-plugin] prepare for next development iteration 2019-03-08 08:55:45 +00:00
resolver-dns Add unit test for query TXT records. (#8923) 2019-03-09 21:41:28 +01:00
tarball [maven-release-plugin] prepare for next development iteration 2019-03-08 08:55:45 +00:00
testsuite Introduce SingleThreadEventLoop.registeredChannels (#8428) 2019-03-28 11:33:12 +00:00
testsuite-autobahn [maven-release-plugin] prepare for next development iteration 2019-03-08 08:55:45 +00:00
testsuite-http2 [maven-release-plugin] prepare for next development iteration 2019-03-08 08:55:45 +00:00
testsuite-osgi Adjust testsuite-osgi to resolve bundles from local build (#8944) 2019-03-18 09:27:43 +01:00
testsuite-shading [maven-release-plugin] prepare for next development iteration 2019-03-08 08:55:45 +00:00
transport Deprecate ChannelOption.newInstance(...) (#8997) 2019-04-05 12:09:54 +02:00
transport-native-epoll Added UDP multicast (with caveats: no ipv6, getInterface, getNetworkI… (#9006) 2019-04-08 20:13:39 +02:00
transport-native-kqueue Introduce SingleThreadEventLoop.registeredChannels (#8428) 2019-03-28 11:33:12 +00:00
transport-native-unix-common [maven-release-plugin] prepare for next development iteration 2019-03-08 08:55:45 +00:00
transport-native-unix-common-tests [maven-release-plugin] prepare for next development iteration 2019-03-08 08:55:45 +00:00
transport-rxtx [maven-release-plugin] prepare for next development iteration 2019-03-08 08:55:45 +00:00
transport-sctp [maven-release-plugin] prepare for next development iteration 2019-03-08 08:55:45 +00:00
transport-udt [maven-release-plugin] prepare for next development iteration 2019-03-08 08:55: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 .gitignore for docker-sync stuff 2019-03-19 14:03:15 +01: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
NOTICE.txt Add the NOTICE of the forked portion of Apache Harmony 2018-01-30 11:22:51 +01:00
README.md Provide an Automatic-Module-Name for the netty-all artifact fixes #7644 2018-01-27 20:31:16 +01: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
pom.xml Revert back to depend on netty-tcnative 2019-04-08 20:27:05 +02:00
run-example.sh Add UptimeServer and adjust UptimeClient's code style. 2017-04-28 07:41:07 +02:00

README.md

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.