Netty 4.1.107.Final · io.netty.handler.codec.http2.Http2MultiplexCodecBuilder

Modifier and Type	Field and Description
pack-priv final ChannelHandler	childHandler
private Http2FrameWriter	frameWriter
private ChannelHandler	upgradeStreamHandler

Access	Constructor and Description
pack-priv	Http2MultiplexCodecBuilder(boolean server, ChannelHandler childHandler)

Modifier and Type	Method and Description
public Http2MultiplexCodecBuilder	autoAckPingFrame(boolean autoAckPingFrame) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.autoAckPingFrame. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. Determine if PING frame should automatically be acknowledged or not.
public Http2MultiplexCodecBuilder	autoAckSettingsFrame(boolean autoAckSettings) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.autoAckSettingsFrame. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. Determine if settings frame should automatically be acknowledged and applied.
public Http2MultiplexCodec	build() Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.build. Deprecated as a consequence of `Http2MultiplexCodec` being deprecated. Create a new `Http2ConnectionHandler`.
protected Http2MultiplexCodec	build(Http2ConnectionDecoder decoder, Http2ConnectionEncoder encoder, Http2Settings initialSettings) Implements abstract io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.build. Deprecated as a consequence of `Http2MultiplexCodec` being deprecated. Implement this method to create a new `Http2ConnectionHandler` or its subtype instance.
private static ChannelHandler	checkSharable(ChannelHandler handler)
public int	decoderEnforceMaxConsecutiveEmptyDataFrames() Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.decoderEnforceMaxConsecutiveEmptyDataFrames. Returns the maximum number of consecutive empty DATA frames (without end_of_stream flag) that are allowed before the connection is closed.
public Http2MultiplexCodecBuilder	decoderEnforceMaxConsecutiveEmptyDataFrames(int maxConsecutiveEmptyFrames) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.decoderEnforceMaxConsecutiveEmptyDataFrames. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. Sets the maximum number of consecutive empty DATA frames (without end_of_stream flag) that are allowed before the connection is closed.
public Http2MultiplexCodecBuilder	decoderEnforceMaxRstFramesPerWindow(int maxRstFramesPerWindow, int secondsPerWindow) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.decoderEnforceMaxRstFramesPerWindow. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. Sets the maximum number RST frames that are allowed per window before the connection is closed.
public Http2MultiplexCodecBuilder	decoupleCloseAndGoAway(boolean `true` to make `Channel#close()` directly close the underlying transport, and not attempt graceful closure via GOAWAY. decoupleCloseAndGoAway) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.decoupleCloseAndGoAway. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. Determine if the `Channel#close()` should be coupled with goaway and graceful close.
public boolean	encoderEnforceMaxConcurrentStreams() Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.encoderEnforceMaxConcurrentStreams. Returns if the encoder should queue frames if the maximum number of concurrent streams would otherwise be exceeded.
public Http2MultiplexCodecBuilder	encoderEnforceMaxConcurrentStreams(boolean encoderEnforceMaxConcurrentStreams) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.encoderEnforceMaxConcurrentStreams. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. Sets if the encoder should queue frames if the maximum number of concurrent streams would otherwise be exceeded.
public int	encoderEnforceMaxQueuedControlFrames() Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.encoderEnforceMaxQueuedControlFrames. Returns the maximum number of queued control frames that are allowed before the connection is closed.
public Http2MultiplexCodecBuilder	encoderEnforceMaxQueuedControlFrames(int maxQueuedControlFrames) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.encoderEnforceMaxQueuedControlFrames. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. Sets the maximum number of queued control frames that are allowed before the connection is closed.
public Http2MultiplexCodecBuilder	encoderIgnoreMaxHeaderListSize(boolean `true` to ignore SETTINGS_MAX_HEADER_LIST_SIZE. ignoreMaxHeaderListSize) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.encoderIgnoreMaxHeaderListSize. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. Sets if the SETTINGS_MAX_HEADER_LIST_SIZE should be ignored when encoding headers.
public Http2MultiplexCodecBuilder	flushPreface(boolean `true` to automatically flush, `false otherwise`. flushPreface) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.flushPreface. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. Determine if the Preface should be automatically flushed when the `Channel` becomes active or not.
public static Http2MultiplexCodecBuilder	forClient(ChannelHandler the handler added to channels for remotely-created streams. It must be `ChannelHandler.Sharable`. childHandler) Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. Creates a builder for an HTTP/2 client.
public static Http2MultiplexCodecBuilder	forServer(ChannelHandler the handler added to channels for remotely-created streams. It must be `ChannelHandler.Sharable`. childHandler) Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. Creates a builder for an HTTP/2 server.
public Http2FrameLogger	frameLogger() Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.frameLogger. Returns the logger that is used for the encoder and decoder.
public Http2MultiplexCodecBuilder	frameLogger(Http2FrameLogger frameLogger) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.frameLogger. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. Sets the logger that is used for the encoder and decoder.
pack-priv Http2MultiplexCodecBuilder	frameWriter(Http2FrameWriter frameWriter) Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated.
public long	gracefulShutdownTimeoutMillis() Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.gracefulShutdownTimeoutMillis. Returns the graceful shutdown timeout of the `Http2Connection` in milliseconds.
public Http2MultiplexCodecBuilder	gracefulShutdownTimeoutMillis(long gracefulShutdownTimeoutMillis) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.gracefulShutdownTimeoutMillis. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. Sets the graceful shutdown timeout of the `Http2Connection` in milliseconds.
public Http2HeadersEncoder.SensitivityDetector	headerSensitivityDetector() Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.headerSensitivityDetector. Returns the `SensitivityDetector` to use.
public Http2MultiplexCodecBuilder	headerSensitivityDetector(Http2HeadersEncoder.SensitivityDetector headerSensitivityDetector) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.headerSensitivityDetector. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. Sets the `SensitivityDetector` to use.
public Http2MultiplexCodecBuilder	initialHuffmanDecodeCapacity(int initialHuffmanDecodeCapacity) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.initialHuffmanDecodeCapacity. Deprecated Does nothing, do not call.
public Http2Settings	initialSettings() Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.initialSettings. Sets the `Http2Settings` to use for the initial connection settings exchange.
public Http2MultiplexCodecBuilder	initialSettings(Http2Settings settings) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.initialSettings. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. Sets the `Http2Settings` to use for the initial connection settings exchange.
public boolean	isServer() Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.isServer. Returns if `build()` will to create a `Http2Connection` in server mode (`true`) or client mode (`false`).
public boolean	isValidateHeaders() Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.isValidateHeaders. Returns if HTTP headers should be validated according to RFC 7540, 8.1.2.6.
public int	maxReservedStreams() Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.maxReservedStreams. Get the maximum number of streams which can be in the reserved state at any given time.
public Http2MultiplexCodecBuilder	maxReservedStreams(int maxReservedStreams) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.maxReservedStreams. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. Set the maximum number of streams which can be in the reserved state at any given time.
public Http2MultiplexCodecBuilder	validateHeaders(boolean validateHeaders) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.validateHeaders. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. Sets if HTTP headers should be validated according to RFC 7540, 8.1.2.6.
public Http2MultiplexCodecBuilder	withUpgradeStreamHandler(ChannelHandler upgradeStreamHandler) Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated.

