Go to file
buchgr 5380c7c3e3 HTTP/2 Child Channel and FrameCodec Feature Parity.
Motivation:

This PR (unfortunately) does 4 things:
1) Add outbound flow control to the Http2MultiplexCodec:
   The HTTP/2 child channel API should interact with HTTP/2 outbound/remote flow control. That is,
   if a H2 stream used up all its flow control window, the corresponding child channel should be
   marked unwritable and a writability-changed event should be fired. Similarly, a unwritable
   child channel should be marked writable and a writability-event should be fired, once a
   WINDOW_UPDATE frame has been received. The changes are (mostly) contained in ChannelOutboundBuffer,
   AbstractHttp2StreamChannel and Http2MultiplexCodec.

2) Introduce a Http2Stream2 object, that is used instead of stream identifiers on stream frames. A
   Http2Stream2 object allows an application to attach state to it, and so a application handler
   no longer needs to maintain stream state (i.e. in a map(id -> state)) himself.

3) Remove stream state events, which are no longer necessary due to the introduction of Http2Stream2.
   Also those stream state events have been found hard and complex to work with, when porting gRPC
   to the Http2FrameCodec.

4) Add support for HTTP/2 frames that have not yet been implemented, like PING and SETTINGS. Also add
   a Http2FrameCodecBuilder that exposes options from the Http2ConnectionHandler API that couldn't else
   be used with the frame codec, like buffering outbound streams, window update ratio, frame logger, etc.

Modifications:

1) A child channel's writability and a H2 stream's outbound flow control window interact, as described
   in the motivation. A channel handler is free to ignore the channel's writability, in which case the
   parent channel is reponsible for buffering writes until a WINDOW_UPDATE is received.

   The connection-level flow control window is ignored for now. That is, a child channel's writability
   is only affected by the stream-level flow control window. So a child channel could be marked writable,
   even though the connection-level flow control window is zero.

2) Modify Http2StreamFrame and the Http2FrameCodec to take a Http2Stream2 object intstead of a primitive
   integer. Introduce a special Http2ChannelDuplexHandler that has newStream() and forEachActiveStream()
   methods. It's recommended for a user to extend from this handler, to use those advanced features.

3) As explained in the documentation, a new inbound stream active can be detected by checking if the
   Http2Stream2.managedState() of a Http2HeadersFrame is null. An outbound stream active can be detected
   by adding a listener to the ChannelPromise of the write of the first Http2HeadersFrame. A stream
   closed event can be listened to by adding a listener to the Http2Stream2.closeFuture().

4) Add a simple Http2FrameCodecBuilder and implement the missing frame types.

Result:

1) The Http2MultiplexCodec supports outbound flow control.
2) The Http2FrameCodec API makes it easy for a user to manage custom stream specific state and to create
   new outbound streams.
3) The Http2FrameCodec API is much cleaner and easier to work with. Hacks like the ChannelCarryingHeadersFrame
   are no longer necessary.
4) The Http2FrameCodec now also supports PING and SETTINGS frames. The Http2FrameCodecBuilder allows the Http2FrameCodec
   to use some of the rich features of the Http2ConnectionHandler API.
