Http2ConnectionHandlerBuilder (Netty API Reference (4.1.128.Final))

java.lang.Object
- io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder<Http2ConnectionHandler,Http2ConnectionHandlerBuilder>
- - io.netty.handler.codec.http2.Http2ConnectionHandlerBuilder

public final class Http2ConnectionHandlerBuilder
extends AbstractHttp2ConnectionHandlerBuilder<Http2ConnectionHandler,Http2ConnectionHandlerBuilder>

Builder which builds Http2ConnectionHandler objects.

Constructor Summary

Constructors
Constructor and Description

Http2ConnectionHandlerBuilder()

Constructors
Constructor and Description
`Http2ConnectionHandlerBuilder()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Http2ConnectionHandler`	`build()` Create a new `Http2ConnectionHandler`.
`protected Http2ConnectionHandler`	`build(Http2ConnectionDecoder decoder, Http2ConnectionEncoder encoder, Http2Settings initialSettings)` Implement this method to create a new `Http2ConnectionHandler` or its subtype instance.
`Http2ConnectionHandlerBuilder`	`codec(Http2ConnectionDecoder decoder, Http2ConnectionEncoder encoder)` Sets the `Http2ConnectionDecoder` and `Http2ConnectionEncoder` to use.
`Http2ConnectionHandlerBuilder`	`connection(Http2Connection connection)` Sets the `Http2Connection` to use.
`int`	`decoderEnforceMaxConsecutiveEmptyDataFrames()` Returns the maximum number of consecutive empty DATA frames (without end_of_stream flag) that are allowed before the connection is closed.
`Http2ConnectionHandlerBuilder`	`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.
`Http2ConnectionHandlerBuilder`	`decoderEnforceMaxRstFramesPerWindow(int maxRstFramesPerWindow, int secondsPerWindow)` Sets the maximum number RST frames that are allowed per window before the connection is closed.
`Http2ConnectionHandlerBuilder`	`decoupleCloseAndGoAway(boolean decoupleCloseAndGoAway)` Determine if the `ChannelOutboundInvoker.close()` should be coupled with goaway and graceful close.
`Http2ConnectionHandlerBuilder`	`encoderEnforceMaxConcurrentStreams(boolean encoderEnforceMaxConcurrentStreams)` Sets if the encoder should queue frames if the maximum number of concurrent streams would otherwise be exceeded.
`Http2ConnectionHandlerBuilder`	`encoderEnforceMaxRstFramesPerWindow(int maxRstFramesPerWindow, int secondsPerWindow)` Sets the maximum number RST frames that are allowed per window before the connection is closed.
`Http2ConnectionHandlerBuilder`	`encoderIgnoreMaxHeaderListSize(boolean encoderIgnoreMaxHeaderListSize)` Sets if the SETTINGS_MAX_HEADER_LIST_SIZE should be ignored when encoding headers.
`Http2ConnectionHandlerBuilder`	`flushPreface(boolean flushPreface)` Determine if the Preface should be automatically flushed when the `Channel` becomes active or not.
`Http2ConnectionHandlerBuilder`	`frameListener(Http2FrameListener frameListener)` Sets the listener of inbound frames.
`Http2ConnectionHandlerBuilder`	`frameLogger(Http2FrameLogger frameLogger)` Sets the logger that is used for the encoder and decoder.
`Http2ConnectionHandlerBuilder`	`gracefulShutdownTimeoutMillis(long gracefulShutdownTimeoutMillis)` Sets the graceful shutdown timeout of the `Http2Connection` in milliseconds.
`Http2ConnectionHandlerBuilder`	`headerSensitivityDetector(Http2HeadersEncoder.SensitivityDetector headerSensitivityDetector)` Sets the `Http2HeadersEncoder.SensitivityDetector` to use.
`Http2ConnectionHandlerBuilder`	`initialHuffmanDecodeCapacity(int initialHuffmanDecodeCapacity)` Deprecated.
`Http2Settings`	`initialSettings()` Sets the `Http2Settings` to use for the initial connection settings exchange.
`Http2ConnectionHandlerBuilder`	`initialSettings(Http2Settings settings)` Sets the `Http2Settings` to use for the initial connection settings exchange.
`Http2ConnectionHandlerBuilder`	`maxReservedStreams(int maxReservedStreams)` Set the maximum number of streams which can be in the reserved state at any given time.
`Http2ConnectionHandlerBuilder`	`server(boolean isServer)` Sets if `AbstractHttp2ConnectionHandlerBuilder.build()` will to create a `Http2Connection` in server mode (`true`) or client mode (`false`).
`Http2ConnectionHandlerBuilder`	`validateHeaders(boolean validateHeaders)` Sets if HTTP headers should be validated according to RFC 7540, 8.1.2.6.

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

- Constructor Detail
  - Http2ConnectionHandlerBuilder
```
public Http2ConnectionHandlerBuilder()
```
- Method Detail
  - validateHeaders
```
public Http2ConnectionHandlerBuilder 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<Http2ConnectionHandler,Http2ConnectionHandlerBuilder>
  - initialSettings