childHandler	back to summary
pack-priv final ChannelHandler childHandler

frameWriter	back to summary
private Http2FrameWriter frameWriter

upgradeStreamHandler	back to summary
private ChannelHandler upgradeStreamHandler

Http2MultiplexCodecBuilder	back to summary
pack-priv Http2MultiplexCodecBuilder(boolean server, ChannelHandler childHandler)

Method Detail

autoAckPingFrame back to summary

autoAckPingFrame	back to summary
public Http2MultiplexCodecBuilder autoAckPingFrame(boolean autoAckPingFrame) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.autoAckPingFrame. Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.autoAckPingFrame. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. See corresponding docs for further information. Determine if PING frame should automatically be acknowledged or not. Returns:Http2MultiplexCodecBuilder this. Annotations @Override

public Http2MultiplexCodecBuilder autoAckPingFrame(boolean autoAckPingFrame)

Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.autoAckPingFrame.

Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.autoAckPingFrame.

Deprecated

as a consequence of Http2MultiplexCodecBuilder being deprecated. See corresponding docs for further information.

Determine if PING frame should automatically be acknowledged or not.

Returns:Http2MultiplexCodecBuilder

this.

Annotations

@Override

autoAckSettingsFrame back to summary

autoAckSettingsFrame	back to summary
public Http2MultiplexCodecBuilder autoAckSettingsFrame(boolean autoAckSettings) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.autoAckSettingsFrame. Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.autoAckSettingsFrame. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. See corresponding docs for further information. Determine if settings frame should automatically be acknowledged and applied. Returns:Http2MultiplexCodecBuilder this. Annotations @Override

