Go to file
Bennett Lynch bcb62be62b
Consolidate HttpObjectDecoder default values into constants (#10344)
Motivation

HttpObjectDecoder and its associated classes make frequent use of
default values for maxInitialLineLength, maxHeaderSize, maxChunkSize,
etc. Today, these defaults are defined in-line in constructors and
duplicated across many classes. This repetition is more prone to error
and inconsistencies.

Furthermore, due to the current lack of builder support, if a user wants
to change just one of these values (e.g., maxHeaderSize), they are also
required to know and repeat the other default values (e.g.,
maxInitialLineLength and maxChunkSize).

The primary motivation for this change is as we are considering adding
another constructor parameter (for multiple content length behavior),
appending this parameter may require some users to have prior knowledge
of the default initialBufferSize, and it would be cleaner to allow them
to reference the default constant.

Modifications

* Consolidate the HttpObjectDecoder default values into public constants
* Reference these constants where possible

Result

No functional change. Additional telescoping constructors will be easier
and safer to write. Users may have an easier experience changing single
parameters.
2020-06-12 07:39:10 +02: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 Include aarch64 packages in netty-bom (#10292) 2020-05-15 10:12:46 +02:00
bom Include aarch64 packages in netty-bom (#10292) 2020-05-15 10:12:46 +02:00
buffer Include more details if we throw an IllegalArgumentException because of overflow (#10330) 2020-06-02 10:07:50 +02:00
codec [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
codec-dns [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
codec-haproxy [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
codec-http Consolidate HttpObjectDecoder default values into constants (#10344) 2020-06-12 07:39:10 +02:00
codec-http2 [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
codec-memcache [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
codec-mqtt [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
codec-redis [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
codec-smtp [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
codec-socks [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
codec-stomp [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
codec-xml [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
common Fix very tiny comment error in Recycler (#10309) 2020-05-25 07:39:52 +02:00
dev-tools [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
docker Update GraalVM with JDK 8 and add GraalVM with JDK 11 (#10333) 2020-06-02 11:52:55 +02:00
example Fix #10261 stomp can be chunked, so implement StompWebSocketFrameEncoder (#10274) 2020-06-04 19:14:13 +02:00
handler Motivation: (#10326) 2020-06-04 19:17:33 +02:00
handler-proxy [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +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-05-13 06:00:23 +00:00
resolver [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
resolver-dns Fix possible StackOverflowError when try to resolve authorative names… (#10337) 2020-06-04 17:56:59 +02:00
resolver-dns-native-macos [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
tarball [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
testsuite [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
testsuite-autobahn [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
testsuite-http2 [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
testsuite-native-image [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
testsuite-osgi [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
testsuite-shading [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
transport Guard against re-entrancy issues while draining AbstractCoalescingBufferQueue (#10294) 2020-05-15 09:51:33 +02:00
transport-blockhound-tests [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
transport-native-epoll [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
transport-native-kqueue [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
transport-native-unix-common [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
transport-native-unix-common-tests [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
transport-rxtx [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
transport-sctp [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
transport-udt [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +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
NOTICE.txt Introduce MacOSDnsServerAddressStreamProvider which correctly detect all nameserver configuration on MacOS (#9161) 2019-10-28 15:02:45 +01:00
README.md Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:09:42 +02: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 [maven-release-plugin] prepare for next development iteration 2020-05-13 06:00:23 +00:00
run-example.sh Add DNS client examples for run-example.sh (#10283) 2020-05-14 12:10:32 +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.