Go to file
Sergey Skrobotov f10bee9057 Change DefaultByteBufHolder.equals() to treat instances of different classes as not equal (#9855)
# Motivation:
`DefaultByteBufHolder.equals()` considers another object equal if it's an instance of `ByteBufferHolder` and if the contents of two objects are equal. However, the behavior of `equals` method is not a part of the `ByteBufHolder` contract so `DefaultByteBufHolder`'s version may be causing violation of the symmetric property if other classes have different logic.
There are already a few classes that are affected by this: `DefaultHttp2GoAwayFrame`, `DefaultHttp2UnknownFrame`, and `SctpMessage` are all overriding `equals` method breaking the symmetric property.
Another effect of this behavior is that all instances with empty data are considered equal. That may not be desireable in the situations when instances are created for predefined constants, e.g. `FullBulkStringRedisMessage.NULL_INSTANCE` and `FullBulkStringRedisMessage.EMPTY_INSTANCE` in `codec-redis`. 

# Modification:
Make `DefaultByteBufHolder.equals()` implementation only work for the objects of the same class.

# Result:
- The symmetric property of the `equals` method is restored for the classes in question.
- Instances of different classes are not considered equal even if the content of the data they hold are the same.
2019-12-10 11:30:23 +01:00
.github Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:10:14 +02:00
.mvn Use latest maven release (#9820) 2019-11-27 14:45:48 +01:00
all Introduce MacOSDnsServerAddressStreamProvider which correctly detect all nameserver configuration on MacOS (#9161) 2019-10-28 15:03:40 +01:00
bom Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:10:14 +02:00
buffer Change DefaultByteBufHolder.equals() to treat instances of different classes as not equal (#9855) 2019-12-10 11:30:23 +01:00
codec SnappyFrameDecoderTest ByteBuf leak (#9854) 2019-12-08 07:38:53 +01:00
codec-dns Detect truncated responses caused by EDNS0 and MTU miss-match (#9468) 2019-08-17 09:58:40 +02:00
codec-haproxy Fix typos in javadocs (#9527) 2019-10-09 15:25:41 +02:00
codec-http Replace ObjectUtil.checkNonNull(...) with Objects.requireNonNull(...) (#9864) 2019-12-10 11:27:32 +01:00
codec-http2 Change DefaultByteBufHolder.equals() to treat instances of different classes as not equal (#9855) 2019-12-10 11:30:23 +01:00
codec-memcache codec-memcache: copy metadata in binary full request response (#9160) 2019-05-22 11:06:16 +02:00
codec-mqtt Add constants for fixed-header only MQTT messages (#9749) 2019-11-08 10:17:16 +01:00
codec-redis Change DefaultByteBufHolder.equals() to treat instances of different classes as not equal (#9855) 2019-12-10 11:30:23 +01:00
codec-smtp SmtpRequestEncoderTest ByteBuf leak (#9075) 2019-04-19 08:47:28 +02:00
codec-socks FIX : Unpacking causes socks5proxy init failure (#9582) 2019-09-20 10:17:13 +02:00
codec-stomp Replace ObjectUtil.checkNonNull(...) with Objects.requireNonNull(...) (#9864) 2019-12-10 11:27:32 +01:00
codec-xml Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:10:14 +02:00
common Replace ObjectUtil.checkNonNull(...) with Objects.requireNonNull(...) (#9864) 2019-12-10 11:27:32 +01:00
dev-tools Update version number to start working on Netty 5 2018-11-20 15:49:57 +01:00
docker Upgrade various JDK flavors / version in our docker-compose files (#9737) 2019-10-31 12:16:50 +01:00
example Rename SimpleChannelInboundHandler.channelRead0() to messageReceived() (#8819) 2019-11-01 07:23:07 +01:00
handler Replace ObjectUtil.checkNonNull(...) with Objects.requireNonNull(...) (#9864) 2019-12-10 11:27:32 +01:00
handler-proxy Rename SimpleChannelInboundHandler.channelRead0() to messageReceived() (#8819) 2019-11-01 07:23:07 +01:00
license Introduce MacOSDnsServerAddressStreamProvider which correctly detect all nameserver configuration on MacOS (#9161) 2019-10-28 15:03:40 +01:00
microbench Update to latest JMH version (#9787) 2019-11-19 11:28:36 +01:00
resolver Close delegate resolver from RoundRobinInetAddressResolver (#9214) 2019-06-04 05:14:28 -07:00
resolver-dns Ignore invalid entries in /etc/resolv.conf when parsing (#9697) 2019-10-22 14:34:17 +02:00
resolver-dns-native-macos Introduce MacOSDnsServerAddressStreamProvider which correctly detect all nameserver configuration on MacOS (#9161) 2019-10-28 15:03:40 +01:00
tarball Introduce MacOSDnsServerAddressStreamProvider which correctly detect all nameserver configuration on MacOS (#9161) 2019-10-28 15:03:40 +01:00
testsuite Rename SimpleChannelInboundHandler.channelRead0() to messageReceived() (#8819) 2019-11-01 07:23:07 +01:00
testsuite-autobahn Use allocator when constructing ByteBufHolder sub-types or use Unpool… (#9377) 2019-07-18 10:36:03 +02:00
testsuite-http2 Rename SimpleChannelInboundHandler.channelRead0() to messageReceived() (#8819) 2019-11-01 07:23:07 +01:00
testsuite-native-image Rename SimpleChannelInboundHandler.channelRead0() to messageReceived() (#8819) 2019-11-01 07:23:07 +01:00
testsuite-osgi Adjust testsuite-osgi to resolve bundles from local build (#8944) 2019-03-18 09:56:08 +01:00
testsuite-shading Allow to build on powerpc 2019-09-13 22:21:36 +02:00
transport Replace synchronized with ConcurrentHashMap in Http2StreamChannelBootstrap (#9848) 2019-12-06 12:02:57 +01:00
transport-blockhound-tests Test that NettyBlockHoundIntegration can be loaded with ServiceLoader (#9743) 2019-11-01 07:07:59 +01:00
transport-native-epoll Correctly take architecture into account when define syscalls for recvmmsg and sendmmsg usage (#9844) 2019-12-05 09:03:12 +01:00
transport-native-kqueue Fix event loop shutdown timing fragility (#9639) 2019-10-08 12:00:59 +04:00
transport-native-unix-common Fix the transport-native-unix-common build on FreeBSD (#9814) 2019-11-27 06:52:58 +01:00
transport-native-unix-common-tests Rename SimpleChannelInboundHandler.channelRead0() to messageReceived() (#8819) 2019-11-01 07:23:07 +01:00
transport-sctp Deprecate ChannelInboundHandlerAdapter and ChannelOutboundHandlerAdapter (#8929) 2019-03-13 09:46:10 +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 Add vscode specific files / directory to .gitignore (#9652) 2019-10-10 07:35:34 +02:00
CONTRIBUTING.md Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:10:14 +02: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 Introduce MacOSDnsServerAddressStreamProvider which correctly detect all nameserver configuration on MacOS (#9161) 2019-10-28 15:03:40 +01:00
pom.xml Include JCTools sources for shaded classes in the sources jar 2019-12-05 09:10:45 +01:00
README.md Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:10:14 +02:00
run-example.sh Drop SPDY support (#8845) 2019-02-07 09:25:31 +01: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.