public Http2MultiplexCodecBuilder autoAckSettingsFrame(boolean autoAckSettings)

Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.autoAckSettingsFrame.

Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.autoAckSettingsFrame.

Deprecated

as a consequence of Http2MultiplexCodecBuilder being deprecated. See corresponding docs for further information.

Determine if settings frame should automatically be acknowledged and applied.

Returns:Http2MultiplexCodecBuilder

this.

Annotations

@Override

build back to summary

build	back to summary
public Http2MultiplexCodec build() Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.build. Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.build. Deprecated as a consequence of `Http2MultiplexCodec` being deprecated. See corresponding docs for further information. Create a new `Http2ConnectionHandler`. Annotations @Override

public Http2MultiplexCodec build()

Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.build.

Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.build.

Deprecated

as a consequence of Http2MultiplexCodec being deprecated. See corresponding docs for further information.

Create a new Http2ConnectionHandler.

Annotations

@Override

build back to summary

build	back to summary
protected Http2MultiplexCodec build(Http2ConnectionDecoder decoder, Http2ConnectionEncoder encoder, Http2Settings initialSettings) Implements abstract io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.build. Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.build. Deprecated as a consequence of `Http2MultiplexCodec` being deprecated. See corresponding docs for further information. Implement this method to create a new `Http2ConnectionHandler` or its subtype instance. The return of this method will be subject to the following: `frameListener(Http2FrameListener)` will be set if not already set in the decoder `gracefulShutdownTimeoutMillis(long)` will always be set Annotations @Override

protected Http2MultiplexCodec build(Http2ConnectionDecoder decoder, Http2ConnectionEncoder encoder, Http2Settings initialSettings)

Implements abstract io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.build.

Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.build.

Deprecated

as a consequence of Http2MultiplexCodec being deprecated. See corresponding docs for further information.

Implement this method to create a new Http2ConnectionHandler or its subtype instance.

The return of this method will be subject to the following:

frameListener(Http2FrameListener) will be set if not already set in the decoder
gracefulShutdownTimeoutMillis(long) will always be set

Annotations

@Override

checkSharable	back to summary
private static ChannelHandler checkSharable(ChannelHandler handler)

decoderEnforceMaxConsecutiveEmptyDataFrames back to summary

decoderEnforceMaxConsecutiveEmptyDataFrames	back to summary
public int decoderEnforceMaxConsecutiveEmptyDataFrames() Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.decoderEnforceMaxConsecutiveEmptyDataFrames. Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.decoderEnforceMaxConsecutiveEmptyDataFrames. Returns the maximum number of consecutive empty DATA frames (without end_of_stream flag) that are allowed before the connection is closed. This allows to protect against the remote peer flooding us with such frames and so use up a lot of CPU. There is no valid use-case for empty DATA frames without end_of_stream flag. `0` means no protection is in place. Annotations @Override

public int decoderEnforceMaxConsecutiveEmptyDataFrames()

Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.decoderEnforceMaxConsecutiveEmptyDataFrames.

Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.decoderEnforceMaxConsecutiveEmptyDataFrames.

Returns the maximum number of consecutive empty DATA frames (without end_of_stream flag) that are allowed before the connection is closed. This allows to protect against the remote peer flooding us with such frames and so use up a lot of CPU. There is no valid use-case for empty DATA frames without end_of_stream flag. 0 means no protection is in place.

Annotations

@Override

decoderEnforceMaxConsecutiveEmptyDataFrames back to summary

