Go to file
Jonathan Leitschuh 38f45b50e3 Enables lgtm.com to process this project and create a CodeQL database
Motivation:

I'm performing some security research against various Java-based projects as a part of the new [GitHub Security Lab](https://securitylab.github.com/) Bug Bounty program.
Currently, LGTM.com can't create a CodeQL database for this project because of missing dependencies. This fixes the build so it works correctly.

The maintainers may also want to consider enabling the free [LGTM Integration](https://github.com/marketplace/lgtm) once this PR is merged.

Modification:

Adds a `.lgtm.yml` with a tested configuration:
A successful build can be found here:
https://lgtm.com/logs/6695df28f6b2b1d3fd4d03e968b600a3e9c9aecf/lang:java

Result:

LGTM.com will be able to process this repository to create a CodeQL database.
2020-01-20 19:22:49 +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 Fix BufferOverflowException during non-Unsafe PooledDirectByteBuf resize (#9912) 2020-01-11 06:05:32 +01:00
codec Close encoder when handlerRemoved. (#9950) 2020-01-14 10:51:49 +01:00
codec-dns Remove the intermediate List from ByteToMessageDecoder (and sub-class… (#8626) 2019-12-16 21:00:32 +01:00
codec-haproxy Remove the intermediate List from ByteToMessageDecoder (and sub-class… (#8626) 2019-12-16 21:00:32 +01:00
codec-http Fix remove 'WebSocketServerExtensionHandler' from pipeline after upgrade (#9940) 2020-01-15 12:12:51 +01:00
codec-http2 Fix typos in javadocs (#9900) 2019-12-23 08:34:28 +01:00
codec-memcache Remove the intermediate List from ByteToMessageDecoder (and sub-class… (#8626) 2019-12-16 21:00:32 +01:00
codec-mqtt Remove the intermediate List from ByteToMessageDecoder (and sub-class… (#8626) 2019-12-16 21:00:32 +01:00
codec-redis Remove the intermediate List from ByteToMessageDecoder (and sub-class… (#8626) 2019-12-16 21:00:32 +01:00
codec-smtp Remove the intermediate List from ByteToMessageDecoder (and sub-class… (#8626) 2019-12-16 21:00:32 +01:00
codec-socks Remove the intermediate List from ByteToMessageDecoder (and sub-class… (#8626) 2019-12-16 21:00:32 +01:00
codec-stomp Remove the intermediate List from ByteToMessageDecoder (and sub-class… (#8626) 2019-12-16 21:00:32 +01:00
codec-xml Remove the intermediate List from ByteToMessageDecoder (and sub-class… (#8626) 2019-12-16 21:00:32 +01:00
common Introduce `needReport` for `ResourceLeakDetector`. (#9910) 2020-01-10 05:22:05 +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 Add TLS SNI Extension in HTTP/2 Client request. (#9937) 2020-01-10 16:34:29 +01:00
handler Fix SniHandlerTest when jdkCompatibilityMode is false (#9934) 2020-01-10 10:15:19 +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 Faster decodeHexNibble (#9896) 2019-12-23 21:16:44 +01:00
resolver Remove @UnstableApi annotation from resolver-* (#9952) 2020-01-15 09:18:02 +01:00
resolver-dns Remove @UnstableApi annotation from resolver-* (#9952) 2020-01-15 09:18:02 +01:00
resolver-dns-native-macos Remove @UnstableApi annotation from resolver-* (#9952) 2020-01-15 09:18:02 +01:00
tarball Introduce MacOSDnsServerAddressStreamProvider which correctly detect all nameserver configuration on MacOS (#9161) 2019-10-28 15:03:40 +01:00
testsuite Revert "Protect ChannelHandler from reentrancee issues (#9358)" 2019-12-12 14:42:30 +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 Revert "Validate pseudo and conditional HTTP/2 headers (#8619)" 2019-12-17 17:45:17 +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 Revert "Protect ChannelHandler from reentrancee issues (#9358)" 2019-12-12 14:42:30 +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 Revert "Epoll: Avoid redundant EPOLL_CTL_MOD calls (#9397)" 2019-12-11 15:43:18 +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 Remove the intermediate List from ByteToMessageDecoder (and sub-class… (#8626) 2019-12-16 21:00:32 +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
.lgtm.yml Enables lgtm.com to process this project and create a CodeQL database 2020-01-20 19:22:49 +01: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
NOTICE.txt Introduce MacOSDnsServerAddressStreamProvider which correctly detect all nameserver configuration on MacOS (#9161) 2019-10-28 15:03:40 +01:00
README.md Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:10:14 +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 Use JCTools 3.0 + do not break on shaded jars API changes (should not be used by downstream) (#9920) 2020-01-15 14:26:50 +01:00
run-example.sh Drop SPDY support (#8845) 2019-02-07 09:25:31 +01: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.