http2.createServer([options][, onRequestHandler])

• options <Object>

  • maxDeflateDynamicTableSize <number> 设置用于压缩标头字段的最大动态表大小。默认值：4Kib。

    ¥maxDeflateDynamicTableSize <number> Sets the maximum dynamic table size for deflating header fields. Default: 4Kib.

  • maxSettings <number> 设置每 SETTINGS 帧的最大设置条目数。允许的最小值为 1。默认值：32。

    ¥maxSettings <number> Sets the maximum number of settings entries per SETTINGS frame. The minimum value allowed is 1. Default: 32.

  • maxSessionMemory <number> 设置允许 Http2Session 使用的最大内存。该值以兆字节数表示，例如 1 等于 1 兆字节。允许的最小值为 1。这是一个基于信用的限制，现有的 Http2Stream 可能会导致超过此限制，但新的 Http2Stream 实例将在超过此限制时被拒绝。当前 Http2Stream 会话数、标头压缩表的当前内存使用、当前排队等待发送的数据以及未确认的 PING 和 SETTINGS 帧都计入当前限制。默认值：10。

    ¥maxSessionMemory<number> Sets the maximum memory that the Http2Session is permitted to use. The value is expressed in terms of number of megabytes, e.g. 1 equal 1 megabyte. The minimum value allowed is 1. This is a credit based limit, existing Http2Streams may cause this limit to be exceeded, but new Http2Stream instances will be rejected while this limit is exceeded. The current number of Http2Stream sessions, the current memory use of the header compression tables, current data queued to be sent, and unacknowledged PING and SETTINGS frames are all counted towards the current limit. Default: 10.

  • maxHeaderListPairs <number> 设置标头条目的最大数量。这类似于 node:http 模块中的 server.maxHeadersCount 或 request.maxHeadersCount。最小值为 4。默认值：128。

    ¥maxHeaderListPairs <number> Sets the maximum number of header entries. This is similar to server.maxHeadersCount or request.maxHeadersCount in the node:http module. The minimum value is 4. Default: 128.

  • maxOutstandingPings <number> 设置未确认的未确认 ping 的最大数量。默认值：10。

    ¥maxOutstandingPings <number> Sets the maximum number of outstanding, unacknowledged pings. Default: 10.

  • maxSendHeaderBlockLength <number> 设置序列化的、压缩的标头块的最大允许大小。尝试发送超出此限制的标头将导致触发 'frameError' 事件并且流被关闭和销毁。虽然这将最大允许大小设置为整个标头块，但 nghttp2（内部 http2 库）对每个解压缩的键/值对都有 65536 的限制。

    ¥maxSendHeaderBlockLength <number> Sets the maximum allowed size for a serialized, compressed block of headers. Attempts to send headers that exceed this limit will result in a 'frameError' event being emitted and the stream being closed and destroyed. While this sets the maximum allowed size to the entire block of headers, nghttp2 (the internal http2 library) has a limit of 65536 for each decompressed key/value pair.

  • paddingStrategy <number> 用于确定用于 HEADERS 和 DATA 帧的填充量的策略。默认值：http2.constants.PADDING_STRATEGY_NONE。值可能是以下之一：

    ¥paddingStrategy <number> The strategy used for determining the amount of padding to use for HEADERS and DATA frames. Default: http2.constants.PADDING_STRATEGY_NONE. Value may be one of:

    • http2.constants.PADDING_STRATEGY_NONE：没有应用填充。

      ¥http2.constants.PADDING_STRATEGY_NONE: No padding is applied.

    • http2.constants.PADDING_STRATEGY_MAX：应用由内部实现决定的最大填充量。

      ¥http2.constants.PADDING_STRATEGY_MAX: The maximum amount of padding, determined by the internal implementation, is applied.

    • http2.constants.PADDING_STRATEGY_ALIGNED：尝试应用足够的填充以确保包括 9 字节标头在内的总帧长度是 8 的倍数。对于每一帧，有一个由当前流控制状态和设置决定的最大允许填充字节数。如果此最大值小于确保对齐所需的计算量，则使用最大值，并且总帧长度不一定按 8 字节对齐。

      ¥http2.constants.PADDING_STRATEGY_ALIGNED: Attempts to apply enough padding to ensure that the total frame length, including the 9-byte header, is a multiple of 8. For each frame, there is a maximum allowed number of padding bytes that is determined by current flow control state and settings. If this maximum is less than the calculated amount needed to ensure alignment, the maximum is used and the total frame length is not necessarily aligned at 8 bytes.

  • peerMaxConcurrentStreams <number> 设置远程对等方的最大并发流数，就好像已收到 SETTINGS 帧一样。如果远程对等方为 maxConcurrentStreams 设置了自己的值，则将被覆盖。默认值：100。

    ¥peerMaxConcurrentStreams <number> Sets the maximum number of concurrent streams for the remote peer as if a SETTINGS frame had been received. Will be overridden if the remote peer sets its own value for maxConcurrentStreams. Default: 100.

  • maxSessionInvalidFrames <integer> 设置会话关闭前允许的最大无效帧数。默认值：1000。

    ¥maxSessionInvalidFrames <integer> Sets the maximum number of invalid frames that will be tolerated before the session is closed. Default: 1000.

  • maxSessionRejectedStreams <integer> 设置会话关闭前允许的创建流拒绝的最大数量。每个拒绝都与 NGHTTP2_ENHANCE_YOUR_CALM 错误相关联，该错误应该告诉对等方不要再打开任何流，因此继续打开流被视为行为不端的对等方的标志。默认值：100。

    ¥maxSessionRejectedStreams <integer> Sets the maximum number of rejected upon creation streams that will be tolerated before the session is closed. Each rejection is associated with an NGHTTP2_ENHANCE_YOUR_CALM error that should tell the peer to not open any more streams, continuing to open streams is therefore regarded as a sign of a misbehaving peer. Default: 100.

  • settings <HTTP/2 Settings Object> 连接时发送到远程对等方的初始设置。

    ¥settings <HTTP/2 Settings Object> The initial settings to send to the remote peer upon connection.

  • remoteCustomSettings <Array> 整数值数组确定设置类型，这些类型包含在接收到的远程设置的 CustomSettings 属性中。有关允许的设置类型的更多信息，请参阅 Http2Settings 对象的 CustomSettings 属性。

    ¥remoteCustomSettings <Array> The array of integer values determines the settings types, which are included in the CustomSettings-property of the received remoteSettings. Please see the CustomSettings-property of the Http2Settings object for more information, on the allowed setting types.

  • Http1IncomingMessage <http.IncomingMessage> 指定用于 HTTP/1 回退的 IncomingMessage 类。用于扩展原始的 http.IncomingMessage。默认值：http.IncomingMessage。

    ¥Http1IncomingMessage <http.IncomingMessage> Specifies the IncomingMessage class to used for HTTP/1 fallback. Useful for extending the original http.IncomingMessage. Default: http.IncomingMessage.

  • Http1ServerResponse <http.ServerResponse> 指定用于 HTTP/1 回退的 ServerResponse 类。用于扩展原始的 http.ServerResponse。默认值：http.ServerResponse。

    ¥Http1ServerResponse <http.ServerResponse> Specifies the ServerResponse class to used for HTTP/1 fallback. Useful for extending the original http.ServerResponse. Default: http.ServerResponse.

  • Http2ServerRequest <http2.Http2ServerRequest> 指定要使用的 Http2ServerRequest 类。用于扩展原始的 Http2ServerRequest。默认值：Http2ServerRequest。

    ¥Http2ServerRequest <http2.Http2ServerRequest> Specifies the Http2ServerRequest class to use. Useful for extending the original Http2ServerRequest. Default: Http2ServerRequest.

  • Http2ServerResponse <http2.Http2ServerResponse> 指定要使用的 Http2ServerResponse 类。用于扩展原始的 Http2ServerResponse。默认值：Http2ServerResponse。

    ¥Http2ServerResponse <http2.Http2ServerResponse> Specifies the Http2ServerResponse class to use. Useful for extending the original Http2ServerResponse. Default: Http2ServerResponse.

  • unknownProtocolTimeout <number> 指定在触发 'unknownProtocol' 时服务器应等待的超时（以毫秒为单位）。如果到那时套接字还没有被销毁，则服务器将销毁它。默认值：10000。

    ¥unknownProtocolTimeout <number> Specifies a timeout in milliseconds that a server should wait when an 'unknownProtocol' is emitted. If the socket has not been destroyed by that time the server will destroy it. Default: 10000.

  • ...:可以提供任何 net.createServer() 选项。

    ¥...: Any net.createServer() option can be provided.