decoderEnforceMaxConsecutiveEmptyDataFrames	back to summary
public Http2MultiplexCodecBuilder decoderEnforceMaxConsecutiveEmptyDataFrames(int maxConsecutiveEmptyFrames) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.decoderEnforceMaxConsecutiveEmptyDataFrames. Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.decoderEnforceMaxConsecutiveEmptyDataFrames. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. See corresponding docs for further information. Sets the maximum number of consecutive empty DATA frames (without end_of_stream flag) that are allowed before the connection is closed. This allows to protect against the remote peer flooding us with such frames and so use up a lot of CPU. There is no valid use-case for empty DATA frames without end_of_stream flag. `0` means no protection should be applied. Annotations @Override

public Http2MultiplexCodecBuilder decoderEnforceMaxConsecutiveEmptyDataFrames(int maxConsecutiveEmptyFrames)

Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.decoderEnforceMaxConsecutiveEmptyDataFrames.

Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.decoderEnforceMaxConsecutiveEmptyDataFrames.

Deprecated

as a consequence of Http2MultiplexCodecBuilder being deprecated. See corresponding docs for further information.

Sets the maximum number of consecutive empty DATA frames (without end_of_stream flag) that are allowed before the connection is closed. This allows to protect against the remote peer flooding us with such frames and so use up a lot of CPU. There is no valid use-case for empty DATA frames without end_of_stream flag. 0 means no protection should be applied.

Annotations

@Override

decoderEnforceMaxRstFramesPerWindow back to summary

decoderEnforceMaxRstFramesPerWindow	back to summary
public Http2MultiplexCodecBuilder decoderEnforceMaxRstFramesPerWindow(int maxRstFramesPerWindow, int secondsPerWindow) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.decoderEnforceMaxRstFramesPerWindow. Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.decoderEnforceMaxRstFramesPerWindow. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. See corresponding docs for further information. Sets the maximum number RST frames that are allowed per window before the connection is closed. This allows to protect against the remote peer flooding us with such frames and so use up a lot of CPU. `0` for any of the parameters means no protection should be applied. Annotations @Override

public Http2MultiplexCodecBuilder decoderEnforceMaxRstFramesPerWindow(int maxRstFramesPerWindow, int secondsPerWindow)

Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.decoderEnforceMaxRstFramesPerWindow.

Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.decoderEnforceMaxRstFramesPerWindow.

Deprecated

as a consequence of Http2MultiplexCodecBuilder being deprecated. See corresponding docs for further information.

Sets the maximum number RST frames that are allowed per window before the connection is closed. This allows to protect against the remote peer flooding us with such frames and so use up a lot of CPU. 0 for any of the parameters means no protection should be applied.

Annotations

@Override

decoupleCloseAndGoAway back to summary

decoupleCloseAndGoAway	back to summary
public Http2MultiplexCodecBuilder decoupleCloseAndGoAway(boolean decoupleCloseAndGoAway) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.decoupleCloseAndGoAway. Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.decoupleCloseAndGoAway. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. See corresponding docs for further information. Determine if the `Channel#close()` should be coupled with goaway and graceful close. Parameters decoupleCloseAndGoAway:boolean `true` to make `Channel#close()` directly close the underlying transport, and not attempt graceful closure via GOAWAY. Returns:Http2MultiplexCodecBuilder `this`. Annotations @Override

public Http2MultiplexCodecBuilder decoupleCloseAndGoAway(boolean decoupleCloseAndGoAway)

Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.decoupleCloseAndGoAway.

Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.decoupleCloseAndGoAway.

Deprecated

as a consequence of Http2MultiplexCodecBuilder being deprecated. See corresponding docs for further information.

Determine if the Channel#close() should be coupled with goaway and graceful close.

Parameters

decoupleCloseAndGoAway:boolean: true to make Channel#close() directly close the underlying transport, and not attempt graceful closure via GOAWAY.

Returns:Http2MultiplexCodecBuilder

this.

Annotations

@Override

encoderEnforceMaxConcurrentStreams	back to summary
public boolean encoderEnforceMaxConcurrentStreams() Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.encoderEnforceMaxConcurrentStreams. Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.encoderEnforceMaxConcurrentStreams. Returns if the encoder should queue frames if the maximum number of concurrent streams would otherwise be exceeded. Annotations @Override

encoderEnforceMaxConcurrentStreams

back to summary

