Http2FrameCodecBuilder (Netty API Reference (4.1.115.Final))

java.lang.Object
- io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>
- - io.netty.handler.codec.http2.Http2FrameCodecBuilder

public class Http2FrameCodecBuilder
extends AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>

Builder for the Http2FrameCodec.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Http2FrameCodecBuilder()
Allows overriding behavior of existing builder.

Constructors
Modifier	Constructor and Description
`protected`	`Http2FrameCodecBuilder()` Allows overriding behavior of existing builder.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Http2FrameCodecBuilder`	`autoAckPingFrame(boolean autoAckPingFrame)` Determine if PING frame should automatically be acknowledged or not.
`Http2FrameCodecBuilder`	`autoAckSettingsFrame(boolean autoAckSettings)` Determine if settings frame should automatically be acknowledged and applied.
`Http2FrameCodec`	`build()` Build a `Http2FrameCodec` object.
`protected Http2FrameCodec`	`build(Http2ConnectionDecoder decoder, Http2ConnectionEncoder encoder, Http2Settings initialSettings)` Implement this method to create a new `Http2ConnectionHandler` or its subtype instance.
`int`	`decoderEnforceMaxConsecutiveEmptyDataFrames()` Returns the maximum number of consecutive empty DATA frames (without end_of_stream flag) that are allowed before the connection is closed.
`Http2FrameCodecBuilder`	`decoderEnforceMaxConsecutiveEmptyDataFrames(int maxConsecutiveEmptyFrames)` Sets the maximum number of consecutive empty DATA frames (without end_of_stream flag) that are allowed before the connection is closed.
`Http2FrameCodecBuilder`	`decoderEnforceMaxRstFramesPerWindow(int maxRstFramesPerWindow, int secondsPerWindow)` Sets the maximum number RST frames that are allowed per window before the connection is closed.
`Http2FrameCodecBuilder`	`decoupleCloseAndGoAway(boolean decoupleCloseAndGoAway)` Determine if the `ChannelOutboundInvoker.close()` should be coupled with goaway and graceful close.
`boolean`	`encoderEnforceMaxConcurrentStreams()` Returns if the encoder should queue frames if the maximum number of concurrent streams would otherwise be exceeded.
`Http2FrameCodecBuilder`	`encoderEnforceMaxConcurrentStreams(boolean encoderEnforceMaxConcurrentStreams)` Sets if the encoder should queue frames if the maximum number of concurrent streams would otherwise be exceeded.
`int`	`encoderEnforceMaxQueuedControlFrames()` Returns the maximum number of queued control frames that are allowed before the connection is closed.
`Http2FrameCodecBuilder`	`encoderEnforceMaxQueuedControlFrames(int maxQueuedControlFrames)` Sets the maximum number of queued control frames that are allowed before the connection is closed.
`Http2FrameCodecBuilder`	`encoderIgnoreMaxHeaderListSize(boolean ignoreMaxHeaderListSize)` Sets if the SETTINGS_MAX_HEADER_LIST_SIZE should be ignored when encoding headers.
`Http2FrameCodecBuilder`	`flushPreface(boolean flushPreface)` Determine if the Preface should be automatically flushed when the `Channel` becomes active or not.
`static Http2FrameCodecBuilder`	`forClient()` Creates a builder for an HTTP/2 client.
`static Http2FrameCodecBuilder`	`forServer()` Creates a builder for an HTTP/2 server.
`Http2FrameLogger`	`frameLogger()` Returns the logger that is used for the encoder and decoder.
`Http2FrameCodecBuilder`	`frameLogger(Http2FrameLogger frameLogger)` Sets the logger that is used for the encoder and decoder.
`long`	`gracefulShutdownTimeoutMillis()` Returns the graceful shutdown timeout of the `Http2Connection` in milliseconds.
`Http2FrameCodecBuilder`	`gracefulShutdownTimeoutMillis(long gracefulShutdownTimeoutMillis)` Sets the graceful shutdown timeout of the `Http2Connection` in milliseconds.
`Http2HeadersEncoder.SensitivityDetector`	`headerSensitivityDetector()` Returns the `Http2HeadersEncoder.SensitivityDetector` to use.
`Http2FrameCodecBuilder`	`headerSensitivityDetector(Http2HeadersEncoder.SensitivityDetector headerSensitivityDetector)` Sets the `Http2HeadersEncoder.SensitivityDetector` to use.
`Http2FrameCodecBuilder`	`initialHuffmanDecodeCapacity(int initialHuffmanDecodeCapacity)` Deprecated.
`Http2Settings`	`initialSettings()` Sets the `Http2Settings` to use for the initial connection settings exchange.
`Http2FrameCodecBuilder`	`initialSettings(Http2Settings settings)` Sets the `Http2Settings` to use for the initial connection settings exchange.
`boolean`	`isServer()` Returns if `AbstractHttp2ConnectionHandlerBuilder.build()` will to create a `Http2Connection` in server mode (`true`) or client mode (`false`).
`boolean`	`isValidateHeaders()` Returns if HTTP headers should be validated according to RFC 7540, 8.1.2.6.
`int`	`maxReservedStreams()` Get the maximum number of streams which can be in the reserved state at any given time.
`Http2FrameCodecBuilder`	`maxReservedStreams(int maxReservedStreams)` Set the maximum number of streams which can be in the reserved state at any given time.
`Http2FrameCodecBuilder`	`validateHeaders(boolean validateHeaders)` Sets if HTTP headers should be validated according to RFC 7540, 8.1.2.6.

Methods inherited from class io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder
codec, connection, connection, decoder, decoupleCloseAndGoAway, encoder, flushPreface, frameListener, frameListener, isAutoAckPingFrame, isAutoAckSettingsFrame, promisedRequestVerifier, promisedRequestVerifier, self, server

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Http2FrameCodecBuilder
```
protected Http2FrameCodecBuilder()
```
    Allows overriding behavior of existing builder.
    Users of this constructor are responsible for invoking AbstractHttp2ConnectionHandlerBuilder.server(boolean) method or overriding isServer() method to give the builder information if the Http2Connection(s) it creates are in server or client mode.
    
    See Also:
    
    AbstractHttp2ConnectionHandlerBuilder
- Method Detail
  - forClient
```
public static Http2FrameCodecBuilder forClient()
```
    Creates a builder for an HTTP/2 client.
  - forServer
```
public static Http2FrameCodecBuilder forServer()
```
    Creates a builder for an HTTP/2 server.
  - initialSettings
```
public Http2Settings initialSettings()
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Sets the Http2Settings to use for the initial connection settings exchange.
    
    Overrides:
    
    initialSettings in class AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>
  - initialSettings
