Go to file
Jason 9dd5c928f3 Add java-doc for implemented methods of io.netty.util.concurrent.Future#cancel(boolean mayInterruptIfRunning)
Motivation:

The methods implement io.netty.util.concurrent.Future#cancel(boolean mayInterruptIfRunning) which actually ignored the param mayInterruptIfRunning.We need to add comments for the `mayInterruptIfRunning` param.

Modifications:

Add comments for the `mayInterruptIfRunning` param.

Result:

People who call the `cancel` method will be more clear about the effect of `mayInterruptIfRunning` param.
2018-01-29 11:19:52 +01: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 Provide an Automatic-Module-Name for the netty-all artifact fixes #7644 2018-01-27 20:31:16 +01:00
bom [maven-release-plugin] prepare for next development iteration 2018-01-21 12:53:51 +00:00
buffer HttpResponseStatus object allocation reduction 2018-01-24 22:01:52 -08:00
codec Use FastThreadLocal for CodecOutputList 2018-01-23 11:34:28 +01:00
codec-dns [maven-release-plugin] prepare for next development iteration 2018-01-21 12:53:51 +00:00
codec-haproxy [maven-release-plugin] prepare for next development iteration 2018-01-21 12:53:51 +00:00
codec-http Fix HttpPostMultipartRequestDecoder.splitMultipartHeader() String index out of range: -1 with empty header 2018-01-25 14:03:35 +01:00
codec-http2 ReadOnlyHttp2Headers.contains always ignores case for values 2018-01-27 20:29:40 +01:00
codec-memcache [maven-release-plugin] prepare for next development iteration 2018-01-21 12:53:51 +00:00
codec-mqtt [maven-release-plugin] prepare for next development iteration 2018-01-21 12:53:51 +00:00
codec-redis [maven-release-plugin] prepare for next development iteration 2018-01-21 12:53:51 +00:00
codec-smtp [maven-release-plugin] prepare for next development iteration 2018-01-21 12:53:51 +00:00
codec-socks [maven-release-plugin] prepare for next development iteration 2018-01-21 12:53:51 +00:00
codec-stomp Fix StompFrame.copy() does not copy headers 2018-01-26 08:30:12 +01:00
codec-xml [maven-release-plugin] prepare for next development iteration 2018-01-21 12:53:51 +00:00
common Add java-doc for implemented methods of io.netty.util.concurrent.Future#cancel(boolean mayInterruptIfRunning) 2018-01-29 11:19:52 +01:00
dev-tools [maven-release-plugin] prepare for next development iteration 2018-01-21 12:53:51 +00:00
docker Provide a Docker image for reproducible builds 2018-01-22 20:02:17 +01:00
example [maven-release-plugin] prepare for next development iteration 2018-01-21 12:53:51 +00:00
handler [maven-release-plugin] prepare for next development iteration 2018-01-21 12:53:51 +00:00
handler-proxy [maven-release-plugin] prepare for next development iteration 2018-01-21 12:53:51 +00:00
license Include mvn wrapper to make setup of development env easier 2018-01-26 08:13:17 +01:00
microbench Use FastThreadLocal for CodecOutputList 2018-01-23 11:34:28 +01:00
resolver [maven-release-plugin] prepare for next development iteration 2018-01-21 12:53:51 +00:00
resolver-dns Fix race-condition when using DnsCache in DnsNameResolver 2018-01-23 08:04:33 +01:00
tarball [maven-release-plugin] prepare for next development iteration 2018-01-21 12:53:51 +00:00
testsuite [maven-release-plugin] prepare for next development iteration 2018-01-21 12:53:51 +00:00
testsuite-autobahn [maven-release-plugin] prepare for next development iteration 2018-01-21 12:53:51 +00:00
testsuite-http2 [maven-release-plugin] prepare for next development iteration 2018-01-21 12:53:51 +00:00
testsuite-osgi [maven-release-plugin] prepare for next development iteration 2018-01-21 12:53:51 +00:00
transport Add java-doc for implemented methods of io.netty.util.concurrent.Future#cancel(boolean mayInterruptIfRunning) 2018-01-29 11:19:52 +01:00
transport-native-epoll [maven-release-plugin] prepare for next development iteration 2018-01-21 12:53:51 +00:00
transport-native-kqueue [maven-release-plugin] prepare for next development iteration 2018-01-21 12:53:51 +00:00
transport-native-unix-common [maven-release-plugin] prepare for next development iteration 2018-01-21 12:53:51 +00:00
transport-native-unix-common-tests [maven-release-plugin] prepare for next development iteration 2018-01-21 12:53:51 +00:00
transport-rxtx [maven-release-plugin] prepare for next development iteration 2018-01-21 12:53:51 +00:00
transport-sctp [maven-release-plugin] prepare for next development iteration 2018-01-21 12:53:51 +00:00
transport-udt [maven-release-plugin] prepare for next development iteration 2018-01-21 12:53:51 +00:00
.fbprefs
.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
CONTRIBUTING.md
LICENSE.txt
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 Include mvn wrapper to make setup of development env easier 2018-01-26 08:13:17 +01:00
pom.xml Replace reflective access of Throwable#addSuppressed with version guarded access 2018-01-25 19:56:17 +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.