public boolean encoderEnforceMaxConcurrentStreams()

Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.encoderEnforceMaxConcurrentStreams.

Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.encoderEnforceMaxConcurrentStreams.

Returns if the encoder should queue frames if the maximum number of concurrent streams would otherwise be exceeded.

Annotations

@Override

encoderEnforceMaxConcurrentStreams back to summary

encoderEnforceMaxConcurrentStreams	back to summary
public Http2MultiplexCodecBuilder encoderEnforceMaxConcurrentStreams(boolean encoderEnforceMaxConcurrentStreams) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.encoderEnforceMaxConcurrentStreams. Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.encoderEnforceMaxConcurrentStreams. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. See corresponding docs for further information. Sets if the encoder should queue frames if the maximum number of concurrent streams would otherwise be exceeded. Annotations @Override

public Http2MultiplexCodecBuilder encoderEnforceMaxConcurrentStreams(boolean encoderEnforceMaxConcurrentStreams)

Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.encoderEnforceMaxConcurrentStreams.

Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.encoderEnforceMaxConcurrentStreams.

Deprecated

as a consequence of Http2MultiplexCodecBuilder being deprecated. See corresponding docs for further information.

Sets if the encoder should queue frames if the maximum number of concurrent streams would otherwise be exceeded.

Annotations

@Override

encoderEnforceMaxQueuedControlFrames back to summary

encoderEnforceMaxQueuedControlFrames	back to summary
public int encoderEnforceMaxQueuedControlFrames() Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.encoderEnforceMaxQueuedControlFrames. Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.encoderEnforceMaxQueuedControlFrames. Returns the maximum number of queued control frames that are allowed before the connection is closed. This allows to protected against various attacks that can lead to high CPU / memory usage if the remote-peer floods us with frames that would have us produce control frames, but stops to read from the underlying socket. `0` means no protection is in place. Annotations @Override

public int encoderEnforceMaxQueuedControlFrames()

Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.encoderEnforceMaxQueuedControlFrames.

Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.encoderEnforceMaxQueuedControlFrames.

Returns the maximum number of queued control frames that are allowed before the connection is closed. This allows to protected against various attacks that can lead to high CPU / memory usage if the remote-peer floods us with frames that would have us produce control frames, but stops to read from the underlying socket. 0 means no protection is in place.

Annotations

@Override

encoderEnforceMaxQueuedControlFrames back to summary

encoderEnforceMaxQueuedControlFrames	back to summary
public Http2MultiplexCodecBuilder encoderEnforceMaxQueuedControlFrames(int maxQueuedControlFrames) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.encoderEnforceMaxQueuedControlFrames. Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.encoderEnforceMaxQueuedControlFrames. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. See corresponding docs for further information. Sets the maximum number of queued control frames that are allowed before the connection is closed. This allows to protected against various attacks that can lead to high CPU / memory usage if the remote-peer floods us with frames that would have us produce control frames, but stops to read from the underlying socket. `0` means no protection should be applied. Annotations @Override

public Http2MultiplexCodecBuilder encoderEnforceMaxQueuedControlFrames(int maxQueuedControlFrames)

Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.encoderEnforceMaxQueuedControlFrames.

Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.encoderEnforceMaxQueuedControlFrames.

Deprecated

as a consequence of Http2MultiplexCodecBuilder being deprecated. See corresponding docs for further information.

Sets the maximum number of queued control frames that are allowed before the connection is closed. This allows to protected against various attacks that can lead to high CPU / memory usage if the remote-peer floods us with frames that would have us produce control frames, but stops to read from the underlying socket. 0 means no protection should be applied.

Annotations

@Override

encoderIgnoreMaxHeaderListSize back to summary

encoderIgnoreMaxHeaderListSize	back to summary
public Http2MultiplexCodecBuilder encoderIgnoreMaxHeaderListSize(boolean ignoreMaxHeaderListSize) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.encoderIgnoreMaxHeaderListSize. Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.encoderIgnoreMaxHeaderListSize. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. See corresponding docs for further information. Sets if the SETTINGS_MAX_HEADER_LIST_SIZE should be ignored when encoding headers. Parameters ignoreMaxHeaderListSize:boolean `true` to ignore SETTINGS_MAX_HEADER_LIST_SIZE. Returns:Http2MultiplexCodecBuilder this. Annotations @Override