```
public Http2ConnectionHandlerBuilder initialSettings(Http2Settings settings)
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Sets the Http2Settings to use for the initial connection settings exchange.
    
    Overrides:
    
    initialSettings in class AbstractHttp2ConnectionHandlerBuilder<Http2ConnectionHandler,Http2ConnectionHandlerBuilder>
  - 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<Http2ConnectionHandler,Http2ConnectionHandlerBuilder>
  - frameListener
```
public Http2ConnectionHandlerBuilder frameListener(Http2FrameListener frameListener)
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Sets the listener of inbound frames. This listener will only be set if the decoder's listener is null.
    
    Overrides:
    
    frameListener in class AbstractHttp2ConnectionHandlerBuilder<Http2ConnectionHandler,Http2ConnectionHandlerBuilder>
  - gracefulShutdownTimeoutMillis
```
public Http2ConnectionHandlerBuilder gracefulShutdownTimeoutMillis(long gracefulShutdownTimeoutMillis)
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Sets the graceful shutdown timeout of the Http2Connection in milliseconds.
    
    Overrides:
    
    gracefulShutdownTimeoutMillis in class AbstractHttp2ConnectionHandlerBuilder<Http2ConnectionHandler,Http2ConnectionHandlerBuilder>
  - server
```
public Http2ConnectionHandlerBuilder server(boolean isServer)
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Sets if AbstractHttp2ConnectionHandlerBuilder.build() will to create a Http2Connection in server mode (true) or client mode (false).
    
    Overrides:
    
    server in class AbstractHttp2ConnectionHandlerBuilder<Http2ConnectionHandler,Http2ConnectionHandlerBuilder>
  - connection
```
public Http2ConnectionHandlerBuilder connection(Http2Connection connection)
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Sets the Http2Connection to use.
    
    Overrides:
    
    connection in class AbstractHttp2ConnectionHandlerBuilder<Http2ConnectionHandler,Http2ConnectionHandlerBuilder>
  - maxReservedStreams
```
public Http2ConnectionHandlerBuilder 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<Http2ConnectionHandler,Http2ConnectionHandlerBuilder>
  - codec
```
public Http2ConnectionHandlerBuilder codec(Http2ConnectionDecoder decoder,
                                           Http2ConnectionEncoder encoder)
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Sets the Http2ConnectionDecoder and Http2ConnectionEncoder to use.
    
    Overrides:
    
    codec in class AbstractHttp2ConnectionHandlerBuilder<Http2ConnectionHandler,Http2ConnectionHandlerBuilder>
  - frameLogger
```
public Http2ConnectionHandlerBuilder frameLogger(Http2FrameLogger frameLogger)
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Sets the logger that is used for the encoder and decoder.
    
    Overrides:
    
    frameLogger in class AbstractHttp2ConnectionHandlerBuilder<Http2ConnectionHandler,Http2ConnectionHandlerBuilder>
  - encoderEnforceMaxConcurrentStreams
```
public Http2ConnectionHandlerBuilder 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<Http2ConnectionHandler,Http2ConnectionHandlerBuilder>
  - encoderIgnoreMaxHeaderListSize
```
public Http2ConnectionHandlerBuilder encoderIgnoreMaxHeaderListSize(boolean encoderIgnoreMaxHeaderListSize)
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Sets if the SETTINGS_MAX_HEADER_LIST_SIZE should be ignored when encoding headers.
    
    Overrides:
    
    encoderIgnoreMaxHeaderListSize in class AbstractHttp2ConnectionHandlerBuilder<Http2ConnectionHandler,Http2ConnectionHandlerBuilder>
    
    Parameters:
    
    encoderIgnoreMaxHeaderListSize - true to ignore SETTINGS_MAX_HEADER_LIST_SIZE.
    
    Returns:
    
    this.
  - headerSensitivityDetector
```
public Http2ConnectionHandlerBuilder headerSensitivityDetector(Http2HeadersEncoder.SensitivityDetector headerSensitivityDetector)
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Sets the Http2HeadersEncoder.SensitivityDetector to use.
    
    Overrides:
    
    headerSensitivityDetector in class AbstractHttp2ConnectionHandlerBuilder<Http2ConnectionHandler,Http2ConnectionHandlerBuilder>
  - initialHuffmanDecodeCapacity
```
@Deprecated
public Http2ConnectionHandlerBuilder initialHuffmanDecodeCapacity(int initialHuffmanDecodeCapacity)
```
    Deprecated.
    
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Does nothing, do not call.
    
    Overrides:
    
    initialHuffmanDecodeCapacity in class AbstractHttp2ConnectionHandlerBuilder<Http2ConnectionHandler,Http2ConnectionHandlerBuilder>
  - decoupleCloseAndGoAway
```
public Http2ConnectionHandlerBuilder 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<Http2ConnectionHandler,Http2ConnectionHandlerBuilder>
    
    Parameters:
    
    decoupleCloseAndGoAway - true to make ChannelOutboundInvoker.close() directly close the underlying transport, and not attempt graceful closure via GOAWAY.
    
    Returns:
    
    this.
  - flushPreface
```
public Http2ConnectionHandlerBuilder 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<Http2ConnectionHandler,Http2ConnectionHandlerBuilder>
    
    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<Http2ConnectionHandler,Http2ConnectionHandlerBuilder>
  - decoderEnforceMaxConsecutiveEmptyDataFrames
```
public Http2ConnectionHandlerBuilder 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<Http2ConnectionHandler,Http2ConnectionHandlerBuilder>
  - decoderEnforceMaxRstFramesPerWindow
```
public Http2ConnectionHandlerBuilder 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<Http2ConnectionHandler,Http2ConnectionHandlerBuilder>
  - encoderEnforceMaxRstFramesPerWindow
```
public Http2ConnectionHandlerBuilder encoderEnforceMaxRstFramesPerWindow(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 that will trigger us to generate a flood of RST frames and so use up a lot of CPU. 0 for any of the parameters means no protection should be applied.
    
    Overrides:
    
    encoderEnforceMaxRstFramesPerWindow in class AbstractHttp2ConnectionHandlerBuilder<Http2ConnectionHandler,Http2ConnectionHandlerBuilder>
  - build
```
public Http2ConnectionHandler build()
```
    Description copied from class: AbstractHttp2ConnectionHandlerBuilder
    
    Create a new Http2ConnectionHandler.
    
    Overrides:
    
    build in class AbstractHttp2ConnectionHandlerBuilder<Http2ConnectionHandler,Http2ConnectionHandlerBuilder>
  - build
```
protected Http2ConnectionHandler 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<Http2ConnectionHandler,Http2ConnectionHandlerBuilder>

Class Http2ConnectionHandlerBuilder

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

Http2ConnectionHandlerBuilder

Method Detail

validateHeaders

initialSettings

initialSettings

frameListener

gracefulShutdownTimeoutMillis

server

connection

maxReservedStreams

codec

frameLogger

encoderEnforceMaxConcurrentStreams

encoderIgnoreMaxHeaderListSize

headerSensitivityDetector

initialHuffmanDecodeCapacity

decoupleCloseAndGoAway

flushPreface

decoderEnforceMaxConsecutiveEmptyDataFrames

decoderEnforceMaxConsecutiveEmptyDataFrames

decoderEnforceMaxRstFramesPerWindow

encoderEnforceMaxRstFramesPerWindow

build

build