Go to file
Ameya Lokare e55e3a59f9 Add constants for fixed-header only MQTT messages (#9749)
Motivation:

Currently, the only way to create fixed-header only messages PINGREQ,
PINGRESP and DISCONNECT is to explicitly instantiate a `MqttFixedHeader` like:
```
MqttFixedHeader disconnectFixedHeader = new MqttFixedHeader(MqttMessageType.DISCONNECT,
    false, MqttQoS.AT_MOST_ONCE, false, 0);
MqttMessage disconnectMessage = new MqttMessage(disconnectFixedHeader);
```

According to the MQTT spec
(http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718077),
the fixed-header flags for these messages are reserved and  must be set to zero, otherwise
the receiver must close the connection. It's easy to mess this up when
you're creating the header explicitly, for e.g by setting the QoS bit to
`AT_LEAST_ONCE`.

As such, provide static constants for PINGREQ, PINGRESP and
DISCONNECT messages that will set the flags correctly for the developer.

Modification:

Add static constants to MqttMessage class to construct PINGREQ, PINGRESP and
DISCONNECT messages that will set the fixed-header flags correctly to 0.

Result:

Easier usage.
2019-11-08 10:17:01 +01:00
.github Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:09:42 +02:00
.mvn support publishing snapshots from docker based ci (#8634) 2018-12-07 05:43:06 +01:00
all Introduce MacOSDnsServerAddressStreamProvider which correctly detect all nameserver configuration on MacOS (#9161) 2019-10-28 15:02:45 +01:00
bom [maven-release-plugin] prepare for next development iteration 2019-10-24 12:57:00 +00:00
buffer Introduce ByteBuf#isContiguous() method (#9735) 2019-11-06 12:06:25 +01:00
codec Clean up expired docs. (#9756) 2019-11-06 09:43:25 +01:00
codec-dns [maven-release-plugin] prepare for next development iteration 2019-10-24 12:57:00 +00:00
codec-haproxy [maven-release-plugin] prepare for next development iteration 2019-10-24 12:57:00 +00:00
codec-http Simplify WebSocket handlers constructor arguments hell #9698 (#9699) 2019-10-29 20:48:18 +01:00
codec-http2 Add test to check Connection-Specific headers are removed in HTTP/2 (by HttpConversionUtil.toHttp2Headers) (#9766) 2019-11-08 10:14:26 +01:00
codec-memcache [maven-release-plugin] prepare for next development iteration 2019-10-24 12:57:00 +00:00
codec-mqtt Add constants for fixed-header only MQTT messages (#9749) 2019-11-08 10:17:01 +01:00
codec-redis [maven-release-plugin] prepare for next development iteration 2019-10-24 12:57:00 +00:00
codec-smtp [maven-release-plugin] prepare for next development iteration 2019-10-24 12:57:00 +00:00
codec-socks [maven-release-plugin] prepare for next development iteration 2019-10-24 12:57:00 +00:00
codec-stomp Fix encoding/decoding for UTF-8 stomp commands and headers (#9740) 2019-11-06 12:07:38 +01:00
codec-xml [maven-release-plugin] prepare for next development iteration 2019-10-24 12:57:00 +00:00
common Cleanup Recycler to better encapsulate stuff (#9739) 2019-11-04 17:43:53 +01:00
dev-tools [maven-release-plugin] prepare for next development iteration 2019-10-24 12:57:00 +00:00
docker Upgrade various JDK flavors / version in our docker-compose files (#9737) 2019-10-31 12:16:24 +01:00
example Fix websocket examples (#9757) 2019-11-06 09:44:29 +01:00
handler Don't cache key material if sun.security.ssl.X509KeyManagerImpl is used (#9762) 2019-11-07 15:12:34 +01:00
handler-proxy [maven-release-plugin] prepare for next development iteration 2019-10-24 12:57:00 +00:00
license Introduce MacOSDnsServerAddressStreamProvider which correctly detect all nameserver configuration on MacOS (#9161) 2019-10-28 15:02:45 +01:00
microbench Avoid extra Runnable allocs when scheduling tasks outside event loop (#9744) 2019-11-04 11:57:53 +01:00
resolver [maven-release-plugin] prepare for next development iteration 2019-10-24 12:57:00 +00:00
resolver-dns [maven-release-plugin] prepare for next development iteration 2019-10-24 12:57:00 +00:00
resolver-dns-native-macos Fix version for resolver-dns-native-macos introduced by 939e928312 2019-10-28 15:09:30 +01:00
tarball Introduce MacOSDnsServerAddressStreamProvider which correctly detect all nameserver configuration on MacOS (#9161) 2019-10-28 15:02:45 +01:00
testsuite [maven-release-plugin] prepare for next development iteration 2019-10-24 12:57:00 +00:00
testsuite-autobahn [maven-release-plugin] prepare for next development iteration 2019-10-24 12:57:00 +00:00
testsuite-http2 Validate pseudo and conditional HTTP/2 headers (#8619) 2019-10-27 16:13:01 +01:00
testsuite-native-image [maven-release-plugin] prepare for next development iteration 2019-10-24 12:57:00 +00:00
testsuite-osgi [maven-release-plugin] prepare for next development iteration 2019-10-24 12:57:00 +00:00
testsuite-shading [maven-release-plugin] prepare for next development iteration 2019-10-24 12:57:00 +00:00
transport Prevent memory leak when SimpleChannelPools are destroyed (#9760) 2019-11-07 14:48:56 +01:00
transport-blockhound-tests Test that NettyBlockHoundIntegration can be loaded with ServiceLoader (#9743) 2019-11-01 07:07:33 +01:00
transport-native-epoll [maven-release-plugin] prepare for next development iteration 2019-10-24 12:57:00 +00:00
transport-native-kqueue [maven-release-plugin] prepare for next development iteration 2019-10-24 12:57:00 +00:00
transport-native-unix-common Introduce MacOSDnsServerAddressStreamProvider which correctly detect all nameserver configuration on MacOS (#9161) 2019-10-28 15:02:45 +01:00
transport-native-unix-common-tests [maven-release-plugin] prepare for next development iteration 2019-10-24 12:57:00 +00:00
transport-rxtx [maven-release-plugin] prepare for next development iteration 2019-10-24 12:57:00 +00:00
transport-sctp [maven-release-plugin] prepare for next development iteration 2019-10-24 12:57:00 +00:00
transport-udt [maven-release-plugin] prepare for next development iteration 2019-10-24 12:57:00 +00:00
.fbprefs
.gitattributes Include mvn wrapper to make setup of development env easier 2018-01-26 08:13:17 +01:00
.gitignore Add vscode specific files / directory to .gitignore (#9652) 2019-10-10 09:35:08 +04:00
CONTRIBUTING.md Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:09:42 +02:00
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 Introduce MacOSDnsServerAddressStreamProvider which correctly detect all nameserver configuration on MacOS (#9161) 2019-10-28 15:02:45 +01:00
pom.xml Update to latest netty-tcnative release (#9763) 2019-11-07 20:30:33 +01:00
README.md Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:09:42 +02: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.