public Http2MultiplexCodecBuilder encoderIgnoreMaxHeaderListSize(boolean ignoreMaxHeaderListSize)

Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.encoderIgnoreMaxHeaderListSize.

Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.encoderIgnoreMaxHeaderListSize.

Deprecated

as a consequence of Http2MultiplexCodecBuilder being deprecated. See corresponding docs for further information.

Sets if the SETTINGS_MAX_HEADER_LIST_SIZE should be ignored when encoding headers.

Parameters

ignoreMaxHeaderListSize:boolean: true to ignore SETTINGS_MAX_HEADER_LIST_SIZE.

Returns:Http2MultiplexCodecBuilder

this.

Annotations

@Override

flushPreface back to summary

flushPreface	back to summary
public Http2MultiplexCodecBuilder flushPreface(boolean flushPreface) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.flushPreface. Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.flushPreface. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. See corresponding docs for further information. Determine if the Preface should be automatically flushed when the `Channel` becomes active or not. Client may choose to opt-out from this automatic behavior and manage flush manually if it's ready to send request frames immediately after the preface. It may help to avoid unnecessary latency. Parameters flushPreface:boolean `true` to automatically flush, `false otherwise`. Returns:Http2MultiplexCodecBuilder `this`. Annotations @Override

public Http2MultiplexCodecBuilder flushPreface(boolean flushPreface)

Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.flushPreface.

Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.flushPreface.

Deprecated

as a consequence of Http2MultiplexCodecBuilder being deprecated. See corresponding docs for further information.

Determine if the Preface should be automatically flushed when the Channel becomes active or not.

Client may choose to opt-out from this automatic behavior and manage flush manually if it's ready to send request frames immediately after the preface. It may help to avoid unnecessary latency.

Parameters

flushPreface:boolean: true to automatically flush, false otherwise.

Returns:Http2MultiplexCodecBuilder

this.

Annotations

@Override

forClient back to summary

forClient	back to summary
public static Http2MultiplexCodecBuilder forClient(ChannelHandler childHandler) Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. See corresponding docs for further information. Creates a builder for an HTTP/2 client. Parameters childHandler:ChannelHandler the handler added to channels for remotely-created streams. It must be `ChannelHandler.Sharable`.

public static Http2MultiplexCodecBuilder forClient(ChannelHandler childHandler)

Deprecated

as a consequence of Http2MultiplexCodecBuilder being deprecated. See corresponding docs for further information.

Creates a builder for an HTTP/2 client.

Parameters

childHandler:ChannelHandler: the handler added to channels for remotely-created streams. It must be ChannelHandler.Sharable.

forServer back to summary

forServer	back to summary
public static Http2MultiplexCodecBuilder forServer(ChannelHandler childHandler) Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. See corresponding docs for further information. Creates a builder for an HTTP/2 server. Parameters childHandler:ChannelHandler the handler added to channels for remotely-created streams. It must be `ChannelHandler.Sharable`.

public static Http2MultiplexCodecBuilder forServer(ChannelHandler childHandler)

Deprecated

as a consequence of Http2MultiplexCodecBuilder being deprecated. See corresponding docs for further information.

Creates a builder for an HTTP/2 server.

Parameters

childHandler:ChannelHandler: the handler added to channels for remotely-created streams. It must be ChannelHandler.Sharable.

frameLogger back to summary

frameLogger	back to summary
public Http2FrameLogger frameLogger() Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.frameLogger. Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.frameLogger. Returns the logger that is used for the encoder and decoder. Returns:Http2FrameLogger `Http2FrameLogger` if set, or `null` if not set. Annotations @Override

public Http2FrameLogger frameLogger()

Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.frameLogger.

Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.frameLogger.

Returns the logger that is used for the encoder and decoder.

Returns:Http2FrameLogger

Http2FrameLogger if set, or null if not set.

Annotations

@Override

frameLogger back to summary

frameLogger	back to summary
public Http2MultiplexCodecBuilder frameLogger(Http2FrameLogger frameLogger) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.frameLogger. Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.frameLogger. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. See corresponding docs for further information. Sets the logger that is used for the encoder and decoder. Annotations @Override