2017-08-11 12:41:28 +02:00
.github Use GitHub Issue/PR Template Feature 2016-12-07 11:40:26 -08:00
all [maven-release-plugin] prepare for next development iteration 2017-08-02 12:55:10 +00:00
bom [maven-release-plugin] prepare for next development iteration 2017-08-02 12:55:10 +00:00
buffer [maven-release-plugin] prepare for next development iteration 2017-08-02 12:55:10 +00:00
codec Handle partially decoded elements while streaming Json array 2017-08-08 08:48:01 +02:00
codec-dns [maven-release-plugin] prepare for next development iteration 2017-08-02 12:55:10 +00:00
codec-haproxy [maven-release-plugin] prepare for next development iteration 2017-08-02 12:55:10 +00:00
codec-http Add testcases to prove HttpResponseEncoder correctly handles empty content 2017-08-07 07:25:33 +02:00
codec-http2 HTTP/2 Child Channel and FrameCodec Feature Parity. 2017-08-11 12:41:28 +02:00
codec-memcache [maven-release-plugin] prepare for next development iteration 2017-08-02 12:55:10 +00:00
codec-mqtt Add null checks before converting to string to avoid NPE. 2017-08-11 07:14:39 +02:00
codec-redis [maven-release-plugin] prepare for next development iteration 2017-08-02 12:55:10 +00:00
codec-smtp [maven-release-plugin] prepare for next development iteration 2017-08-02 12:55:10 +00:00
codec-socks [maven-release-plugin] prepare for next development iteration 2017-08-02 12:55:10 +00:00
codec-stomp [maven-release-plugin] prepare for next development iteration 2017-08-02 12:55:10 +00:00
codec-xml [maven-release-plugin] prepare for next development iteration 2017-08-02 12:55:10 +00:00
common Remove debug cruft from e218759c0c 2017-08-08 17:01:31 +02:00
dev-tools [maven-release-plugin] prepare for next development iteration 2017-08-02 12:55:10 +00:00
example HTTP/2 Child Channel and FrameCodec Feature Parity. 2017-08-11 12:41:28 +02:00
handler Only call ctx.fireChannelReadComplete() if ByteToMessageDecoder decoded at least one message. 2017-08-04 10:54:56 +02:00
handler-proxy [maven-release-plugin] prepare for next development iteration 2017-08-02 12:55:10 +00:00
license Remove reference to akka code and ArrayDeque which is not part of netty anymore 2017-03-07 21:30:51 +01:00
microbench [maven-release-plugin] prepare for next development iteration 2017-08-02 12:55:10 +00:00
resolver [maven-release-plugin] prepare for next development iteration 2017-08-02 12:55:10 +00:00
resolver-dns [maven-release-plugin] prepare for next development iteration 2017-08-02 12:55:10 +00:00
tarball [maven-release-plugin] prepare for next development iteration 2017-08-02 12:55:10 +00:00
testsuite SocketGatheringWriteTest increase timeouts 2017-08-11 00:15:42 -07:00
testsuite-autobahn [maven-release-plugin] prepare for next development iteration 2017-08-02 12:55:10 +00:00
testsuite-osgi [maven-release-plugin] prepare for next development iteration 2017-08-02 12:55:10 +00:00
transport HTTP/2 Child Channel and FrameCodec Feature Parity. 2017-08-11 12:41:28 +02:00
transport-native-epoll Shutting down the outbound side of the channel should not accept future writes 2017-08-04 10:59:57 -07:00
transport-native-kqueue Shutting down the outbound side of the channel should not accept future writes 2017-08-04 10:59:57 -07:00
transport-native-unix-common Correctly handle connect/disconnect in EpollDatagramChannel / KQueueDatagramChannel 2017-08-04 09:22:53 +02:00
transport-native-unix-common-tests [maven-release-plugin] prepare for next development iteration 2017-08-02 12:55:10 +00:00
transport-rxtx We should prefer heap buffers when using the OIO transport to reduce memory copies. 2017-08-11 08:48:04 +02:00
transport-sctp [maven-release-plugin] prepare for next development iteration 2017-08-02 12:55:10 +00:00
transport-udt [maven-release-plugin] prepare for next development iteration 2017-08-02 12:55:10 +00:00
.fbprefs Updated Find Bugs configuration 2009-03-04 10:33:09 +00:00
.gitignore Use shaded dependency on JCTools instead of copy and paste 2016-06-10 13:19:45 +02:00
.travis.yml Travis CI branch whitelisting 2013-03-11 09:55:43 +09:00
CONTRIBUTING.md Move the pull request guide to the developer guide 2014-03-12 13:13:58 +09:00
LICENSE.txt Relicensed to Apache License v2 2009-08-28 07:15:49 +00:00
NOTICE.txt Remove reference to akka code and ArrayDeque which is not part of netty anymore 2017-03-07 21:30:51 +01:00
pom.xml asm 6.0_BETA was released so we should use it when building on java9 2017-08-05 08:16:50 +02:00
README.md Updating Branches to look section to match the current branching structure of the project 2016-03-10 22:08:01 +01: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.