1 /*
2 * Copyright 2025 The Netty Project
3 *
4 * The Netty Project licenses this file to you under the Apache License,
5 * version 2.0 (the "License"); you may not use this file except in compliance
6 * with the License. You may obtain a copy of the License at:
7 *
8 * https://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 * License for the specific language governing permissions and limitations
14 * under the License.
15 */
16 package io.netty.handler.codec.http2;
17
18 import io.netty.channel.ChannelOption;
19
20 /**
21 * {@link ChannelOption}s that are specific to {@link Http2StreamChannel}s.
22 *
23 * @param <T> the type of the value which is valid for the {@link ChannelOption}
24 */
25 public final class Http2StreamChannelOption<T> extends ChannelOption<T> {
26 private Http2StreamChannelOption(String name) {
27 super(name);
28 }
29
30 /**
31 * When set to {@code true} {@link Http2WindowUpdateFrame}s will be automatically be generated and written for
32 * {@link Http2StreamChannel}s as soon as frames are passed to the user via
33 * {@link io.netty.channel.ChannelPipeline#fireChannelRead(Object)}. If the user wants more control on when a
34 * window update is send its possible to set it to {@code false}. In this case the user is responsible to
35 * generate the correct {@link Http2WindowUpdateFrame}s and eventually write these to the channel.
36 * <p>
37 * See <a href="https://datatracker.ietf.org/doc/html/rfc9113#section-5.2">RFC9113 5.2. Flow Control</a> for more
38 * details.
39 */
40 public static final ChannelOption<Boolean> AUTO_STREAM_FLOW_CONTROL =
41 valueOf("AUTO_STREAM_FLOW_CONTROL");
42 }