```
public Http2FrameCodecBuilder initialSettings(Http2Settings settings)
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Sets the Http2Settings to use for the initial connection settings exchange.
    
    Overrides:
    
    initialSettings in class AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>
  - gracefulShutdownTimeoutMillis
```
public long gracefulShutdownTimeoutMillis()
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Returns the graceful shutdown timeout of the Http2Connection in milliseconds. Returns -1 if the timeout is indefinite.
    
    Overrides:
    
    gracefulShutdownTimeoutMillis in class AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>
  - gracefulShutdownTimeoutMillis
```
public Http2FrameCodecBuilder gracefulShutdownTimeoutMillis(long gracefulShutdownTimeoutMillis)
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Sets the graceful shutdown timeout of the Http2Connection in milliseconds.
    
    Overrides:
    
    gracefulShutdownTimeoutMillis in class AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>
  - isServer
```
public boolean isServer()
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Returns if AbstractHttp2ConnectionHandlerBuilder.build() will to create a Http2Connection in server mode (true) or client mode (false).
    
    Overrides:
    
    isServer in class AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>
  - maxReservedStreams
```
public int maxReservedStreams()
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    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.
    
    Overrides:
    
    maxReservedStreams in class AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>
  - maxReservedStreams
```
public Http2FrameCodecBuilder maxReservedStreams(int maxReservedStreams)
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Set the maximum number of streams which can be in the reserved state at any given time.
    
    Overrides:
    
    maxReservedStreams in class AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>
  - isValidateHeaders