public Http2MultiplexCodecBuilder frameLogger(Http2FrameLogger frameLogger)

Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.frameLogger.

Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.frameLogger.

Deprecated

as a consequence of Http2MultiplexCodecBuilder being deprecated. See corresponding docs for further information.

Sets the logger that is used for the encoder and decoder.

Annotations

@Override

frameWriter	back to summary
pack-priv Http2MultiplexCodecBuilder frameWriter(Http2FrameWriter frameWriter) Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. See corresponding docs for further information.

gracefulShutdownTimeoutMillis back to summary

gracefulShutdownTimeoutMillis	back to summary
public long gracefulShutdownTimeoutMillis() Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.gracefulShutdownTimeoutMillis. Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.gracefulShutdownTimeoutMillis. Returns the graceful shutdown timeout of the `Http2Connection` in milliseconds. Returns -1 if the timeout is indefinite. Annotations @Override

public long gracefulShutdownTimeoutMillis()

Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.gracefulShutdownTimeoutMillis.

Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.gracefulShutdownTimeoutMillis.

Returns the graceful shutdown timeout of the Http2Connection in milliseconds. Returns -1 if the timeout is indefinite.

Annotations

@Override

gracefulShutdownTimeoutMillis back to summary

gracefulShutdownTimeoutMillis	back to summary
public Http2MultiplexCodecBuilder gracefulShutdownTimeoutMillis(long gracefulShutdownTimeoutMillis) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.gracefulShutdownTimeoutMillis. Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.gracefulShutdownTimeoutMillis. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. See corresponding docs for further information. Sets the graceful shutdown timeout of the `Http2Connection` in milliseconds. Annotations @Override

public Http2MultiplexCodecBuilder gracefulShutdownTimeoutMillis(long gracefulShutdownTimeoutMillis)

Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.gracefulShutdownTimeoutMillis.

Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.gracefulShutdownTimeoutMillis.

Deprecated

as a consequence of Http2MultiplexCodecBuilder being deprecated. See corresponding docs for further information.

Sets the graceful shutdown timeout of the Http2Connection in milliseconds.

Annotations

@Override

headerSensitivityDetector back to summary

headerSensitivityDetector	back to summary
public Http2HeadersEncoder.SensitivityDetector headerSensitivityDetector() Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.headerSensitivityDetector. Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.headerSensitivityDetector. Returns the `SensitivityDetector` to use. Annotations @Override

public Http2HeadersEncoder.SensitivityDetector headerSensitivityDetector()

Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.headerSensitivityDetector.

Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.headerSensitivityDetector.

Returns the SensitivityDetector to use.

Annotations

@Override

headerSensitivityDetector back to summary

headerSensitivityDetector	back to summary
public Http2MultiplexCodecBuilder headerSensitivityDetector(Http2HeadersEncoder.SensitivityDetector headerSensitivityDetector) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.headerSensitivityDetector. Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.headerSensitivityDetector. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. See corresponding docs for further information. Sets the `SensitivityDetector` to use. Annotations @Override

public Http2MultiplexCodecBuilder headerSensitivityDetector(Http2HeadersEncoder.SensitivityDetector headerSensitivityDetector)

Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.headerSensitivityDetector.

Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.headerSensitivityDetector.

Deprecated

as a consequence of Http2MultiplexCodecBuilder being deprecated. See corresponding docs for further information.

Sets the SensitivityDetector to use.

Annotations

@Override

initialHuffmanDecodeCapacity	back to summary
public Http2MultiplexCodecBuilder initialHuffmanDecodeCapacity(int initialHuffmanDecodeCapacity) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.initialHuffmanDecodeCapacity. Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.initialHuffmanDecodeCapacity. Deprecated Does nothing, do not call. Annotations @Override @Deprecated

initialHuffmanDecodeCapacity

back to summary

public Http2MultiplexCodecBuilder initialHuffmanDecodeCapacity(int initialHuffmanDecodeCapacity)

Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.initialHuffmanDecodeCapacity.

Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.initialHuffmanDecodeCapacity.

Deprecated

Does nothing, do not call.

Annotations

@Override
@Deprecated

initialSettings back to summary

initialSettings	back to summary
public Http2Settings initialSettings() Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.initialSettings. Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.initialSettings. Sets the `Http2Settings` to use for the initial connection settings exchange. Annotations @Override