• onRequestHandler <Function> 参见 兼容性接口

  ¥onRequestHandler <Function> See Compatibility API

• 返回：<Http2Server>

  ¥Returns: <Http2Server>

返回创建和管理 Http2Session 实例的 net.Server 实例。

¥Returns a net.Server instance that creates and manages Http2Session instances.

由于没有已知的浏览器支持 未加密的 HTTP/2，因此在与浏览器客户端通信时必须使用 http2.createSecureServer()。

¥Since there are no browsers known that support unencrypted HTTP/2, the use of http2.createSecureServer() is necessary when communicating with browser clients.

import { createServer } from 'node:http2';

// Create an unencrypted HTTP/2 server.
// Since there are no browsers known that support
// unencrypted HTTP/2, the use of `createSecureServer()`
// is necessary when communicating with browser clients.
const server = createServer();

server.on('stream', (stream, headers) => {
  stream.respond({
    'content-type': 'text/html; charset=utf-8',
    ':status': 200,
  });
  stream.end('<h1>Hello World</h1>');
});

server.listen(8000);const http2 = require('node:http2');

// Create an unencrypted HTTP/2 server.
// Since there are no browsers known that support
// unencrypted HTTP/2, the use of `http2.createSecureServer()`
// is necessary when communicating with browser clients.
const server = http2.createServer();

server.on('stream', (stream, headers) => {
  stream.respond({
    'content-type': 'text/html; charset=utf-8',
    ':status': 200,
  });
  stream.end('<h1>Hello World</h1>');
});

server.listen(8000);拷贝