```
public boolean isValidateHeaders()
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Returns if HTTP headers should be validated according to RFC 7540, 8.1.2.6.
    
    Overrides:
    
    isValidateHeaders in class AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>
  - validateHeaders
```
public Http2FrameCodecBuilder validateHeaders(boolean validateHeaders)
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Sets if HTTP headers should be validated according to RFC 7540, 8.1.2.6.
    
    Overrides:
    
    validateHeaders in class AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>
  - frameLogger
```
public Http2FrameLogger frameLogger()
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Returns the logger that is used for the encoder and decoder.
    
    Overrides:
    
    frameLogger in class AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>
    
    Returns:
    
    Http2FrameLogger if set, or null if not set.
  - frameLogger
```
public Http2FrameCodecBuilder frameLogger(Http2FrameLogger frameLogger)
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Sets the logger that is used for the encoder and decoder.
    
    Overrides:
    
    frameLogger in class AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>
  - encoderEnforceMaxConcurrentStreams
```
public boolean encoderEnforceMaxConcurrentStreams()
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Returns if the encoder should queue frames if the maximum number of concurrent streams would otherwise be exceeded.
    
    Overrides:
    
    encoderEnforceMaxConcurrentStreams in class AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>
  - encoderEnforceMaxConcurrentStreams
```
public Http2FrameCodecBuilder encoderEnforceMaxConcurrentStreams(boolean encoderEnforceMaxConcurrentStreams)
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Sets if the encoder should queue frames if the maximum number of concurrent streams would otherwise be exceeded.
    
    Overrides:
    
    encoderEnforceMaxConcurrentStreams in class AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>
  - encoderEnforceMaxQueuedControlFrames
```
public int encoderEnforceMaxQueuedControlFrames()
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    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.
    
    Overrides:
    
    encoderEnforceMaxQueuedControlFrames in class AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>
  - encoderEnforceMaxQueuedControlFrames
```
public Http2FrameCodecBuilder encoderEnforceMaxQueuedControlFrames(int maxQueuedControlFrames)
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    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.
    
    Overrides:
    
    encoderEnforceMaxQueuedControlFrames in class AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>
  - headerSensitivityDetector
```
public Http2HeadersEncoder.SensitivityDetector headerSensitivityDetector()
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Returns the Http2HeadersEncoder.SensitivityDetector to use.
    
    Overrides:
    
    headerSensitivityDetector in class AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>
  - headerSensitivityDetector
```
public Http2FrameCodecBuilder headerSensitivityDetector(Http2HeadersEncoder.SensitivityDetector headerSensitivityDetector)
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Sets the Http2HeadersEncoder.SensitivityDetector to use.
    
    Overrides:
    
    headerSensitivityDetector in class AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>
  - encoderIgnoreMaxHeaderListSize
```
public Http2FrameCodecBuilder encoderIgnoreMaxHeaderListSize(boolean ignoreMaxHeaderListSize)
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Sets if the SETTINGS_MAX_HEADER_LIST_SIZE should be ignored when encoding headers.
    
    Overrides:
    
    encoderIgnoreMaxHeaderListSize in class AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>
    
    Parameters:
    
    ignoreMaxHeaderListSize - true to ignore SETTINGS_MAX_HEADER_LIST_SIZE.
    
    Returns:
    
    this.
  - initialHuffmanDecodeCapacity
```
@Deprecated
public Http2FrameCodecBuilder initialHuffmanDecodeCapacity(int initialHuffmanDecodeCapacity)
```
    Deprecated.
    
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Does nothing, do not call.
    
    Overrides:
    
    initialHuffmanDecodeCapacity in class AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>
  - autoAckSettingsFrame
```
public Http2FrameCodecBuilder autoAckSettingsFrame(boolean autoAckSettings)
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Determine if settings frame should automatically be acknowledged and applied.
    
    Overrides:
    
    autoAckSettingsFrame in class AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>
    
    Returns:
    
    this.
  - autoAckPingFrame
