#20514

Committed 09 Oct 2026 08:47AM UTC coverage: 89.382% (+0.03%) from 89.35%

Build # #20514

Build Type

push

github

Committed by

web-flow

Commit Message

netty: enable AdaptiveCumulator (#13100)

Coverage Stats

39270 of 43935 relevant lines covered (89.38%)

0.89 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

66.67

/../netty/src/main/java/io/grpc/netty/GrpcHttp2ConnectionHandler.java

/*
 * Copyright 2016 The gRPC Authors
 *
 * Licensed 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.grpc.netty;

import static com.google.common.base.Preconditions.checkState;

import io.grpc.Attributes;
import io.grpc.ChannelLogger;
import io.grpc.Internal;
import io.grpc.InternalChannelz;
import io.netty.channel.ChannelPromise;
import io.netty.handler.codec.AdaptiveCumulator;
import io.netty.handler.codec.ByteToMessageDecoder.Cumulator;
import io.netty.handler.codec.http2.Http2ConnectionDecoder;
import io.netty.handler.codec.http2.Http2ConnectionEncoder;
import io.netty.handler.codec.http2.Http2ConnectionHandler;
import io.netty.handler.codec.http2.Http2Settings;
import javax.annotation.Nullable;

/**
 * gRPC wrapper for {@link Http2ConnectionHandler}.
 */
@Internal
public abstract class GrpcHttp2ConnectionHandler extends Http2ConnectionHandler {
  private static final int ADAPTIVE_CUMULATOR_COMPOSE_MIN_SIZE_DEFAULT = 1024;
  private static final Cumulator ADAPTIVE_CUMULATOR =
      new AdaptiveCumulator(ADAPTIVE_CUMULATOR_COMPOSE_MIN_SIZE_DEFAULT);

  @Nullable
  protected final ChannelPromise channelUnused;
  private final ChannelLogger negotiationLogger;

  @SuppressWarnings("this-escape")
  protected GrpcHttp2ConnectionHandler(
      ChannelPromise channelUnused,
      Http2ConnectionDecoder decoder,
      Http2ConnectionEncoder encoder,
      Http2Settings initialSettings,
      ChannelLogger negotiationLogger) {
    super(decoder, encoder, initialSettings);
    this.channelUnused = channelUnused;
    this.negotiationLogger = negotiationLogger;
    setCumulator(ADAPTIVE_CUMULATOR);
  }

  /**
   * Same as {@link #handleProtocolNegotiationCompleted(
   *   Attributes, io.grpc.InternalChannelz.Security)}
   * but with no {@link io.grpc.InternalChannelz.Security}.
   *
   * @deprecated Use the two argument method instead.
   */
  @Deprecated
  @SuppressWarnings("InlineMeSuggester") // the caller should consider providing securityInfo
  public void handleProtocolNegotiationCompleted(Attributes attrs) {
    handleProtocolNegotiationCompleted(attrs, /*securityInfo=*/ null);
  }

  /**
   * Triggered on protocol negotiation completion.
   *
   * <p>It must me called after negotiation is completed but before given handler is added to the
   * channel.
   *
   * @param attrs arbitrary attributes passed after protocol negotiation (eg. SSLSession).
   * @param securityInfo informs channelz about the security protocol.
   */
  public void handleProtocolNegotiationCompleted(
      Attributes attrs, InternalChannelz.Security securityInfo) {
  }

  /**
   * Returns the channel logger for the given channel context.
   */
  public ChannelLogger getNegotiationLogger() {
    checkState(negotiationLogger != null, "NegotiationLogger must not be null");
    return negotiationLogger;
  }

  /**
   * Calling this method indicates that the channel will no longer be used.  This method is roughly
   * the same as calling {@link #close} on the channel, but leaving the channel alive.  This is
   * useful if the channel will soon be deregistered from the executor and used in a non-Netty
   * context.
   */
  @SuppressWarnings("FutureReturnValueIgnored")
  public void notifyUnused() {
    channelUnused.setSuccess(null);
  }

  /** Get the attributes of the EquivalentAddressGroup used to create this transport. */
  public Attributes getEagAttributes() {
    return Attributes.EMPTY;
  }

  /**
   * Returns the authority of the server. Only available on the client-side.
   *
   * @throws UnsupportedOperationException if on server-side
   */
  public String getAuthority() {
    throw new UnsupportedOperationException();
  }
}

1	/*
2	* Copyright 2016 The gRPC Authors
3	*
4	* Licensed under the Apache License, Version 2.0 (the "License");
5	* you may not use this file except in compliance with the License.
6	* You may obtain a copy of the License at
7	*
8	* http://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,
12	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13	* See the License for the specific language governing permissions and
14	* limitations under the License.
15	*/
16
17	package io.grpc.netty;
18
19	import static com.google.common.base.Preconditions.checkState;
20
21	import io.grpc.Attributes;
22	import io.grpc.ChannelLogger;
23	import io.grpc.Internal;
24	import io.grpc.InternalChannelz;
25	import io.netty.channel.ChannelPromise;
26	import io.netty.handler.codec.AdaptiveCumulator;
27	import io.netty.handler.codec.ByteToMessageDecoder.Cumulator;
28	import io.netty.handler.codec.http2.Http2ConnectionDecoder;
29	import io.netty.handler.codec.http2.Http2ConnectionEncoder;
30	import io.netty.handler.codec.http2.Http2ConnectionHandler;
31	import io.netty.handler.codec.http2.Http2Settings;
32	import javax.annotation.Nullable;
33
34	/**
35	* gRPC wrapper for {@link Http2ConnectionHandler}.
36	*/
37	@Internal
38	public abstract class GrpcHttp2ConnectionHandler extends Http2ConnectionHandler {
39	private static final int ADAPTIVE_CUMULATOR_COMPOSE_MIN_SIZE_DEFAULT = 1024;
40	private static final Cumulator ADAPTIVE_CUMULATOR =	1 ✔
41	new AdaptiveCumulator(ADAPTIVE_CUMULATOR_COMPOSE_MIN_SIZE_DEFAULT);
42
43	@Nullable
44	protected final ChannelPromise channelUnused;
45	private final ChannelLogger negotiationLogger;
46
47	@SuppressWarnings("this-escape")
48	protected GrpcHttp2ConnectionHandler(
49	ChannelPromise channelUnused,
50	Http2ConnectionDecoder decoder,
51	Http2ConnectionEncoder encoder,
52	Http2Settings initialSettings,
53	ChannelLogger negotiationLogger) {
54	super(decoder, encoder, initialSettings);	1 ✔
55	this.channelUnused = channelUnused;	1 ✔
56	this.negotiationLogger = negotiationLogger;	1 ✔
57	setCumulator(ADAPTIVE_CUMULATOR);	1 ✔
58	}	1 ✔
59
60	/**
61	* Same as {@link #handleProtocolNegotiationCompleted(
62	* Attributes, io.grpc.InternalChannelz.Security)}
63	* but with no {@link io.grpc.InternalChannelz.Security}.
64	*
65	* @deprecated Use the two argument method instead.
66	*/
67	@Deprecated
68	@SuppressWarnings("InlineMeSuggester") // the caller should consider providing securityInfo
69	public void handleProtocolNegotiationCompleted(Attributes attrs) {
70	handleProtocolNegotiationCompleted(attrs, /securityInfo=/ null);	×
71	}	×
72
73	/**
74	* Triggered on protocol negotiation completion.
75	*
76	* <p>It must me called after negotiation is completed but before given handler is added to the
77	* channel.
78	*
79	* @param attrs arbitrary attributes passed after protocol negotiation (eg. SSLSession).
80	* @param securityInfo informs channelz about the security protocol.
81	*/
82	public void handleProtocolNegotiationCompleted(
83	Attributes attrs, InternalChannelz.Security securityInfo) {
84	}	1 ✔
85
86	/**
87	* Returns the channel logger for the given channel context.
88	*/
89	public ChannelLogger getNegotiationLogger() {
90	checkState(negotiationLogger != null, "NegotiationLogger must not be null");	1 ✔
91	return negotiationLogger;	1 ✔
92	}
93
94	/**
95	* Calling this method indicates that the channel will no longer be used. This method is roughly
96	* the same as calling {@link #close} on the channel, but leaving the channel alive. This is
97	* useful if the channel will soon be deregistered from the executor and used in a non-Netty
98	* context.
99	*/
100	@SuppressWarnings("FutureReturnValueIgnored")
101	public void notifyUnused() {
102	channelUnused.setSuccess(null);	×
103	}	×
104
105	/** Get the attributes of the EquivalentAddressGroup used to create this transport. */
106	public Attributes getEagAttributes() {
107	return Attributes.EMPTY;	1 ✔
108	}
109
110	/**
111	* Returns the authority of the server. Only available on the client-side.
112	*
113	* @throws UnsupportedOperationException if on server-side
114	*/
115	public String getAuthority() {
116	throw new UnsupportedOperationException();	×
117	}
118	}

grpc / grpc-java / #20514

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous