3613d15bca
Motivation: Quote from issue 4914: "Http2MultiplexCodec currently does two things: mapping the existing h2 API to frames and managing the child channels. It would be better if the two parts were separated. This would allow less-coupled development of the HTTP/2 handlers (flow control could be its own handler, for instance) and allow applications to insert themselves between all streams and the codec, which permits custom logic and could be used, in part, to implement custom frame types. It would also greatly ease testing, as the child channel could be tested by itself without dealing with how frames are encoded on the wire." Modifications: - Split the Http2MultiplexCodec into Http2FrameCodec and Http2MultiplexCodec. The Http2FrameCodec interacts with the existing HTTP/2 callback-based API, while the Http2MulitplexCodec is completely independent of it and simply multiplexes Http2StreamFrames to the child channels. Additionally, the Http2Codec handler is introduced, which is a convenience class that simply sets up the Http2FrameCodec and Http2MultiplexCodec in the channel pipeline and removes itself. - Improved test coverage quite a bit. Result: - The original Http2MultiplexCodec is split into Http2FrameCodec and Http2MultiplexCodec. - More tests for higher confidence in the code.
90 lines
2.6 KiB
Java
90 lines
2.6 KiB
Java
/*
|
|
* Copyright 2016 The Netty Project
|
|
*
|
|
* The Netty Project licenses this file to you under the Apache License,
|
|
* version 2.0 (the "License"); you may not use this file except in compliance
|
|
* with the License. You may obtain a copy of the License at:
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
* License for the specific language governing permissions and limitations
|
|
* under the License.
|
|
*/
|
|
package io.netty.handler.codec.http2;
|
|
|
|
import io.netty.buffer.ByteBuf;
|
|
import io.netty.buffer.ByteBufHolder;
|
|
import io.netty.util.internal.UnstableApi;
|
|
|
|
/**
|
|
* HTTP/2 GOAWAY frame.
|
|
*
|
|
* <p>The last stream identifier <em>must not</em> be set by the application, but instead the
|
|
* relative {@link #extraStreamIds()} should be used. The {@link #lastStreamId()} will only be
|
|
* set for incoming GOAWAY frames by the HTTP/2 codec.
|
|
*
|
|
* <p>Graceful shutdown as described in the HTTP/2 spec can be accomplished by calling
|
|
* {@code #setExtraStreamIds(Integer.MAX_VALUE)}.
|
|
*/
|
|
@UnstableApi
|
|
public interface Http2GoAwayFrame extends Http2Frame, ByteBufHolder {
|
|
/**
|
|
* The reason for beginning closure of the connection. Represented as an HTTP/2 error code.
|
|
*/
|
|
long errorCode();
|
|
|
|
/**
|
|
* The number of IDs to reserve for the receiver to use while GOAWAY is in transit. This allows
|
|
* for new streams currently en route to still be created, up to a point, which allows for very
|
|
* graceful shutdown of both sides.
|
|
*/
|
|
int extraStreamIds();
|
|
|
|
/**
|
|
* Sets the number of IDs to reserve for the receiver to use while GOAWAY is in transit.
|
|
*
|
|
* @see #extraStreamIds
|
|
* @return {@code this}
|
|
*/
|
|
Http2GoAwayFrame setExtraStreamIds(int extraStreamIds);
|
|
|
|
/**
|
|
* Returns the last stream identifier if set, or {@code -1} else.
|
|
*/
|
|
int lastStreamId();
|
|
|
|
/**
|
|
* Optional debugging information describing cause the GOAWAY. Will not be {@code null}, but may
|
|
* be empty.
|
|
*/
|
|
@Override
|
|
ByteBuf content();
|
|
|
|
@Override
|
|
Http2GoAwayFrame copy();
|
|
|
|
@Override
|
|
Http2GoAwayFrame duplicate();
|
|
|
|
@Override
|
|
Http2GoAwayFrame retainedDuplicate();
|
|
|
|
@Override
|
|
Http2GoAwayFrame replace(ByteBuf content);
|
|
|
|
@Override
|
|
Http2GoAwayFrame retain();
|
|
|
|
@Override
|
|
Http2GoAwayFrame retain(int increment);
|
|
|
|
@Override
|
|
Http2GoAwayFrame touch();
|
|
|
|
@Override
|
|
Http2GoAwayFrame touch(Object hint);
|
|
}
|