```
public Http2FrameCodecBuilder autoAckPingFrame(boolean autoAckPingFrame)
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Determine if PING frame should automatically be acknowledged or not.
    
    Overrides:
    
    autoAckPingFrame in class AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>
    
    Returns:
    
    this.
  - decoupleCloseAndGoAway
```
public Http2FrameCodecBuilder decoupleCloseAndGoAway(boolean decoupleCloseAndGoAway)
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Determine if the ChannelOutboundInvoker.close() should be coupled with goaway and graceful close.
    
    Overrides:
    
    decoupleCloseAndGoAway in class AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>
    
    Parameters:
    
    decoupleCloseAndGoAway - true to make ChannelOutboundInvoker.close() directly close the underlying transport, and not attempt graceful closure via GOAWAY.
    
    Returns:
    
    this.
  - flushPreface
```
public Http2FrameCodecBuilder flushPreface(boolean flushPreface)
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    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.
    
    Overrides:
    
    flushPreface in class AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>
    
    Parameters:
    
    flushPreface - true to automatically flush, false otherwise.
    
    Returns:
    
    this.
    
    See Also:
    
    HTTP/2 Connection Preface
  - decoderEnforceMaxConsecutiveEmptyDataFrames
```
public int decoderEnforceMaxConsecutiveEmptyDataFrames()
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    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.
    
    Overrides:
    
    decoderEnforceMaxConsecutiveEmptyDataFrames in class AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>
  - decoderEnforceMaxConsecutiveEmptyDataFrames
```
public Http2FrameCodecBuilder decoderEnforceMaxConsecutiveEmptyDataFrames(int maxConsecutiveEmptyFrames)
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    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.
    
    Overrides:
    
    decoderEnforceMaxConsecutiveEmptyDataFrames in class AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>
  - decoderEnforceMaxRstFramesPerWindow
```
public Http2FrameCodecBuilder decoderEnforceMaxRstFramesPerWindow(int maxRstFramesPerWindow,
                                                                  int secondsPerWindow)
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    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.
    
    Overrides:
    
    decoderEnforceMaxRstFramesPerWindow in class AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>
  - build
```
public Http2FrameCodec build()
```
    Build a Http2FrameCodec object.
    
    Overrides:
    
    build in class AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>
  - build
```
protected Http2FrameCodec build(Http2ConnectionDecoder decoder,
                                Http2ConnectionEncoder encoder,
                                Http2Settings initialSettings)
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    Implement this method to create a new Http2ConnectionHandler or its subtype instance.
    The return of this method will be subject to the following:
    - AbstractHttp2ConnectionHandlerBuilder.frameListener(Http2FrameListener) will be set if not already set in the decoder
    - AbstractHttp2ConnectionHandlerBuilder.gracefulShutdownTimeoutMillis(long) will always be set
    Specified by:
    
    build in class AbstractHttp2ConnectionHandlerBuilder<Http2FrameCodec,Http2FrameCodecBuilder>

Class Http2FrameCodecBuilder

Constructor Summary

Method Summary

Methods inherited from class io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder

Methods inherited from class java.lang.Object

Constructor Detail

Http2FrameCodecBuilder

Method Detail

forClient

forServer

initialSettings

initialSettings

gracefulShutdownTimeoutMillis

gracefulShutdownTimeoutMillis

isServer

maxReservedStreams

maxReservedStreams

isValidateHeaders

validateHeaders

frameLogger

frameLogger

encoderEnforceMaxConcurrentStreams

encoderEnforceMaxConcurrentStreams

encoderEnforceMaxQueuedControlFrames

encoderEnforceMaxQueuedControlFrames

headerSensitivityDetector

headerSensitivityDetector

encoderIgnoreMaxHeaderListSize

initialHuffmanDecodeCapacity

autoAckSettingsFrame

autoAckPingFrame

decoupleCloseAndGoAway

flushPreface

decoderEnforceMaxConsecutiveEmptyDataFrames

decoderEnforceMaxConsecutiveEmptyDataFrames

decoderEnforceMaxRstFramesPerWindow

build

build