public Http2Settings initialSettings()

Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.initialSettings.

Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.initialSettings.

Sets the Http2Settings to use for the initial connection settings exchange.

Annotations

@Override

initialSettings back to summary

initialSettings	back to summary
public Http2MultiplexCodecBuilder initialSettings(Http2Settings settings) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.initialSettings. Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.initialSettings. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. See corresponding docs for further information. Sets the `Http2Settings` to use for the initial connection settings exchange. Annotations @Override

public Http2MultiplexCodecBuilder initialSettings(Http2Settings settings)

Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.initialSettings.

Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.initialSettings.

Deprecated

as a consequence of Http2MultiplexCodecBuilder being deprecated. See corresponding docs for further information.

Sets the Http2Settings to use for the initial connection settings exchange.

Annotations

@Override

isServer back to summary

isServer	back to summary
public boolean isServer() Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.isServer. Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.isServer. Returns if `build()` will to create a `Http2Connection` in server mode (`true`) or client mode (`false`). Annotations @Override

public boolean isServer()

Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.isServer.

Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.isServer.

Returns if build() will to create a Http2Connection in server mode (true) or client mode (false).

Annotations

@Override

isValidateHeaders	back to summary
public boolean isValidateHeaders() Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.isValidateHeaders. Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.isValidateHeaders. Returns if HTTP headers should be validated according to RFC 7540, 8.1.2.6. Annotations @Override

isValidateHeaders

back to summary

public boolean isValidateHeaders()

Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.isValidateHeaders.

Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.isValidateHeaders.

Returns if HTTP headers should be validated according to RFC 7540, 8.1.2.6.

Annotations

@Override

maxReservedStreams	back to summary
public int maxReservedStreams() Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.maxReservedStreams. Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.maxReservedStreams. Get the maximum number of streams which can be in the reserved state at any given time. By default this value will be ignored on the server for local endpoint. This is because the RFC provides no way to explicitly communicate a limit to how many states can be in the reserved state, and instead relies on the peer to send RST_STREAM frames when they will be rejected. Annotations @Override

maxReservedStreams

back to summary

public int maxReservedStreams()

Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.maxReservedStreams.

Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.maxReservedStreams.

Get the maximum number of streams which can be in the reserved state at any given time.

By default this value will be ignored on the server for local endpoint. This is because the RFC provides no way to explicitly communicate a limit to how many states can be in the reserved state, and instead relies on the peer to send RST_STREAM frames when they will be rejected.

Annotations

@Override

maxReservedStreams back to summary

maxReservedStreams	back to summary
public Http2MultiplexCodecBuilder maxReservedStreams(int maxReservedStreams) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.maxReservedStreams. Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.maxReservedStreams. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. See corresponding docs for further information. Set the maximum number of streams which can be in the reserved state at any given time. Annotations @Override

public Http2MultiplexCodecBuilder maxReservedStreams(int maxReservedStreams)

Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.maxReservedStreams.

Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.maxReservedStreams.

Deprecated

as a consequence of Http2MultiplexCodecBuilder being deprecated. See corresponding docs for further information.

Set the maximum number of streams which can be in the reserved state at any given time.

Annotations

@Override

validateHeaders back to summary

validateHeaders	back to summary
public Http2MultiplexCodecBuilder validateHeaders(boolean validateHeaders) Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.validateHeaders. Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.validateHeaders. Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. See corresponding docs for further information. Sets if HTTP headers should be validated according to RFC 7540, 8.1.2.6. Annotations @Override

public Http2MultiplexCodecBuilder validateHeaders(boolean validateHeaders)

Overrides io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.validateHeaders.

Doc from io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder.validateHeaders.

Deprecated

as a consequence of Http2MultiplexCodecBuilder being deprecated. See corresponding docs for further information.

Sets if HTTP headers should be validated according to RFC 7540, 8.1.2.6.

Annotations

@Override

withUpgradeStreamHandler	back to summary
public Http2MultiplexCodecBuilder withUpgradeStreamHandler(ChannelHandler upgradeStreamHandler) Deprecated as a consequence of `Http2MultiplexCodecBuilder` being deprecated. See corresponding docs for further information.

public Class Http2MultiplexCodecBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail