Http2CodecUtil (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.handler.codec.http2.Http2CodecUtil

@UnstableApi
public final class Http2CodecUtil
extends java.lang.Object

用于编码/解码HTTP2帧的常量和实用方法。

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CONNECTION_STREAM_ID`
`static int`	`CONTINUATION_FRAME_HEADER_LENGTH`
`static int`	`DATA_FRAME_HEADER_LENGTH`
`static long`	`DEFAULT_GRACEFUL_SHUTDOWN_TIMEOUT_MILLIS`
`static long`	`DEFAULT_HEADER_LIST_SIZE` The initial value of this setting is unlimited 。
`static int`	`DEFAULT_HEADER_TABLE_SIZE`
`static int`	`DEFAULT_MAX_FRAME_SIZE`
`static short`	`DEFAULT_PRIORITY_WEIGHT`
`static int`	`DEFAULT_WINDOW_SIZE`
`static int`	`FRAME_HEADER_LENGTH`
`static int`	`GO_AWAY_FRAME_HEADER_LENGTH`
`static int`	`HEADERS_FRAME_HEADER_LENGTH`
`static java.lang.CharSequence`	`HTTP_UPGRADE_PROTOCOL_NAME`
`static java.lang.CharSequence`	`HTTP_UPGRADE_SETTINGS_HEADER`
`static int`	`HTTP_UPGRADE_STREAM_ID`
`static int`	`INT_FIELD_LENGTH`
`static long`	`MAX_CONCURRENT_STREAMS`
`static int`	`MAX_FRAME_SIZE_LOWER_BOUND`
`static int`	`MAX_FRAME_SIZE_UPPER_BOUND`
`static long`	`MAX_HEADER_LIST_SIZE`
`static long`	`MAX_HEADER_TABLE_SIZE`
`static int`	`MAX_INITIAL_WINDOW_SIZE`
`static int`	`MAX_PADDING` 填充字节的最大数量。
`static short`	`MAX_UNSIGNED_BYTE`
`static long`	`MAX_UNSIGNED_INT`
`static short`	`MAX_WEIGHT`
`static long`	`MIN_CONCURRENT_STREAMS`
`static long`	`MIN_HEADER_LIST_SIZE`
`static long`	`MIN_HEADER_TABLE_SIZE`
`static int`	`MIN_INITIAL_WINDOW_SIZE`
`static short`	`MIN_WEIGHT`
`static int`	`NUM_STANDARD_SETTINGS`
`static int`	`PING_FRAME_PAYLOAD_LENGTH`
`static int`	`PRIORITY_ENTRY_LENGTH`
`static int`	`PRIORITY_FRAME_LENGTH`
`static int`	`PUSH_PROMISE_FRAME_HEADER_LENGTH`
`static int`	`RST_STREAM_FRAME_LENGTH`
`static int`	`SETTING_ENTRY_LENGTH`
`static char`	`SETTINGS_ENABLE_PUSH`
`static char`	`SETTINGS_HEADER_TABLE_SIZE`
`static char`	`SETTINGS_INITIAL_WINDOW_SIZE`
`static char`	`SETTINGS_MAX_CONCURRENT_STREAMS`
`static char`	`SETTINGS_MAX_FRAME_SIZE`
`static char`	`SETTINGS_MAX_HEADER_LIST_SIZE`
`static int`	`SMALLEST_MAX_CONCURRENT_STREAMS` `SETTINGS_MAX_CONCURRENT_STREAMS`推荐的 SETTINGS_MAX_CONCURRENT_STREAMS的假定最小值。
`static java.lang.CharSequence`	`TLS_UPGRADE_PROTOCOL_NAME`
`static int`	`WINDOW_UPDATE_FRAME_LENGTH`

方法摘要

所有方法静态方法具体的方法
Modifier and Type	Method and Description
`static long`	`calculateMaxHeaderListSizeGoAway(long maxHeaderListSize)` 计算以字节为单位的阈值，如果一组标题超过这个数量，应该触发 `GO_AWAY` 。
`static ByteBuf`	`connectionPrefaceBuf()` 返回包含 `CONNECTION_PREFACE`的缓冲区。
`static ByteBuf`	`emptyPingBuf()` 返回填充了全部零的缓冲区，这是PING帧的适当长度。
`static Http2Exception`	`getEmbeddedHttp2Exception(java.lang.Throwable cause)` 通过因果关系链迭代查找给定的异常，并返回第一个`Http2Exception`或`null`如果没有）。
`static void`	`headerListSizeExceeded(int streamId, long maxHeaderListSize, boolean onDecode)` `streamId`由于违反 SETTINGS_MAX_HEADER_LIST_SIZE而发送 `streamId` 结果。
`static void`	`headerListSizeExceeded(long maxHeaderListSize)` 由于以不可恢复的方式违反 SETTINGS_MAX_HEADER_LIST_SIZE ，因此发送GO_AWAY结果。
`static boolean`	`isMaxFrameSizeValid(int maxFrameSize)` 指示最大帧大小的给定值是否落在有效范围内。
`static boolean`	`isOutboundStream(boolean server, int streamId)` 如果流是出站流，则返回 `true` 。
`static boolean`	`isStreamIdValid(int streamId)` 如果 `streamId`是有效的HTTP / 2流标识符，则返回true。
`static int`	`readUnsignedInt(ByteBuf buf)` 从缓冲区读取一个大端（31位）整数。
`static int`	`streamableBytes(StreamByteDistributor.StreamState state)` 计算可由 `state`发送的字节 `state` 。
`static ByteBuf`	`toByteBuf(ChannelHandlerContext ctx, java.lang.Throwable cause)` 创建一个包含来自给定异常的错误消息的缓冲区。
`static void`	`verifyPadding(int padding)`
`static void`	`writeFrameHeader(ByteBuf out, int payloadLength, byte type, Http2Flags flags, int streamId)` 将HTTP / 2帧头写入输出缓冲区。

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

- 字段详细信息
  - CONNECTION_STREAM_ID
```
public static final int CONNECTION_STREAM_ID
```
    另请参见：
    
    Constant Field Values
  - HTTP_UPGRADE_STREAM_ID
```
public static final int HTTP_UPGRADE_STREAM_ID
```
    另请参见：
    
    Constant Field Values
  - HTTP_UPGRADE_SETTINGS_HEADER
```
public static final java.lang.CharSequence HTTP_UPGRADE_SETTINGS_HEADER
```
  - HTTP_UPGRADE_PROTOCOL_NAME
```
public static final java.lang.CharSequence HTTP_UPGRADE_PROTOCOL_NAME
```
  - TLS_UPGRADE_PROTOCOL_NAME
```
public static final java.lang.CharSequence TLS_UPGRADE_PROTOCOL_NAME
```
  - PING_FRAME_PAYLOAD_LENGTH
```
public static final int PING_FRAME_PAYLOAD_LENGTH
```
    另请参见：
    
    Constant Field Values
  - MAX_UNSIGNED_BYTE
```
public static final short MAX_UNSIGNED_BYTE
```
    另请参见：
    
    Constant Field Values
  - MAX_PADDING
```
public static final int MAX_PADDING
```
    填充字节的最大数量。这是255个填充字节附加到一个帧的结尾和1个字节的焊盘长度字段。
    
    另请参见：
    
    Constant Field Values
  - MAX_UNSIGNED_INT
```
public static final long MAX_UNSIGNED_INT
```
    另请参见：
    
    Constant Field Values
  - FRAME_HEADER_LENGTH
```
public static final int FRAME_HEADER_LENGTH
```
    另请参见：
    
    Constant Field Values
  - SETTING_ENTRY_LENGTH
```
public static final int SETTING_ENTRY_LENGTH
```
    另请参见：
    
    Constant Field Values
  - PRIORITY_ENTRY_LENGTH
```
public static final int PRIORITY_ENTRY_LENGTH
```
    另请参见：
    
    Constant Field Values
  - INT_FIELD_LENGTH
```
public static final int INT_FIELD_LENGTH
```
    另请参见：
    
    Constant Field Values
  - MAX_WEIGHT
```
public static final short MAX_WEIGHT
```
    另请参见：
    
    Constant Field Values
  - MIN_WEIGHT
```
public static final short MIN_WEIGHT
```
    另请参见：
    
    Constant Field Values
  - DATA_FRAME_HEADER_LENGTH
```
public static final int DATA_FRAME_HEADER_LENGTH
```
    另请参见：
    
    Constant Field Values
  - HEADERS_FRAME_HEADER_LENGTH
```
public static final int HEADERS_FRAME_HEADER_LENGTH
```
    另请参见：
    
    Constant Field Values
  - PRIORITY_FRAME_LENGTH
```
public static final int PRIORITY_FRAME_LENGTH
```
    另请参见：
    
    Constant Field Values
  - RST_STREAM_FRAME_LENGTH
```
public static final int RST_STREAM_FRAME_LENGTH
```
    另请参见：
    
    Constant Field Values
  - PUSH_PROMISE_FRAME_HEADER_LENGTH
```
public static final int PUSH_PROMISE_FRAME_HEADER_LENGTH
```
    另请参见：
    
    Constant Field Values
  - GO_AWAY_FRAME_HEADER_LENGTH
```
public static final int GO_AWAY_FRAME_HEADER_LENGTH
```
    另请参见：
    
    Constant Field Values
  - WINDOW_UPDATE_FRAME_LENGTH
```
public static final int WINDOW_UPDATE_FRAME_LENGTH
```
    另请参见：
    
    Constant Field Values
  - CONTINUATION_FRAME_HEADER_LENGTH
```
public static final int CONTINUATION_FRAME_HEADER_LENGTH
```
    另请参见：
    
    Constant Field Values
  - SETTINGS_HEADER_TABLE_SIZE
```
public static final char SETTINGS_HEADER_TABLE_SIZE
```
    另请参见：
    
    Constant Field Values
  - SETTINGS_ENABLE_PUSH
```
public static final char SETTINGS_ENABLE_PUSH
```
    另请参见：
    
    Constant Field Values
  - SETTINGS_MAX_CONCURRENT_STREAMS
```
public static final char SETTINGS_MAX_CONCURRENT_STREAMS
```
    另请参见：
    
    Constant Field Values
  - SETTINGS_INITIAL_WINDOW_SIZE
```
public static final char SETTINGS_INITIAL_WINDOW_SIZE
```
    另请参见：
    
    Constant Field Values
  - SETTINGS_MAX_FRAME_SIZE
```
public static final char SETTINGS_MAX_FRAME_SIZE
```
    另请参见：
    
    Constant Field Values
  - SETTINGS_MAX_HEADER_LIST_SIZE
```
public static final char SETTINGS_MAX_HEADER_LIST_SIZE
```
    另请参见：
    
    Constant Field Values
  - NUM_STANDARD_SETTINGS
```
public static final int NUM_STANDARD_SETTINGS
```
    另请参见：
    
    Constant Field Values
  - MAX_HEADER_TABLE_SIZE
```
public static final long MAX_HEADER_TABLE_SIZE
```
    另请参见：
    
    Constant Field Values
  - MAX_CONCURRENT_STREAMS
```
public static final long MAX_CONCURRENT_STREAMS
```
    另请参见：
    
    Constant Field Values
  - MAX_INITIAL_WINDOW_SIZE
```
public static final int MAX_INITIAL_WINDOW_SIZE
```
    另请参见：
    
    Constant Field Values
  - MAX_FRAME_SIZE_LOWER_BOUND
```
public static final int MAX_FRAME_SIZE_LOWER_BOUND
```
    另请参见：
    
    Constant Field Values
  - MAX_FRAME_SIZE_UPPER_BOUND
```
public static final int MAX_FRAME_SIZE_UPPER_BOUND
```
    另请参见：
    
    Constant Field Values
  - MAX_HEADER_LIST_SIZE
```
public static final long MAX_HEADER_LIST_SIZE
```
    另请参见：
    
    Constant Field Values
  - MIN_HEADER_TABLE_SIZE
```
public static final long MIN_HEADER_TABLE_SIZE
```
    另请参见：
    
    Constant Field Values
  - MIN_CONCURRENT_STREAMS
```
public static final long MIN_CONCURRENT_STREAMS
```
    另请参见：
    
    Constant Field Values
  - MIN_INITIAL_WINDOW_SIZE
```
public static final int MIN_INITIAL_WINDOW_SIZE
```
    另请参见：
    
    Constant Field Values
  - MIN_HEADER_LIST_SIZE
```
public static final long MIN_HEADER_LIST_SIZE
```
    另请参见：
    
    Constant Field Values
  - DEFAULT_WINDOW_SIZE
```
public static final int DEFAULT_WINDOW_SIZE
```
    另请参见：
    
    Constant Field Values
  - DEFAULT_PRIORITY_WEIGHT
```
public static final short DEFAULT_PRIORITY_WEIGHT
```
    另请参见：
    
    Constant Field Values
  - DEFAULT_HEADER_TABLE_SIZE
```
public static final int DEFAULT_HEADER_TABLE_SIZE
```
    另请参见：
    
    Constant Field Values
  - DEFAULT_HEADER_LIST_SIZE
```
public static final long DEFAULT_HEADER_LIST_SIZE
```
    The initial value of this setting is unlimited 。但是在实践中，我们不希望让我们的同伴默认使用无限制的内存。所以我们利用了对于任何给定的请求，可能会强制实施一个比所宣传的更低的限制。漏洞。
    
    另请参见：
    
    Constant Field Values
  - DEFAULT_MAX_FRAME_SIZE
```
public static final int DEFAULT_MAX_FRAME_SIZE
```
    另请参见：
    
    Constant Field Values
  - SMALLEST_MAX_CONCURRENT_STREAMS
```
public static final int SMALLEST_MAX_CONCURRENT_STREAMS
```
    SETTINGS_MAX_CONCURRENT_STREAMS推荐的假设最小值 SETTINGS_MAX_CONCURRENT_STREAMS 。
    
    另请参见：
    
    Constant Field Values
  - DEFAULT_GRACEFUL_SHUTDOWN_TIMEOUT_MILLIS
```
public static final long DEFAULT_GRACEFUL_SHUTDOWN_TIMEOUT_MILLIS
```
- 方法详细信息
  - calculateMaxHeaderListSizeGoAway
```
public static long calculateMaxHeaderListSizeGoAway(long maxHeaderListSize)
```
    计算应该触发 GO_AWAY字节的阈值，如果一组标题超过了这个数量。
    
    参数
    
    maxHeaderListSize - SETTINGS_MAX_HEADER_LIST_SIZE为本地端点。
    
    结果
    
    以字节为单位的阈值，如果一组标题超过了这个数量，应该触发 GO_AWAY 。
  - isOutboundStream
```
public static boolean isOutboundStream(boolean server,
                                       int streamId)
```
    如果流是出站流，则返回 true 。
    
    参数
    
    server - true如果端点是服务器， false否则。
    
    streamId - 流标识符
  - isStreamIdValid
```
public static boolean isStreamIdValid(int streamId)
```
    如果 streamId是有效的HTTP / 2流标识符，则返回true。
  - isMaxFrameSizeValid
```
public static boolean isMaxFrameSizeValid(int maxFrameSize)
```
    指示最大帧大小的给定值是否落在有效范围内。
  - connectionPrefaceBuf
```
public static ByteBuf connectionPrefaceBuf()
```
    返回包含 CONNECTION_PREFACE的缓冲区。
  - emptyPingBuf
```
public static ByteBuf emptyPingBuf()
```
    返回填充了全部零的缓冲区，这是PING帧的适当长度。
  - getEmbeddedHttp2Exception
```
public static Http2Exception getEmbeddedHttp2Exception(java.lang.Throwable cause)
```
    通过因果关系链迭代查找给定的异常，并返回第一个Http2Exception或null如果没有）。
  - toByteBuf
```
public static ByteBuf toByteBuf(ChannelHandlerContext ctx,
                                java.lang.Throwable cause)
```
    创建一个包含来自给定异常的错误消息的缓冲区。如果原因是null返回一个空的缓冲区。
  - readUnsignedInt
```
public static int readUnsignedInt(ByteBuf buf)
```
    从缓冲区读取一个大端（31位）整数。
  - writeFrameHeader
```
public static void writeFrameHeader(ByteBuf out,
                                    int payloadLength,
                                    byte type,
                                    Http2Flags flags,
                                    int streamId)
```
    将HTTP / 2帧头写入输出缓冲区。
  - streamableBytes
```
public static int streamableBytes(StreamByteDistributor.StreamState state)
```
    计算可由state发送的字节state 。下限是0 。
  - headerListSizeExceeded
```
public static void headerListSizeExceeded(int streamId,
                                          long maxHeaderListSize,
                                          boolean onDecode)
                                   throws Http2Exception
```
    由于违反 SETTINGS_MAX_HEADER_LIST_SIZE ， streamId结果为 streamId 。
    
    参数
    
    streamId - 发生特殊情况时正在处理的流ID。
    
    maxHeaderListSize - 已超出的字节列表的最大允许大小。
    
    onDecode - true如果解码器遇到异常。 false用于编码。
    
    异常
    
    Http2Exception - 流错误。
  - headerListSizeExceeded
```
public static void headerListSizeExceeded(long maxHeaderListSize)
                                   throws Http2Exception
```
    由于以不可恢复的方式违反 SETTINGS_MAX_HEADER_LIST_SIZE ，因此发送 GO_AWAY中的结果。
    
    参数
    
    maxHeaderListSize - 已超过的字节列表的最大允许大小。
    
    异常
    
    Http2Exception - 连接错误。
  - verifyPadding
```
public static void verifyPadding(int padding)
```

Class Http2CodecUtil

Field Summary

方法摘要

Methods inherited from class java.lang.Object

字段详细信息

CONNECTION_STREAM_ID

HTTP_UPGRADE_STREAM_ID

HTTP_UPGRADE_SETTINGS_HEADER

HTTP_UPGRADE_PROTOCOL_NAME

TLS_UPGRADE_PROTOCOL_NAME

PING_FRAME_PAYLOAD_LENGTH

MAX_UNSIGNED_BYTE

MAX_PADDING

MAX_UNSIGNED_INT

FRAME_HEADER_LENGTH

SETTING_ENTRY_LENGTH

PRIORITY_ENTRY_LENGTH

INT_FIELD_LENGTH

MAX_WEIGHT

MIN_WEIGHT

DATA_FRAME_HEADER_LENGTH

HEADERS_FRAME_HEADER_LENGTH

PRIORITY_FRAME_LENGTH

RST_STREAM_FRAME_LENGTH

PUSH_PROMISE_FRAME_HEADER_LENGTH

GO_AWAY_FRAME_HEADER_LENGTH

WINDOW_UPDATE_FRAME_LENGTH

CONTINUATION_FRAME_HEADER_LENGTH

SETTINGS_HEADER_TABLE_SIZE

SETTINGS_ENABLE_PUSH

SETTINGS_MAX_CONCURRENT_STREAMS

SETTINGS_INITIAL_WINDOW_SIZE

SETTINGS_MAX_FRAME_SIZE

SETTINGS_MAX_HEADER_LIST_SIZE

NUM_STANDARD_SETTINGS

MAX_HEADER_TABLE_SIZE

MAX_CONCURRENT_STREAMS

MAX_INITIAL_WINDOW_SIZE

MAX_FRAME_SIZE_LOWER_BOUND

MAX_FRAME_SIZE_UPPER_BOUND

MAX_HEADER_LIST_SIZE

MIN_HEADER_TABLE_SIZE

MIN_CONCURRENT_STREAMS

MIN_INITIAL_WINDOW_SIZE

MIN_HEADER_LIST_SIZE

DEFAULT_WINDOW_SIZE

DEFAULT_PRIORITY_WEIGHT

DEFAULT_HEADER_TABLE_SIZE

DEFAULT_HEADER_LIST_SIZE

DEFAULT_MAX_FRAME_SIZE

SMALLEST_MAX_CONCURRENT_STREAMS

DEFAULT_GRACEFUL_SHUTDOWN_TIMEOUT_MILLIS

方法详细信息

calculateMaxHeaderListSizeGoAway

isOutboundStream

isStreamIdValid

isMaxFrameSizeValid

connectionPrefaceBuf

emptyPingBuf

getEmbeddedHttp2Exception

toByteBuf

readUnsignedInt

writeFrameHeader

streamableBytes

headerListSizeExceeded

headerListSizeExceeded

verifyPadding