Go to file
Bennett Lynch a7de4747d0 Add ByteBufFormat option to LoggingHandler (#9915)
Motivation

LoggingHandler is a very useful tool for debugging and for tracking the
sequence of events in a pipeline. LoggingHandler also includes the
functionality to log a hex dump of all written and received ByteBufs.
This can be useful for small messages, but for large messages, this can
potentially result in extremely large logs. E.g., a 1 MB payload will
result in over a 1 MB log message being recorded. While LoggingHandler
may only be intended for debugging, this can still be too excessive in
some debugging scenarios.

Modifications

* Create a new ByteBufFormat enum that allows users to specify "SIMPLE"
or "HEX_DUMP" logging for ByteBufs.
* For all constructors that currently accept a LogLevel parameter,
create new overloaded constructors that also accept this enum as a
parameter.
* Continue to record hex dumps by default.

Result

Users will be able to opt out of full hex dump recording, if they wish
to.
2020-01-23 16:50:28 -08:00
.github Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:09:42 +02:00
.mvn Use latest maven release (#9820) 2019-11-27 14:45:28 +01:00
all [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
bom [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
buffer [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
codec Close encoder when handlerRemoved. (#9950) 2020-01-14 10:51:30 +01:00
codec-dns [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
codec-haproxy [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
codec-http Fix remove 'WebSocketServerExtensionHandler' from pipeline after upgrade (#9940) 2020-01-15 10:49:51 +01:00
codec-http2 [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
codec-memcache [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
codec-mqtt [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
codec-redis [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
codec-smtp [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
codec-socks [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
codec-stomp [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
codec-xml [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
common [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
dev-tools [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
docker Upgrade various JDK flavors / version in our docker-compose files (#9737) 2019-10-31 12:16:24 +01:00
example [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
handler Add ByteBufFormat option to LoggingHandler (#9915) 2020-01-23 16:50:28 -08:00
handler-proxy [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
license Introduce MacOSDnsServerAddressStreamProvider which correctly detect all nameserver configuration on MacOS (#9161) 2019-10-28 15:02:45 +01:00
microbench [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
resolver Remove @UnstableApi annotation from resolver-* (#9952) 2020-01-15 09:10:13 +01:00
resolver-dns Remove @UnstableApi annotation from resolver-* (#9952) 2020-01-15 09:10:13 +01:00
resolver-dns-native-macos Remove @UnstableApi annotation from resolver-* (#9952) 2020-01-15 09:10:13 +01:00
tarball [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
testsuite [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
testsuite-autobahn [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
testsuite-http2 [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
testsuite-native-image [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
testsuite-osgi [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
testsuite-shading [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
transport [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
transport-blockhound-tests [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
transport-native-epoll [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
transport-native-kqueue [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
transport-native-unix-common [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
transport-native-unix-common-tests [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
transport-rxtx [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
transport-sctp [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +00:00
transport-udt [maven-release-plugin] prepare for next development iteration 2020-01-13 09:13:53 +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 vscode specific files / directory to .gitignore (#9652) 2019-10-10 09:35:08 +04:00
.lgtm.yml Enables lgtm.com to process this project and create a CodeQL database 2020-01-17 11:05:53 +01:00
CONTRIBUTING.md Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:09:42 +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:02:45 +01:00
pom.xml Use JCTools 3.0 + do not break on shaded jars API changes (should not be used by downstream) (#9920) 2020-01-15 14:26:36 +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.