HTTP/2¶

v18.x.x

Модуль node:http2 предоставляет реализацию протокола HTTP/2. Доступ к нему можно получить, используя:

1

const http2 = require('node:http2');

Определение отсутствия поддержки криптографии¶

Возможно, что Node.js будет собран без поддержки модуля node:crypto. В таких случаях попытка import из node:http2 или вызов require('node:http2') приведет к ошибке.

При использовании CommonJS возникшую ошибку можно перехватить с помощью try/catch:

1
2
3
4
5
6

let http2;
try {
    http2 = require('node:http2');
} catch (err) {
    console.error('Поддержка http2 отключена!');
}

При использовании лексического ключевого слова ESM import ошибка может быть поймана только в том случае, если обработчик process.on('uncaughtException') зарегистрирован до любой попытки загрузить модуль (например, с помощью модуля предварительной загрузки).

При использовании ESM, если есть вероятность, что код может быть запущен на сборке Node.js, в которой не включена поддержка криптографии, используйте функцию import() вместо лексического ключевого слова import:

1
2
3
4
5
6

let http2;
try {
    http2 = await import('node:http2');
} catch (err) {
    console.error('Поддержка http2 отключена!');
}

Core API¶

Core API предоставляет низкоуровневый интерфейс, разработанный специально для поддержки функций протокола HTTP/2. Он специально не предназначен для совместимости с существующим API модуля HTTP/1. Однако, Compatibility API является таковым.

API ядра http2 гораздо более симметричен между клиентом и сервером, чем API http. Например, большинство событий, таких как 'error', 'connect' и 'stream', могут быть вызваны как клиентским, так и серверным кодом.

Пример на стороне сервера¶

Ниже показан простой HTTP/2 сервер, использующий Core API. Поскольку не известно ни одного браузера, поддерживающего незашифрованный HTTP/2, при взаимодействии с клиентами браузера необходимо использовать http2.createSecureServer().

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

const http2 = require('node:http2');
const fs = require('node:fs');

const server = http2.createSecureServer({
    key: fs.readFileSync('localhost-privkey.pem'),
    cert: fs.readFileSync('localhost-cert.pem'),
});
server.on('error', (err) => console.error(err));

server.on('stream', (stream, headers) => {
    // stream - это дуплекс
    stream.respond({
        'content-type': 'text/html; charset=utf-8',
        status: 200,
    });
    stream.end('<h1>Hello World</h1>');
});

server.listen(8443);

Чтобы сгенерировать сертификат и ключ для этого примера, выполните:

1
2

openssl req -x509 -newkey rsa:2048 -nodes -sha256 -subj '/CN=localhost' \
  -keyout localhost-privkey.pem -out localhost-cert.pem

Пример на стороне клиента¶

Ниже показан клиент HTTP/2:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

const http2 = require('node:http2');
const fs = require('node:fs');
const client = http2.connect('https://localhost:8443', {
    ca: fs.readFileSync('localhost-cert.pem'),
});
client.on('error', (err) => console.error(err));

const req = client.request({ ':path': '/' });

req.on('response', (headers, flags) => {
    for (const name in headers) {
        console.log(`${name}: ${headers[name]}`);
    }
});

req.setEncoding('utf8');
let data = '';
req.on('data', (chunk) => {
    data += chunk;
});
req.on('end', () => {
    console.log(`\n${data}`);
    client.close();
});
req.end();

Класс: Http2Session¶

• Расширяет: <EventEmitter>

Экземпляры класса http2.Http2Session представляют активный сеанс связи между HTTP/2 клиентом и сервером. Экземпляры этого класса не предназначены для создания непосредственно пользовательским кодом.

Каждый экземпляр Http2Session будет проявлять несколько иное поведение в зависимости от того, работает ли он как сервер или как клиент. Свойство http2session.type может быть использовано для определения режима, в котором работает Http2Session. На стороне сервера пользовательский код редко должен иметь возможность работать с объектом Http2Session напрямую, большинство действий обычно выполняется через взаимодействие с объектами Http2Server или Http2Stream.

Пользовательский код не будет создавать экземпляры Http2Session напрямую. Экземпляры Http2Session на стороне сервера создаются экземпляром Http2Server при получении нового HTTP/2 соединения. Экземпляры Http2Session на стороне клиента создаются с помощью метода http2.connect().

Http2Session и сокеты¶

Каждый экземпляр Http2Session при создании ассоциируется ровно с одним net.Socket или tls.TLSSocket. При уничтожении Socket или Http2Session будут уничтожены оба.

Из-за специфических требований к сериализации и обработке, налагаемых протоколом HTTP/2, пользовательскому коду не рекомендуется читать данные из или записывать данные в экземпляр Socket, связанный с Http2Session. Это может перевести сессию HTTP/2 в неопределенное состояние, в результате чего сессия и сокет станут непригодными для использования.

После того, как Socket был привязан к Http2Session, пользовательский код должен полагаться исключительно на API Http2Session.

Событие: 'close'¶

Событие 'close' происходит после уничтожения Http2Session. Его слушатель не ожидает никаких аргументов.

Событие: 'connect'¶

• session {Http2Session}
• socket <net.Socket>

Событие 'connect' происходит, когда Http2Session успешно соединяется с удаленным аналогом и может начать взаимодействие.

Пользовательский код, как правило, не прослушивает это событие напрямую.

Событие: error¶

• error <Error>

Событие 'error' генерируется, когда происходит ошибка во время обработки Http2Session.

Событие: FrameError¶

• type <integer> Тип кадра.
• code <integer> Код ошибки.
• id <integer> Идентификатор потока (или 0, если кадр не связан с потоком).

Событие 'frameError' генерируется, когда возникает ошибка при попытке отправить кадр в сессии. Если кадр, который не удалось отправить, связан с определенным Http2Stream, делается попытка выдать событие 'frameError' на Http2Stream.

Если событие 'frameError' связано с потоком, поток будет закрыт и уничтожен сразу после события 'frameError'. Если событие не связано с потоком, то Http2Session будет закрыт сразу после события 'frameError'.

Событие: goaway¶

• errorCode <number> Код ошибки HTTP/2, указанный во фрейме GOAWAY.
• lastStreamID <number> ID последнего потока, который удаленный пир успешно обработал (или 0, если ID не указан).
• opaqueData <Buffer> Если в кадр GOAWAY были включены дополнительные непрозрачные данные, будет передан экземпляр Buffer, содержащий эти данные.

Событие goaway испускается при получении кадра GOAWAY.

Экземпляр Http2Session будет автоматически закрыт при получении события 'goaway'.

Событие: 'localSettings'¶

• settings {HTTP/2 Объект настроек} Копия полученного кадра SETTINGS.

Событие 'localSettings' испускается, когда получено подтверждение кадра SETTINGS.

При использовании http2session.settings() для отправки новых настроек, измененные настройки не вступают в силу до тех пор, пока не будет вызвано событие 'localSettings'.

1
2
3
4
5

session.settings({ enablePush: false });

session.on('localSettings', (settings) => {
    /* Использовать новые настройки */
});

Событие: ping.¶

• payload <Buffer> 8-байтовая полезная нагрузка кадра PING.

Событие 'ping' генерируется всякий раз, когда от подключенного аналога получен кадр PING.

Событие: 'remoteSettings'¶

• settings {HTTP/2 Объект настроек} Копия полученного кадра SETTINGS.

Событие 'remoteSettings' испускается, когда новый фрейм SETTINGS получен от подключенного аналога.

1
2
3

session.on('remoteSettings', (settings) => {
    /* Использовать новые настройки */
});

Событие: stream¶

• stream {Http2Stream} Ссылка на поток
• headers {HTTP/2 Headers Object} Объект, описывающий заголовки
• flags <number> Соответствующие числовые флаги
• rawHeaders <Array> Массив, содержащий имена необработанных заголовков, за которыми следуют их соответствующие значения.

Событие 'stream' испускается, когда создается новый Http2Stream.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

const http2 = require('node:http2');
session.on('stream', (stream, headers, flags) => {
    const method = headers[':method'];
    const path = headers[':path'];
    // ...
    stream.respond({
        ':status': 200,
        'content-type': 'text/plain; charset=utf-8',
    });
    stream.write('hello');
    stream.end('world');
});

На стороне сервера пользовательский код обычно не будет слушать это событие напрямую, а вместо этого зарегистрирует обработчик для события 'stream', испускаемого экземплярами net.Server или tls.Server, возвращаемыми http2.createServer() и http2.createSecureServer() соответственно, как показано в примере ниже:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

const http2 = require('node:http2');

// Создаем незашифрованный HTTP/2 сервер
const server = http2.createServer();

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

server.listen(8000);

Несмотря на то, что потоки HTTP/2 и сетевые сокеты не находятся в соответствии 1:1, сетевая ошибка уничтожит каждый отдельный поток и должна быть обработана на уровне потока, как показано выше.

Событие: 'timeout'¶

После использования метода http2session.setTimeout() для установки периода таймаута для данной Http2Session, событие 'timeout' испускается, если нет активности в Http2Session после заданного количества миллисекунд. Его слушатель не ожидает никаких аргументов.

1
2
3
4

session.setTimeout(2000);
session.on('timeout', () => {
    /* ... */
});

http2session.alpnProtocol¶

• {string|undefined}

Значение будет undefined, если Http2Session еще не подключен к сокету, h2c, если Http2Session не подключен к TLSSocket, или вернет значение собственного свойства alpnProtocol подключенного TLSSocket.

http2session.close([callback])¶

• callback <Function>

Благородно закрывает Http2Session, позволяя всем существующим потокам завершиться самостоятельно и предотвращая создание новых экземпляров Http2Stream. После закрытия http2session.destroy() может быть вызвана, если нет открытых экземпляров Http2Stream.

Если указано, то функция callback регистрируется как обработчик события 'close'.

http2session.closed¶

• <boolean>

Будет true, если данный экземпляр Http2Session был закрыт, иначе false.

http2session.connecting¶

• <boolean>

Будет true, если данный экземпляр Http2Session все еще подключен, будет установлен в false перед выдачей события connect и/или вызовом обратного вызова http2.connect.

http2session.destroy([error][, code])¶

• error <Error> Объект Error, если Http2Session уничтожается из-за ошибки.
• code <number> Код ошибки HTTP/2 для отправки в финальном фрейме GOAWAY. Если не указано, и error не является неопределенным, по умолчанию INTERNAL_ERROR, в противном случае по умолчанию NO_ERROR.

Немедленно завершает Http2Session и связанный с ним net.Socket или tls.TLSSocket.

После уничтожения Http2Session выдает событие 'close'. Если error не является неопределенным, то событие 'error' будет выдано непосредственно перед событием 'close'.

Если есть какие-либо оставшиеся открытые Http2Streams, связанные с Http2Session, они также будут уничтожены.

http2session.destroyed¶

• <boolean>

Будет true, если этот экземпляр Http2Session был уничтожен и больше не должен использоваться, иначе false.

http2session.encrypted¶

• {boolean|undefined}

Значение равно undefined, если сокет сессии Http2Session еще не подключен, true, если Http2Session подключен к TLSSocket, и false, если Http2Session подключен к любому другому типу сокета или потока.

http2session.goaway([code[, lastStreamID[, opaqueData]]]])¶

• code <number> Код ошибки HTTP/2
• lastStreamID <number> Числовой идентификатор последнего обработанного Http2Stream.
• opaqueData {Buffer|TypedArray|DataView} Экземпляр TypedArray или DataView, содержащий дополнительные данные, которые должны быть переданы в кадре GOAWAY.

Передает кадр GOAWAY подключенному аналогу без закрытия Http2Session.

http2session.localSettings¶

• {HTTP/2 Settings Object}

Объект без прототипа, описывающий текущие локальные настройки данной Http2Session. Локальные настройки являются локальными для этого экземпляра Http2Session.

http2session.originSet¶

• {string[]|undefined}

Если Http2Session подключен к TLSSocket, свойство originSet возвращает массив источников, для которых Http2Session может считаться авторитетным.

Свойство originSet доступно только при использовании безопасного TLS-соединения.

http2session.pendingSettingsAck¶

• <boolean>

Указывает, ожидает ли Http2Session в настоящее время подтверждения отправленного кадра SETTINGS. Будет true после вызова метода http2session.settings(). Будет false, когда все отправленные фреймы SETTINGS будут подтверждены.

http2session.ping([payload, ]callback)¶

• payload {Buffer|TypedArray|DataView} Необязательная полезная нагрузка пинга.
• callback <Function>
• Возвращает: <boolean>

Отправляет фрейм PING подключенному HTTP/2 peer. Должна быть указана функция callback. Метод вернет true, если PING был отправлен, false в противном случае.

Максимальное количество незавершенных (непризнанных) пингов определяется параметром конфигурации maxOutstandingPings. По умолчанию максимальное значение равно 10.

Если указано, то payload должен представлять собой Buffer, TypedArray или DataView, содержащий 8 байт данных, которые будут переданы вместе с PING и возвращены с подтверждением пинга.

Обратный вызов будет вызван с тремя аргументами: аргумент error, который будет null, если PING был успешно подтвержден, аргумент duration, который сообщает количество миллисекунд, прошедших с момента отправки пинга и получения подтверждения, и Buffer, содержащий 8-байтовый полезный груз PING.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

session.ping(
    Buffer.from('abcdefgh'),
    (err, duration, payload) => {
        if (!err) {
            console.log(
                `Пинг подтвержден через ${длительность} миллисекунд`
            );
            console.log(
                `С полезной нагрузкой '${payload.toString()}'`
            );
        }
    }
);

Если аргумент payload не указан, то по умолчанию в качестве полезной нагрузки будет использоваться 64-битная метка времени (little endian), отмечающая начало длительности PING.

http2session.ref()¶

Вызывает ref() для данного экземпляра Http2Session, лежащего в основе net.Socket.

http2session.remoteSettings¶

• {HTTP/2 Settings Object}

Объект без прототипа, описывающий текущие удаленные настройки этой Http2Session. Удаленные настройки устанавливаются подключенным HTTP/2 peer.

http2session.setLocalWindowSize(windowSize)¶

• windowSize <number>

Устанавливает размер окна локальной конечной точки. Значение windowSize - это полный размер окна, который нужно установить, а не дельта.

1
2
3
4
5
6
7
8

const http2 = require('node:http2');

const server = http2.createServer();
const expectedWindowSize = 2 ** 20;
server.on('connect', (session) => {
    // Устанавливаем размер локального окна равным 2 ** 20
    session.setLocalWindowSize(expectedWindowSize);
});

http2session.setTimeout(msecs, callback)¶

• msecs <number>
• callback <Function>

Используется для установки функции обратного вызова, которая вызывается, когда нет активности на Http2Session после msecs миллисекунд. Данный callback регистрируется как слушатель события 'timeout'.

http2session.socket¶

• {net.Socket|tls.TLSSocket}

Возвращает объект Proxy, который действует как net.Socket (или tls.TLSSocket), но ограничивает доступные методы теми, которые безопасны для использования с HTTP/2.

Методы destroy, emit, end, pause, read, resume и write приведут к ошибке с кодом ERR_HTTP2_NO_SOCKET_MANIPULATION. Смотрите Http2Session и сокеты для получения дополнительной информации.

Метод setTimeout будет вызван на этой Http2Session.

Все остальные взаимодействия будут направлены непосредственно на сокет.

http2session.state¶

Предоставляет различную информацию о текущем состоянии Http2Session.

• <Object>
  • effectiveLocalWindowSize <number> Текущий размер локального (принимающего) окна управления потоком для Http2Session.
  • effectiveRecvDataLength <number> Текущее количество байт, которые были получены с момента последнего управления потоком WINDOW_UPDATE.
  • nextStreamID <number> Числовой идентификатор, который будет использоваться в следующий раз, когда новый Http2Stream будет создан этой Http2Session.
  • localWindowSize <number> Количество байт, которое удаленный пир может отправить без получения WINDOW_UPDATE.
  • lastProcStreamID <number> Числовой идентификатор Http2Stream, для которого последним был получен фрейм HEADERS или DATA.
  • remoteWindowSize <number> Количество байт, которое эта Http2Session может отправить без получения WINDOW_UPDATE.
  • outboundQueueSize <number> Количество кадров, находящихся в очереди на отправку для этой Http2Session.
  • deflateDynamicTableSize <number> Текущий размер в байтах таблицы состояния сжатия исходящих заголовков.
  • inflateDynamicTableSize <number> Текущий размер в байтах таблицы состояния сжатия входящих заголовков.

Объект, описывающий текущее состояние данного Http2Session.

http2session.settings([settings][, callback])¶

• settings {HTTP/2 объект настроек}
• callback <Function> Обратный вызов, который вызывается после подключения сессии или сразу же, если сессия уже подключена.
  • err {Error|null}
  • settings {HTTP/2 Settings Object} Обновленный объект settings.
  • duration <integer>

Обновляет текущие локальные настройки для данной Http2Session и отправляет новый фрейм SETTINGS подключенному HTTP/2 peer.

После вызова свойство http2session.pendingSettingsAck будет иметь значение true, пока сессия ожидает подтверждения новых настроек от удаленного пира.

Новые настройки вступят в силу только после получения подтверждения SETTINGS и возникновения события 'localSettings'. Можно отправить несколько кадров SETTINGS, пока ожидается подтверждение.

http2session.type¶

• <number>

Значение http2session.type будет равно http2.constants.NGHTTP2_SESSION_SERVER, если данный экземпляр Http2Session является сервером, и http2.constants.NGHTTP2_SESSION_CLIENT, если экземпляр является клиентом.

http2session.unref()¶

Вызывает unref() для данного экземпляра Http2Session, лежащего в основе net.Socket.

Класс: ServerHttp2Session¶

• Расширяет: {Http2Session}

serverhttp2session.altsvc(alt, originOrStream)¶

• alt <string> Описание конфигурации альтернативной службы, как определено в RFC 7838.
• originOrStream {number|string|URL|Object} Либо строка URL, указывающая происхождение (или Object со свойством origin), либо числовой идентификатор активного Http2Stream, заданный свойством http2stream.id.

Отправляет фрейм ALTSVC (как определено в RFC 7838) подключенному клиенту.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

const http2 = require('node:http2');

const server = http2.createServer();
server.on('session', (session) => {
    // Устанавливаем altsvc для origin https://example.org:80
    session.altsvc('h2=":8000"', 'https://example.org:80');
});

server.on('stream', (stream) => {
    // Устанавливаем altsvc для определенного потока
    stream.session.altsvc('h2=":8000"', stream.id);
});

Отправка фрейма ALTSVC с определенным идентификатором потока указывает на то, что альтернативный сервис связан с происхождением данного Http2Stream.

Строки alt и origin должны содержать только ASCII байты и строго интерпретируются как последовательность ASCII байтов. Специальное значение 'clear' может быть передано для очистки любой ранее установленной альтернативной службы для данного домена.

Если в качестве аргумента originOrStream передана строка, она будет разобрана как URL и будет определено происхождение. Например, источником для HTTP URL 'https://example.org/foo/bar' является ASCII строка 'https://example.org'. Если заданная строка не может быть разобрана как URL или если не может быть выведено правильное происхождение, будет выдана ошибка.

Объект URL или любой объект со свойством origin может быть передан как originOrStream, в этом случае будет использовано значение свойства origin. Значение свойства origin должно быть правильно сериализованным ASCII origin.

Указание альтернативных служб¶

Формат параметра alt строго определен RFC 7838 как ASCII-строка, содержащая список "альтернативных" протоколов, связанных с определенным хостом и портом, через запятую.

Например, значение 'h2="example.org:81"' указывает, что протокол HTTP/2 доступен на хосте 'example.org' на порту TCP/IP 81. Хост и порт должны содержаться в кавычках (```).

Можно указать несколько альтернатив, например: 'h2="example.org:81", h2=":82"'.

Идентификатор протокола ('h2' в примерах) может быть любым действительным ALPN Protocol ID.

Синтаксис этих значений не проверяется реализацией Node.js и передается как предоставленный пользователем или полученный от аналога.

serverhttp2session.origin(...origins)¶

• origins { string | URL | Object } Одна или несколько строк URL, переданных в качестве отдельных аргументов.

Посылает фрейм ORIGIN (как определено в RFC 8336) подключенному клиенту для рекламы набора источников, для которых сервер способен предоставлять авторитетные ответы.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

const http2 = require('node:http2');
const options = getSecureOptionsSomehow();
const server = http2.createSecureServer(options);
server.on('stream', (stream) => {
    stream.respond();
    stream.end('ok');
});
server.on('session', (session) => {
    session.origin(
        'https://example.com',
        'https://example.org'
    );
});

Когда в качестве origin передается строка, она будет разобрана как URL, и из нее будет выведено происхождение. Например, источником для HTTP URL 'https://example.org/foo/bar' является ASCII строка 'https://example.org'. Если заданная строка не может быть разобрана как URL или если не может быть выведено правильное происхождение, будет выдана ошибка.

В качестве оригинала может быть передан объект URL или любой объект со свойством origin, в этом случае будет использовано значение свойства origin. Значение свойства origin должно быть правильно сериализованным ASCII origin.

В качестве альтернативы, опцию origins можно использовать при создании нового HTTP/2 сервера с помощью метода http2.createSecureServer():

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

const http2 = require('node:http2');
const options = getSecureOptionsSomehow();
options.origins = [
    'https://example.com',
    'https://example.org',
];
const server = http2.createSecureServer(options);
server.on('stream', (stream) => {
    stream.respond();
    stream.end('ok');
});

Класс: ClientHttp2Session¶

• Расширяет: {Http2Session}

Событие: 'altsvc'¶

• alt <string>
• origin <string>
• streamId <number>

Событие 'altsvc' испускается всякий раз, когда клиент получает кадр ALTSVC. В событии указывается значение ALTSVC, происхождение и ID потока. Если в кадре ALTSVC не указан origin, то origin будет пустой строкой.

1
2
3
4
5
6
7
8

const http2 = require('node:http2');
const client = http2.connect('https://example.org');

client.on('altsvc', (alt, origin, streamId) => {
    console.log(alt);
    console.log(origin);
    console.log(streamId);
});

Событие: origin¶

• origins <string[]>

Событие 'origin' генерируется каждый раз, когда клиент получает кадр ORIGIN. Событие испускается с массивом строк origin. Набор http2session.originSet будет обновлен, чтобы включить полученные оригиналы.

1
2
3
4
5
6
7

const http2 = require('node:http2');
const client = http2.connect('https://example.org');

client.on('origin', (origins) => {
    for (let n = 0; n < origins.length; n++)
        console.log(origins[n]);
});

Событие origin испускается только при использовании безопасного TLS-соединения.

clienthttp2session.request(headers[, options])¶

• headers {HTTP/2 Headers Object}

• options <Object>

  • endStream <boolean> true если сторона Http2Stream записываемая должна быть закрыта изначально, например, при отправке GET запроса, который не должен ожидать тела полезной нагрузки.
  • exclusive <boolean> Когда true и parent идентифицирует родительский поток, создаваемый поток становится единственной прямой зависимостью родительского потока, а все остальные существующие зависимости становятся зависимыми от вновь созданного потока. По умолчанию: false.
  • parent <number> Указывает числовой идентификатор потока, от которого зависит создаваемый поток.
  • weight <number> Определяет относительную зависимость потока по отношению к другим потокам с тем же родителями. Значение - число от 1 до 256 (включительно).
  • waitForTrailers <boolean> Если true, то Http2Stream будет выдавать событие 'wantTrailers' после отправки последнего кадра DATA.
  • signal <AbortSignal> Сигнал прерывания, который может быть использован для прерывания текущего запроса.

• Возвращает: {ClientHttp2Stream}

Только для экземпляров HTTP/2 Client Http2Session, http2session.request() создает и возвращает экземпляр Http2Stream, который может быть использован для отправки HTTP/2 запроса на подключенный сервер.

Когда ClientHttp2Session создается впервые, сокет может быть еще не подключен. Если в это время вызывается clienthttp2session.request(), фактический запрос будет отложен до тех пор, пока сокет не будет готов к работе. Если сессия будет закрыта до выполнения фактического запроса, будет выброшена ошибка ERR_HTTP2_GOAWAY_SESSION.

Этот метод доступен, только если http2session.type равен http2.constants.NGHTTP2_SESSION_CLIENT.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

const http2 = require('node:http2');
const clientSession = http2.connect(
    'https://localhost:1234'
);
const {
    HTTP2_HEADER_PATH,
    HTTP2_HEADER_STATUS,
} = http2.constants;

const req = clientSession.request({
    [HTTP2_HEADER_PATH]: '/',
});
req.on('response', (headers) => {
    console.log(headers[HTTP2_HEADER_STATUS]);
    req.on('data', (chunk) => {
        /* ... */
    });
    req.on('end', () => {
        /* ... */
    });
});

Когда опция options.waitForTrailers установлена, событие 'wantTrailers' испускается сразу после постановки в очередь последнего куска данных полезной нагрузки для отправки. Метод http2stream.sendTrailers() может быть вызван для отправки заголовков в конце письма.

Когда параметр options.waitForTrailers установлен, Http2Stream не будет автоматически закрываться, когда будет передан последний кадр DATA. Пользовательский код должен вызвать либо http2stream.sendTrailers(), либо http2stream.close(), чтобы закрыть Http2Stream.

Если в options.signal установлен AbortSignal, а затем вызван abort на соответствующем AbortController, запрос выдаст событие 'error' с ошибкой AbortError.

Псевдозаголовки :method и :path не указываются в headers, они соответственно имеют значение по умолчанию:

• :method = 'GET'.
• :path = /

Класс: Http2Stream¶

• Расширяет: {stream.Duplex}

Каждый экземпляр класса Http2Stream представляет двунаправленный поток HTTP/2-коммуникаций через экземпляр Http2Session. Любой отдельный Http2Session может иметь до 2³¹-1 экземпляров Http2Stream за время своего существования.

Пользовательский код не будет создавать экземпляры Http2Stream напрямую. Скорее, они создаются, управляются и предоставляются пользовательскому коду через экземпляр Http2Session. На сервере экземпляры Http2Stream создаются либо в ответ на входящий HTTP-запрос (и передаются коду пользователя через событие 'stream'), либо в ответ на вызов метода http2stream.pushStream(). На клиенте экземпляры Http2Stream создаются и возвращаются либо при вызове метода http2session.request(), либо в ответ на входящее событие 'push'.

Класс Http2Stream является базой для классов ServerHttp2Stream и ClientHttp2Stream, каждый из которых используется на стороне сервера или клиента соответственно.

Все экземпляры Http2Stream являются потоками Duplex. Сторона Writable потока Duplex используется для отправки данных подключенному аналогу, а сторона Readable используется для получения данных, отправленных подключенным аналогом.

Кодировка текстовых символов по умолчанию для Http2Stream - UTF-8. При использовании Http2Stream для отправки текста, используйте заголовок 'content-type' для установки кодировки.

1
2
3
4

stream.respond({
    'content-type': 'text/html; charset=utf-8',
    ':status': 200,
});

Http2Stream Lifecycle¶

Создание¶

На стороне сервера экземпляры ServerHttp2Stream создаются либо когда:

• Получается новый кадр HTTP/2 HEADERS с ранее неиспользованным идентификатором потока;
• Вызывается метод http2stream.pushStream().

На стороне клиента экземпляры ClientHttp2Stream создаются при вызове метода http2session.request().

На клиенте экземпляр Http2Stream, возвращаемый методом http2session.request(), может быть не сразу готов к использованию, если родительский Http2Session еще не полностью создан. В таких случаях операции, вызываемые на Http2Stream, будут буферизироваться до тех пор, пока не произойдет событие 'ready'. Пользовательский код редко, если вообще когда-либо, должен обрабатывать событие 'ready' непосредственно. Статус готовности Http2Stream можно определить, проверив значение http2stream.id. Если значение равно undefined, поток еще не готов к использованию.

Уничтожение¶

Все экземпляры Http2Stream уничтожаются либо когда:

• кадр RST_STREAM для потока получен подключенным пиром, и (только для клиентских потоков) ожидающие данные были прочитаны.
• Вызывается метод http2stream.close(), и (только для клиентских потоков) ожидающие данные были прочитаны.
• Вызываются методы http2stream.destroy() или http2session.destroy().

Когда экземпляр Http2Stream уничтожается, будет предпринята попытка отправить фрейм RST_STREAM подключенному пиру.

Когда экземпляр Http2Stream будет уничтожен, произойдет событие 'close'. Поскольку Http2Stream является экземпляром stream.Duplex, событие 'end' также будет выдано, если данные потока в настоящее время текут. Событие 'error' также может быть вызвано, если http2stream.destroy() было вызвано с Error, переданным в качестве первого аргумента.

После уничтожения Http2Stream свойство http2stream.destroyed будет равно true, а свойство http2stream.rstCode будет указывать код ошибки RST_STREAM. После уничтожения экземпляр Http2Stream больше не может использоваться.

Событие: 'aborted'¶

Событие 'aborted' генерируется всякий раз, когда экземпляр Http2Stream аномально прерывается в середине коммуникации. Его слушатель не ожидает никаких аргументов.

Событие 'aborted' будет испущено, только если записываемая сторона Http2Stream не была завершена.

Событие: 'close'¶

Событие 'close' происходит, когда Http2Stream уничтожается. После того, как это событие произошло, экземпляр Http2Stream больше не может использоваться.

Код ошибки HTTP/2, используемый при закрытии потока, можно получить с помощью свойства http2stream.rstCode. Если код имеет любое значение, отличное от NGHTTP2_NO_ERROR (0), то также будет выдано событие 'error.

Событие: error¶

• error <Error>

Событие 'error' генерируется, когда происходит ошибка во время обработки Http2Stream.

Событие: FrameError¶

• type <integer> Тип кадра.
• code <integer> Код ошибки.
• id <integer> Идентификатор потока (или 0, если кадр не связан с потоком).

Событие 'frameError' генерируется при возникновении ошибки при попытке отправить кадр. При вызове функция-обработчик получает целочисленный аргумент, идентифицирующий тип кадра, и целочисленный аргумент, идентифицирующий код ошибки. Экземпляр Http2Stream будет уничтожен сразу после возникновения события 'frameError'.

Событие: 'ready'¶

Событие 'ready' происходит, когда поток Http2Stream был открыт, ему был присвоен id, и его можно использовать. Слушатель не ожидает никаких аргументов.

Событие: 'timeout'¶

Событие 'timeout' происходит после того, как для данного Http2Stream не было получено никакой активности в течение количества миллисекунд, установленного с помощью http2stream.setTimeout(). Его слушатель не ожидает никаких аргументов.

Событие: trailers¶

• headers {HTTP/2 Headers Object} Объект, описывающий заголовки
• flags <number> Ассоциированные числовые флаги

Событие 'trailers' генерируется, когда получен блок заголовков, связанных с полями заголовков в конце. Обратному вызову слушателя передается HTTP/2 Headers Object и флаги, связанные с заголовками.

Это событие может не произойти, если http2stream.end() вызывается до получения трейлеров и входящие данные не читаются и не прослушиваются.

1
2
3

stream.on('trailers', (headers, flags) => {
    console.log(headers);
});

Событие: 'wantTrailers'¶

Событие 'wantTrailers' происходит, когда Http2Stream поставил в очередь последний кадр DATA для отправки в кадре и Http2Stream готов к отправке заголовков. При инициировании запроса или ответа для этого события должна быть установлена опция waitForTrailers.

http2stream.aborted¶

• <boolean>

Устанавливается в true, если экземпляр Http2Stream был аномально прерван. Если установлено, то будет выдано событие `'aborted''.

http2stream.bufferSize¶

• <number>

Это свойство показывает количество символов, буферизованных для записи. Подробности смотрите в net.Socket.bufferSize.

http2stream.close(code[, callback])¶

• code <number> Беззнаковое 32-битное целое число, идентифицирующее код ошибки. По умолчанию: http2.constants.NGHTTP2_NO_ERROR (0x00).
• callback <Function> Необязательная функция, зарегистрированная для прослушивания события 'close'.

Закрывает экземпляр Http2Stream, отправляя кадр RST_STREAM подключенному HTTP/2 peer.

http2stream.closed¶

• <boolean>

Устанавливается в true, если экземпляр Http2Stream был закрыт.

http2stream.destroyed¶

• <boolean>

Устанавливается в true, если экземпляр Http2Stream был уничтожен и больше не может использоваться.

http2stream.endAfterHeaders¶

• <boolean>

Устанавливается в true, если в полученном кадре HEADERS запроса или ответа был установлен флаг END_STREAM, указывающий на то, что дополнительные данные не должны быть получены и читаемая сторона Http2Stream будет закрыта.

http2stream.id¶

• {number|undefined}

Числовой идентификатор потока данного экземпляра Http2Stream. Устанавливается в undefined, если идентификатор потока еще не был назначен.

http2stream.pending¶

• <boolean>

Устанавливается в true, если экземпляру Http2Stream еще не был присвоен числовой идентификатор потока.

http2stream.priority(options)¶

• options <Object>
  • exclusive <boolean> Когда true и parent идентифицирует родительский поток, этот поток становится единственной прямой зависимостью родительского потока, а все остальные существующие зависимые потоки становятся зависимыми от этого потока. По умолчанию: false.
  • parent <number> Указывает числовой идентификатор потока, от которого зависит этот поток.
  • weight <number> Определяет относительную зависимость потока по отношению к другим потокам с тем же родителями. Значение - число от 1 до 256 (включительно).
  • silent <boolean> Если true, изменяет приоритет локально, не посылая кадр PRIORITY подключенному аналогу.

Обновляет приоритет для данного экземпляра Http2Stream.

http2stream.rstCode¶

• <number>

Устанавливается в RST_STREAM код ошибки, сообщаемый при уничтожении Http2Stream после получения кадра RST_STREAM от подключенного пира, вызова http2stream.close() или http2stream.destroy(). Будет не определено, если Http2Stream не был закрыт.

http2stream.sentHeaders¶

• {HTTP/2 Headers Object}

Объект, содержащий исходящие заголовки, отправленные для данного Http2Stream.

http2stream.sentInfoHeaders¶

• {HTTP/2 Headers Object[]}

Массив объектов, содержащих исходящие информационные (дополнительные) заголовки, отправленные для данного Http2Stream.

http2stream.sentTrailers¶

• {HTTP/2 Headers Object}

Объект, содержащий исходящие трейлеры, отправленные для данного HttpStream.

http2stream.session¶

• {Http2Session}

Ссылка на экземпляр Http2Session, которому принадлежит данный Http2Stream. Значение будет не определено после уничтожения экземпляра Http2Stream.

http2stream.setTimeout(msecs, callback)¶

• msecs <number>
• callback <Function>

1
2
3
4
5
6
7

const http2 = require('node:http2');
const client = http2.connect('http://example.org:8000');
const { NGHTTP2_CANCEL } = http2.constants;
const req = client.request({ ':path': '/' });

// Отменяем поток, если нет активности через 5 секунд
req.setTimeout(5000, () => req.close(NGHTTP2_CANCEL));

http2stream.state¶

Предоставляет различную информацию о текущем состоянии Http2Stream.

• <Object>
  • localWindowSize <number> Количество байт, которое подключенный пир может отправить для данного Http2Stream без получения WINDOW_UPDATE.
  • state <number> Флаг, указывающий на низкоуровневое текущее состояние Http2Stream, определенное nghttp2.
  • localClose <number> 1, если этот Http2Stream был закрыт локально.
  • remoteClose <number> 1, если этот Http2Stream был закрыт удаленно.
  • sumDependencyWeight <number> Суммарный вес всех экземпляров Http2Stream, которые зависят от этого Http2Stream, как указано с помощью фреймов PRIORITY.
  • weight <number> Приоритетный вес этого Http2Stream.

Текущее состояние этого Http2Stream.

http2stream.sendTrailers(headers)¶

• headers {HTTP/2 Headers Object}

Отправляет трейлинг фрейма HEADERS подключенному аналогу HTTP/2. Этот метод приводит к немедленному закрытию Http2Stream и может быть вызван только после возникновения события 'wantTrailers. При отправке запроса или ответа, опция options.waitForTrailers должна быть установлена для того, чтобы держать Http2Stream открытым после последнего кадра DATA, чтобы можно было отправить трейлеры.

1
2
3
4
5
6
7
8
9

const http2 = require('node:http2');
const server = http2.createServer();
server.on('stream', (stream) => {
    stream.respond(undefined, { waitForTrailers: true });
    stream.on('wantTrailers', () => {
        stream.sendTrailers({ xyz: 'abc' });
    });
    stream.end('Hello World');
});

Спецификация HTTP/1 запрещает трейлерам содержать поля псевдозаголовков HTTP/2 (например, ':method', ':path' и т. д.).

Класс: ClientHttp2Stream¶

• Расширяет {Http2Stream}

Класс ClientHttp2Stream является расширением Http2Stream, который используется исключительно в HTTP/2 клиентах. Экземпляры Http2Stream на клиенте обеспечивают такие события, как 'response' и 'push', которые актуальны только на клиенте.

Событие: continue¶

Выдается, когда сервер посылает статус 100 Continue, обычно потому, что запрос содержит Expect: 100-continue. Это указание, что клиент должен отправить тело запроса.

Событие: headers¶

• headers {HTTP/2 Headers Object}
• флаги <number>

Событие 'headers' возникает, когда для потока получен дополнительный блок заголовков, например, когда получен блок информационных заголовков 1xx. Обратному вызову слушателя передается объект HTTP/2 Headers Object и флаги, связанные с заголовками.

1
2
3

stream.on('headers', (headers, flags) => {
    console.log(headers);
});

Событие: push¶

• headers {HTTP/2 Headers Object}
• флаги <number>

Событие 'push' возникает при получении заголовков ответа для потока Server Push. Обратному вызову слушателя передается объект HTTP/2 Headers Object и флаги, связанные с заголовками.

1
2
3

stream.on('push', (headers, flags) => {
    console.log(headers);
});

Событие: response¶

• headers {HTTP/2 Headers Object}
• флаги <number>

Событие 'response' испускается, когда для этого потока был получен кадр ответа HEADERS от подключенного HTTP/2 сервера. Слушатель вызывается с двумя аргументами: Object, содержащий полученный HTTP/2 Headers Object, и флаги, связанные с заголовками.

1
2
3
4
5
6

const http2 = require('node:http2');
const client = http2.connect('https://localhost');
const req = client.request({ ':path': '/' });
req.on('response', (headers, flags) => {
    console.log(headers[':status']);
});

Класс: ServerHttp2Stream¶

• Расширяет: {Http2Stream}

Класс ServerHttp2Stream является расширением Http2Stream, который используется исключительно на HTTP/2 серверах. Экземпляры Http2Stream на сервере предоставляют дополнительные методы, такие как http2stream.pushStream() и http2stream.respond(), которые актуальны только на сервере.

http2stream.additionalHeaders(headers)¶

• headers {HTTP/2 Headers Object}

Отправляет дополнительный информационный фрейм HEADERS подключенному HTTP/2 peer.

http2stream.headersSent¶

• <boolean>

True, если заголовки были отправлены, false в противном случае (только для чтения).

http2stream.pushAllowed¶

• <boolean>

Свойство только для чтения, отображаемое на флаг SETTINGS_ENABLE_PUSH последнего кадра SETTINGS удаленного клиента. Будет true, если удаленный пир принимает push-потоки, false в противном случае. Настройки одинаковы для каждого Http2Stream в одном и том же Http2Session.

http2stream.pushStream(headers[, options], callback)¶

• headers {HTTP/2 Headers Object}
• options <Object>
  • exclusive <boolean> Если true и parent указывает родительский поток, создаваемый поток становится единственной прямой зависимостью родительского потока, а все остальные существующие зависимости становятся зависимыми от вновь созданного потока. По умолчанию: false.
  • parent <number> Указывает числовой идентификатор потока, от которого зависит создаваемый поток.
• callback <Function> Обратный вызов, который будет вызван после того, как поток push будет инициирован.
  • err <Error>
  • pushStream {ServerHttp2Stream} Возвращаемый объект pushStream.
  • headers {HTTP/2 Headers Object} Объект заголовков, с которым был инициирован pushStream.

Инициирует поток push. Обратный вызов вызывается с новым экземпляром Http2Stream, созданным для потока push, переданным в качестве второго аргумента, или с Error, переданным в качестве первого аргумента.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

const http2 = require('node:http2');
const server = http2.createServer();
server.on('stream', (stream) => {
    stream.respond({ ':status': 200 });
    stream.pushStream(
        { ':path': '/' },
        (err, pushStream, headers) => {
            if (err) throw err;
            pushStream.respond({ ':status': 200 });
            pushStream.end('some pushed data');
        }
    );
    stream.end('некоторые данные');
});

Установка веса push-потока не разрешена во фрейме HEADERS. Передайте значение weight в http2stream.priority с опцией silent, установленной в true, чтобы включить балансировку полосы пропускания на стороне сервера между параллельными потоками.

Вызов http2stream.pushStream() изнутри проталкиваемого потока запрещен и приведет к ошибке.

http2stream.respond([headers[, options]])¶

• headers {HTTP/2 Headers Object}
• options <Object>
  • endStream <boolean> Устанавливается в true, чтобы указать, что ответ не будет включать данные полезной нагрузки.
  • waitForTrailers <boolean> Если true, то Http2Stream будет выдавать событие 'wantTrailers' после того, как будет отправлен последний кадр DATA.

1
2
3
4
5
6

const http2 = require('node:http2');
const server = http2.createServer();
server.on('stream', (stream) => {
    stream.respond({ ':status': 200 });
    stream.end('some data');
});

Инициирует ответ. Если установлена опция options.waitForTrailers, событие 'wantTrailers' будет выдано сразу после постановки в очередь последнего куска данных полезной нагрузки для отправки. После этого метод http2stream.sendTrailers() может быть использован для отправки полей заголовков, идущих следом, пиру.

Когда параметр options.waitForTrailers установлен, Http2Stream не будет автоматически закрываться, когда будет передан последний кадр DATA. Пользовательский код должен вызвать либо http2stream.sendTrailers(), либо http2stream.close(), чтобы закрыть Http2Stream.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

const http2 = require('node:http2');
const server = http2.createServer();
server.on('stream', (stream) => {
    stream.respond(
        { ':status': 200 },
        { waitForTrailers: true }
    );
    stream.on('wantTrailers', () => {
        stream.sendTrailers({
            ABC: 'некоторое значение для отправки',
        });
    });
    stream.end('некоторые данные');
});

http2stream.respondWithFD(fd[, headers[, options]])¶

• fd {number|FileHandle} Читаемый дескриптор файла.
• headers {HTTP/2 Headers Object}
• options <Object>
  • statCheck <Function>
  • waitForTrailers <boolean> Когда true, Http2Stream будет выдавать событие 'wantTrailers' после того, как будет отправлен последний кадр DATA.
  • offset <number> Позиция смещения, с которой следует начать чтение.
  • length <number> Количество данных из fd для отправки.

Инициирует ответ, данные которого считываются из заданного дескриптора файла. Проверка заданного файлового дескриптора не производится. Если при попытке чтения данных с помощью дескриптора файла произойдет ошибка, Http2Stream будет закрыт с помощью кадра RST_STREAM со стандартным кодом INTERNAL_ERROR.

При использовании Http2Stream интерфейс Duplex объекта Http2Stream будет закрыт автоматически.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

const http2 = require('node:http2');
const fs = require('node:fs');

const server = http2.createServer();
server.on('stream', (stream) => {
    const fd = fs.openSync('/some/file', 'r');

    const stat = fs.fstatSync(fd);
    const headers = {
        'content-length': stat.size,
        'last-modified': stat.mtime.toUTCString(),
        'content-type': 'text/plain; charset=utf-8',
    };
    stream.respondWithFD(fd, headers);
    stream.on('close', () => fs.closeSync(fd));
});

Необязательная функция options.statCheck может быть указана, чтобы дать возможность пользовательскому коду установить дополнительные заголовки содержимого, основываясь на деталях fs.Stat данного fd. Если указана функция statCheck, метод http2stream.respondWithFD() выполнит вызов fs.fstat() для сбора информации о предоставленном дескрипторе файла.

Опции offset и length могут быть использованы для ограничения ответа определенным подмножеством диапазона. Это может быть использовано, например, для поддержки запросов HTTP Range.

Дескриптор файла или FileHandle не закрывается при закрытии потока, поэтому его нужно будет закрыть вручную, когда он больше не нужен. Использование одного и того же файлового дескриптора одновременно для нескольких потоков не поддерживается и может привести к потере данных. Повторное использование дескриптора файла после завершения потока поддерживается.

Когда установлена опция options.waitForTrailers, событие 'wantTrailers будет выдаваться сразу после постановки в очередь последнего куска данных полезной нагрузки для отправки. После этого метод http2stream.sendTrailers() может быть использован для отправки полей заголовков, идущих следом, пиру.

Если параметр options.waitForTrailers установлен, Http2Stream не будет автоматически закрываться, когда будет передан последний кадр DATA. Пользовательский код должен вызвать либо http2stream.sendTrailers(), либо http2stream.close() для закрытия Http2Stream.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

const http2 = require('node:http2');
const fs = require('node:fs');

const server = http2.createServer();
server.on('stream', (stream) => {
    const fd = fs.openSync('/some/file', 'r');

    const stat = fs.fstatSync(fd);
    const headers = {
        'content-length': stat.size,
        'last-modified': stat.mtime.toUTCString(),
        'content-type': 'text/plain; charset=utf-8',
    };
    stream.respondWithFD(fd, headers, {
        waitForTrailers: true,
    });
    stream.on('wantTrailers', () => {
        stream.sendTrailers({ ABC: 'some value to send' });
    });

    stream.on('close', () => fs.closeSync(fd));
});

http2stream.respondWithFile(path[, headers[, options]])¶

• path {string|Buffer|URL}
• headers {HTTP/2 Headers Object}
• options <Object>
  • statCheck <Function>
  • onError <Function> Функция обратного вызова, вызываемая в случае ошибки перед отправкой.
  • waitForTrailers <boolean> Если true, то Http2Stream будет выдавать событие 'wantTrailers' после отправки последнего кадра DATA.
  • offset <number> Позиция смещения, с которой следует начать чтение.
  • length <number> Количество данных из fd для отправки.

Отправляет обычный файл в качестве ответа. В path должен быть указан обычный файл, иначе на объект Http2Stream будет выдано событие 'error'.

При использовании, интерфейс Duplex объекта Http2Stream будет автоматически закрыт.

Необязательная функция options.statCheck может быть указана, чтобы дать возможность пользовательскому коду установить дополнительные заголовки содержимого на основе данных fs.Stat данного файла:

Если при попытке чтения данных файла произойдет ошибка, Http2Stream будет закрыт с помощью фрейма RST_STREAM со стандартным кодом INTERNAL_ERROR. Если определен обратный вызов onError, то он будет вызван. В противном случае поток будет уничтожен.

Пример с использованием пути к файлу:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

const http2 = require('node:http2');
const server = http2.createServer();
server.on('stream', (stream) => {
  function statCheck(stat, headers) {
    headers['last-modified'] = stat.mtime.toUTCString();
  }

  function onError(err) {
    // stream.respond() может бросить, если поток был уничтожен
    // другой стороной.
    try {
      if (err.code === 'ENOENT') {
        stream.respond({ ':status': 404 });
      } else {
        stream.respond({ ':status': 500 });
      }
    } catch (err) {
      // Выполняем фактическую обработку ошибок.
      console.error(err);
    }
    stream.end();
  }

  stream.respondWithFile('/some/file',
                         { 'content-type': 'text/plain; charset=utf-8' }
                         { statCheck, onError });
});

Функция options.statCheck может также использоваться для отмены операции отправки, возвращая false. Например, условный запрос может проверить результаты stat, чтобы определить, был ли файл изменен, и вернуть соответствующий ответ 304:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

const http2 = require('node:http2');
const server = http2.createServer();
server.on('stream', (stream) => {
  function statCheck(stat, headers) {
    // Проверяем stat здесь...
    stream.respond({ ':status': 304 });
    return false; // Отмена операции отправки
  }
  stream.respondWithFile('/some/file',
                         { 'content-type': 'text/plain; charset=utf-8' }
                         { statCheck });
});

Поле заголовка content-length будет установлено автоматически.

Опции offset и length могут быть использованы для ограничения ответа определенным подмножеством диапазонов. Это может быть использовано, например, для поддержки запросов HTTP Range.

Функция options.onError также может быть использована для обработки всех ошибок, которые могут произойти до начала доставки файла. Поведением по умолчанию является уничтожение потока.

Если установлена опция options.waitForTrailers, событие 'wantTrailers будет выдано сразу после постановки в очередь последнего куска данных полезной нагрузки для отправки. После этого метод http2stream.sendTrailers() может быть использован для отправки полей заголовков, идущих в хвосте, пиру.

Когда параметр options.waitForTrailers установлен, Http2Stream не будет автоматически закрываться, когда будет передан последний кадр DATA. Пользовательский код должен вызвать либо http2stream.sendTrailers(), либо http2stream.close(), чтобы закрыть Http2Stream.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

const http2 = require('node:http2');
const server = http2.createServer();
server.on('stream', (stream) => {
    stream.respondWithFile(
        '/some/file',
        { 'content-type': 'text/plain; charset=utf-8' },
        { waitForTrailers: true }
    );
    stream.on('wantTrailers', () => {
        stream.sendTrailers({ ABC: 'some value to send' });
    });
});

Класс: Http2Server¶

• Расширяет: {net.Server}

Экземпляры Http2Server создаются с помощью функции http2.createServer(). Класс Http2Server не экспортируется напрямую модулем node:http2.

Событие: 'checkContinue'¶

• запрос {http2.Http2ServerRequest}
• ответ {http2.Http2ServerResponse}

Если зарегистрирован слушатель 'request' или http2.createServer() снабжен функцией обратного вызова, событие 'checkContinue' испускается каждый раз, когда получен запрос с HTTP Expect: 100-continue. Если это событие не прослушивается, сервер будет автоматически отвечать со статусом 100 Continue в зависимости от ситуации.

Обработка этого события включает вызов response.writeContinue(), если клиент должен продолжить отправку тела запроса, или генерацию соответствующего HTTP ответа (например, 400 Bad Request), если клиент не должен продолжать отправку тела запроса.

Когда это событие испущено и обработано, событие 'request' не будет испущено.

Событие: connection¶

• socket {stream.Duplex}

Это событие возникает при установлении нового TCP-потока. socket обычно представляет собой объект типа net.Socket. Обычно пользователи не хотят обращаться к этому событию.

Это событие также может быть явно вызвано пользователями для инъекции соединений в HTTP-сервер. В этом случае может быть передан любой поток Duplex.

Событие: request¶

• запрос {http2.Http2ServerRequest}
• response {http2.Http2ServerResponse}

Выдается при каждом запросе. В одной сессии может быть несколько запросов. См. API совместимости.

Событие: session¶

• session {ServerHttp2Session}

Событие 'session' испускается, когда новый Http2Session создается Http2Server'ом.

Событие: sessionError¶

• error <Error>
• session {ServerHttp2Session}

Событие 'sessionError' испускается, когда событие 'error' испускается объектом Http2Session, связанным с Http2Server.

Событие: stream¶

• stream {Http2Stream} Ссылка на поток
• headers {HTTP/2 Headers Object} Объект, описывающий заголовки
• flags <number> Соответствующие числовые флаги
• rawHeaders <Array> Массив, содержащий имена необработанных заголовков, за которыми следуют их соответствующие значения.

Событие 'stream' испускается, когда событие 'stream' было испущено Http2Session, связанным с сервером.

См. также событие Http2Session 'stream'.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

const http2 = require('node:http2');
const {
    HTTP2_HEADER_METHOD,
    HTTP2_HEADER_PATH,
    HTTP2_HEADER_STATUS,
    HTTP2_HEADER_CONTENT_TYPE,
} = http2.constants;

const server = http2.createServer();
server.on('stream', (stream, headers, flags) => {
    const method = headers[HTTP2_HEADER_METHOD];
    const path = headers[HTTP2_HEADER_PATH];
    // ...
    stream.respond({
        [HTTP2_HEADER_STATUS]: 200,
        [HTTP2_HEADER_CONTENT_TYPE]:
            'text/plain; charset=utf-8',
    });
    stream.write('hello ');
    stream.end('world');
});

Событие: timeout¶

Событие 'timeout' происходит, когда на сервере нет активности в течение заданного количества миллисекунд, установленного с помощью http2server.setTimeout(). По умолчанию: 0 (таймаут отсутствует)

server.close([callback])¶

• callback <Function>

Прекращает создание сервером новых сессий. Это не препятствует созданию новых потоков запросов из-за постоянной природы сессий HTTP/2. Чтобы изящно завершить работу сервера, вызовите http2session.close() для всех активных сессий.

Если указан callback, он не будет вызван, пока все активные сессии не будут закрыты, хотя сервер уже перестал допускать новые сессии. Подробнее см. в net.Server.close().

server.setTimeout([msecs][, callback])¶

• msecs <number> По умолчанию: 0 (без таймаута)
• callback <Function>
• Возвращает: {Http2Server}

Используется для установки значения тайм-аута для запросов http2-сервера и задает функцию обратного вызова, которая вызывается при отсутствии активности на Http2Server по истечении msecs миллисекунд.

Данный обратный вызов регистрируется как слушатель события 'timeout'.

В случае, если callback не является функцией, будет выброшена новая ошибка ERR_INVALID_ARG_TYPE.

server.timeout¶

• <number> Таймаут в миллисекундах. По умолчанию: 0 (таймаут отсутствует).

Количество миллисекунд бездействия, после которого считается, что сокет завершил работу.

Значение 0 отключает таймаут для входящих соединений.

Логика таймаута сокета устанавливается при подключении, поэтому изменение этого значения влияет только на новые соединения с сервером, а не на существующие.

server.updateSettings([settings])¶

• settings {HTTP/2 Settings Object}

Используется для обновления сервера с заданными настройками.

Выбрасывает ERR_HTTP2_INVALID_SETTING_VALUE для недопустимых значений settings.

Выбрасывает ERR_INVALID_ARG_TYPE для недопустимого аргумента settings.

Класс: Http2SecureServer¶

• Расширяет: {tls.Server}

Экземпляры Http2SecureServer создаются с помощью функции http2.createSecureServer(). Класс Http2SecureServer не экспортируется напрямую модулем node:http2.

Событие: 'checkContinue'¶

• запрос {http2.Http2ServerRequest}
• ответ {http2.Http2ServerResponse}

Если зарегистрирован слушатель 'request' или http2.createSecureServer() снабжен функцией обратного вызова, событие 'checkContinue' испускается каждый раз, когда получен запрос с HTTP Expect: 100-continue. Если это событие не прослушивается, сервер будет автоматически отвечать со статусом 100 Continue в зависимости от ситуации.

Обработка этого события включает вызов response.writeContinue(), если клиент должен продолжить отправку тела запроса, или генерацию соответствующего HTTP ответа (например, 400 Bad Request), если клиент не должен продолжать отправку тела запроса.

Когда это событие испущено и обработано, событие 'request' не будет испущено.

Событие: connection¶

• socket {stream.Duplex}

Это событие возникает при установлении нового TCP-потока, до начала квитирования TLS. socket обычно представляет собой объект типа net.Socket. Обычно пользователи не хотят обращаться к этому событию.

Это событие также может быть явно вызвано пользователями для инъекции соединений в HTTP-сервер. В этом случае может быть передан любой поток Duplex.

Событие: request¶

• запрос {http2.Http2ServerRequest}
• response {http2.Http2ServerResponse}

Выдается при каждом запросе. В одной сессии может быть несколько запросов. См. API совместимости.

Событие: session¶

• session {ServerHttp2Session}

Событие 'session' испускается, когда новый Http2Session создается сервером Http2SecureServer.

Событие: sessionError¶

• error <Error>
• session {ServerHttp2Session}

Событие 'sessionError' генерируется, когда объект Http2Session, связанный с Http2SecureServer, выдает событие 'error'.

Событие: stream¶

• stream {Http2Stream} Ссылка на поток
• headers {HTTP/2 Headers Object} Объект, описывающий заголовки
• flags <number> Соответствующие числовые флаги
• rawHeaders <Array> Массив, содержащий имена необработанных заголовков, за которыми следуют их соответствующие значения.

Событие 'stream' испускается, когда событие 'stream' было испущено Http2Session, связанным с сервером.

См. также событие Http2Session 'stream'.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

const http2 = require('node:http2');
const {
    HTTP2_HEADER_METHOD,
    HTTP2_HEADER_PATH,
    HTTP2_HEADER_STATUS,
    HTTP2_HEADER_CONTENT_TYPE,
} = http2.constants;

const options = getOptionsSomehow();

const server = http2.createSecureServer(options);
server.on('stream', (stream, headers, flags) => {
    const method = headers[HTTP2_HEADER_METHOD];
    const path = headers[HTTP2_HEADER_PATH];
    // ...
    stream.respond({
        [HTTP2_HEADER_STATUS]: 200,
        [HTTP2_HEADER_CONTENT_TYPE]:
            'text/plain; charset=utf-8',
    });
    stream.write('hello ');
    stream.end('world');
});

Событие: 'timeout'¶

Событие 'timeout' происходит, когда на сервере нет активности в течение заданного количества миллисекунд, установленного с помощью http2secureServer.setTimeout(). По умолчанию: 2 минуты.

Событие: unknownProtocol¶

• socket {stream.Duplex}

Событие 'unknownProtocol' возникает, когда подключающийся клиент не может согласовать разрешенный протокол (т.е. HTTP/2 или HTTP/1.1). Обработчик события получает сокет для обработки. Если для этого события не зарегистрирован слушатель, соединение разрывается. Таймаут может быть указан с помощью опции 'unknownProtocolTimeout', передаваемой в http2.createSecureServer().

В ранних версиях Node.js это событие возникало, если allowHTTP1 было false и во время квитирования TLS клиент либо не отправлял расширение ALPN, либо отправлял расширение ALPN, не включающее HTTP/2 (h2). Более новые версии Node.js выдают это событие только в том случае, если allowHTTP1 равно false и клиент не отправляет расширение ALPN. Если клиент отправляет расширение ALPN, которое не включает HTTP/2 (или HTTP/1.1, если allowHTTP1 равно true), квитирование TLS завершится неудачей, и безопасное соединение не будет установлено.

server.close([callback])¶

• callback <Function>

Прекращает создание сервером новых сессий. Это не препятствует созданию новых потоков запросов из-за постоянной природы сессий HTTP/2. Чтобы изящно завершить работу сервера, вызовите http2session.close() для всех активных сессий.

Если указан callback, он не будет вызван, пока все активные сессии не будут закрыты, хотя сервер уже перестал допускать новые сессии. Более подробную информацию смотрите в tls.Server.close().

server.setTimeout([msecs][, callback])¶

• msecs <number> По умолчанию: 120000 (2 минуты)
• callback <Function>
• Возвращает: {Http2SecureServer}

Используется для установки значения тайм-аута для запросов http2 secure server, и устанавливает функцию обратного вызова, которая вызывается, когда нет активности на Http2SecureServer после msecs миллисекунд.

Данный обратный вызов регистрируется как слушатель события 'timeout'.

В случае, если callback не является функцией, будет выброшена новая ошибка ERR_INVALID_ARG_TYPE.

server.timeout¶

• <number> Таймаут в миллисекундах. По умолчанию: 0 (таймаут отсутствует).

Количество миллисекунд бездействия, после которого считается, что сокет завершил работу.

Значение 0 отключает таймаут для входящих соединений.

Логика таймаута сокета устанавливается при подключении, поэтому изменение этого значения влияет только на новые соединения с сервером, а не на существующие.

server.updateSettings([settings])¶

• settings {HTTP/2 Settings Object}

Используется для обновления сервера с заданными настройками.

Выбрасывает ERR_HTTP2_INVALID_SETTING_VALUE для недопустимых значений settings.

Выбрасывает ERR_INVALID_ARG_TYPE для недопустимого аргумента settings.

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

• options <Object>
  • maxDeflateDynamicTableSize <number> Устанавливает максимальный размер динамической таблицы для дефлирования полей заголовка. По умолчанию: 4Kib.
  • maxSettings <number> Устанавливает максимальное количество записей настроек в рамке SETTINGS. Минимальное допустимое значение - 1. По умолчанию: 32.
  • maxSessionMemory<number> Задает максимальное количество памяти, которое разрешено использовать Http2Session. Значение выражается в количестве мегабайт, например, 1 равно 1 мегабайту. Минимально допустимое значение - 1. Это ограничение, основанное на кредите, существующие Http2Stream могут привести к превышению этого ограничения, но новые экземпляры Http2Stream будут отклонены при превышении этого ограничения. Текущее количество сессий Http2Stream, текущее использование памяти таблиц сжатия заголовков, текущие данные в очереди на отправку, а также непринятые фреймы PING и SETTINGS учитываются в текущем лимите. По умолчанию: 10.
  • maxHeaderListPairs <number> Устанавливает максимальное количество записей заголовков. Это аналогично server.maxHeadersCount или request.maxHeadersCount в модуле node:http. Минимальное значение - 4. По умолчанию: 128.
  • maxOutstandingPings <number> Задает максимальное количество оставшихся непринятых пингов. По умолчанию: 10.
  • maxSendHeaderBlockLength <number> Устанавливает максимально допустимый размер сериализованного сжатого блока заголовков. Попытки отправить заголовки, превышающие этот предел, приведут к возникновению события 'frameError'', а поток будет закрыт и уничтожен. Хотя этот параметр устанавливает максимально допустимый размер для всего блока заголовков,nghttp2(внутренняя библиотека http2) имеет ограничение65536` для каждой распакованной пары ключ/значение.
  • paddingStrategy <number> Стратегия, используемая для определения количества прокладок для фреймов HEADERS и DATA. По умолчанию: http2.constants.PADDING_STRATEGY_NONE. Значение может быть одним из:
    • http2.constants.PADDING_STRATEGY_NONE: Никакая прокладка не применяется.
    • http2.constants.PADDING_STRATEGY_MAX: Применяется максимальное количество прокладок, определяемое внутренней реализацией.
    • http2.constants.PADDING_STRATEGY_ALIGNED: Пытается применить достаточное количество прокладок, чтобы общая длина кадра, включая 9-байтовый заголовок, была кратна 8. Для каждого кадра существует максимально допустимое количество байт прокладок, которое определяется текущим состоянием и настройками управления потоком. Если этот максимум меньше, чем рассчитанное количество, необходимое для обеспечения выравнивания, используется максимум, и общая длина кадра не обязательно выравнивается по 8 байтам.
  • peerMaxConcurrentStreams <number> Устанавливает максимальное количество одновременных потоков для удаленного пира, как если бы был получен кадр SETTINGS. Будет переопределено, если удаленный пир установит собственное значение для maxConcurrentStreams. По умолчанию: 100.
  • maxSessionInvalidFrames <integer> Устанавливает максимальное количество недействительных кадров, которое будет допущено до закрытия сессии. По умолчанию: 1000.
  • maxSessionRejectedStreams <integer> Устанавливает максимальное количество отклоненных при создании потоков, которое будет допустимо до закрытия сессии. Каждый отказ связан с ошибкой NGHTTP2_ENHANCE_YOUR_CALM, которая должна сказать пиру больше не открывать потоки, поэтому продолжение открытия потоков рассматривается как признак неправильного поведения пира. По умолчанию: 100.
  • settings {HTTP/2 Settings Object} Начальные настройки для отправки удаленному пиру при подключении.
  • Http1IncomingMessage {http.IncomingMessage} Определяет класс IncomingMessage, который будет использоваться для HTTP/1 fallback. Полезно для расширения оригинального http.IncomingMessage. По умолчанию: http.IncomingMessage.
  • Http1ServerResponse {http.ServerResponse} Определяет класс ServerResponse, который будет использоваться для HTTP/1 fallback. Полезно для расширения оригинального http.ServerResponse. По умолчанию: http.ServerResponse.
  • Http2ServerRequest {http2.Http2ServerRequest} Определяет класс Http2ServerRequest для использования. Полезен для расширения оригинального Http2ServerRequest. По умолчанию: Http2ServerRequest.
  • Http2ServerResponse {http2.Http2ServerResponse} Определяет класс Http2ServerResponse для использования. Полезно для расширения оригинального Http2ServerResponse. По умолчанию: Http2ServerResponse.
  • unknownProtocolTimeout <number> Определяет тайм-аут в миллисекундах, который сервер должен ждать, когда выдается неизвестный протокол. Если сокет не будет уничтожен к этому времени, сервер уничтожит его. По умолчанию: 10000.
  • ...: Может быть предоставлена любая опция net.createServer().
• onRequestHandler <Function> См. API совместимости.
• Возвращает: {Http2Server}

Возвращает экземпляр net.Server, который создает и управляет экземплярами Http2Session.

Поскольку не существует браузеров, поддерживающих незашифрованный HTTP/2, при взаимодействии с клиентами браузеров необходимо использовать http2.createSecureServer().

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

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);

http2.createSecureServer(options[, onRequestHandler])¶

• options <Object>
  • allowHTTP1 <boolean> Входящие клиентские соединения, не поддерживающие HTTP/2, будут понижены до HTTP/1.x, если установлено значение true. См. событие неизвестный протокол. См. ALPN negotiation. По умолчанию: false.
  • maxDeflateDynamicTableSize <number> Устанавливает максимальный размер динамической таблицы для дефлирования полей заголовка. По умолчанию: 4Kib.
  • maxSettings <number> Устанавливает максимальное количество записей настроек в рамке SETTINGS. Минимальное допустимое значение - 1. По умолчанию: 32.
  • maxSessionMemory<number> Задает максимальное количество памяти, которое разрешено использовать Http2Session. Значение выражается в количестве мегабайт, например, 1 равно 1 мегабайту. Минимально допустимое значение - 1. Это ограничение, основанное на кредите, существующие Http2Stream могут привести к превышению этого ограничения, но новые экземпляры Http2Stream будут отклонены при превышении этого ограничения. Текущее количество сессий Http2Stream, текущее использование памяти таблиц сжатия заголовков, текущие данные в очереди на отправку, а также непринятые фреймы PING и SETTINGS учитываются в текущем лимите. По умолчанию: 10.
  • maxHeaderListPairs <number> Устанавливает максимальное количество записей заголовков. Это аналогично server.maxHeadersCount или request.maxHeadersCount в модуле node:http. Минимальное значение - 4. По умолчанию: 128.
  • maxOutstandingPings <number> Задает максимальное количество оставшихся непринятых пингов. По умолчанию: 10.
  • maxSendHeaderBlockLength <number> Устанавливает максимально допустимый размер сериализованного сжатого блока заголовков. Попытки отправить заголовки, превышающие этот предел, приведут к возникновению события `'frameError'', а поток будет закрыт и уничтожен.
  • paddingStrategy <number> Стратегия, используемая для определения количества вставки для фреймов HEADERS и DATA. По умолчанию: http2.constants.PADDING_STRATEGY_NONE. Значение может быть одним из:
  • http2.constants.PADDING_STRATEGY_NONE: Никакие прокладки не применяются.
    • http2.constants.PADDING_STRATEGY_MAX: Применяется максимальное количество прокладок, определяемое внутренней реализацией.
    • http2.constants.PADDING_STRATEGY_ALIGNED: Пытается применить достаточное количество прокладок, чтобы общая длина кадра, включая 9-байтовый заголовок, была кратна 8. Для каждого кадра существует максимально допустимое количество байт прокладок, которое определяется текущим состоянием и настройками управления потоком. Если этот максимум меньше, чем рассчитанное количество, необходимое для обеспечения выравнивания, используется максимум, и общая длина кадра не обязательно выравнивается по 8 байтам.
  • peerMaxConcurrentStreams <number> Устанавливает максимальное количество одновременных потоков для удаленного пира, как если бы был получен кадр SETTINGS. Будет переопределено, если удаленный пир установит собственное значение для maxConcurrentStreams. По умолчанию: 100.
  • maxSessionInvalidFrames <integer> Устанавливает максимальное количество недействительных кадров, которое будет допущено до закрытия сессии. По умолчанию: 1000.
  • maxSessionRejectedStreams <integer> Устанавливает максимальное количество отклоненных при создании потоков, которое будет допустимо до закрытия сессии. Каждый отказ связан с ошибкой NGHTTP2_ENHANCE_YOUR_CALM, которая должна сказать пиру больше не открывать потоки, поэтому продолжение открытия потоков рассматривается как признак неправильного поведения пира. По умолчанию: 100.
  • settings {HTTP/2 Settings Object} Начальные настройки для отправки удаленному пиру при подключении.
  • ...: Можно предоставить любые опции tls.createServer(). Для серверов обычно требуются опции идентификации (pfx или key/cert).
  • origins <string[]> Массив строк происхождения для отправки во фрейме ORIGIN сразу после создания новой серверной Http2Session.
  • unknownProtocolTimeout <number> Определяет таймаут в миллисекундах, который сервер должен выждать, когда испускается событие 'unknownProtocol'. Если сокет не будет уничтожен к этому времени, сервер уничтожит его. По умолчанию: 10000.
• onRequestHandler <Function> См. Compatibility API.
• Возвращает: {Http2SecureServer}

Возвращает экземпляр tls.Server, который создает и управляет экземплярами Http2Session.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

const http2 = require('node:http2');
const fs = require('node:fs');

const options = {
    key: fs.readFileSync('server-key.pem'),
    cert: fs.readFileSync('server-cert.pem'),
};

// Create a secure HTTP/2 server
const server = http2.createSecureServer(options);

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

server.listen(8443);

http2.connect(authority[, options][, listener])¶

• authority <string> | <URL> Удаленный HTTP/2 сервер, к которому необходимо подключиться. Он должен быть в виде минимального корректного URL с префиксом http:// или https://, имени хоста и IP-порта (если используется порт не по умолчанию). Информация о пользователе (идентификатор пользователя и пароль), путь, строка запроса и детали фрагмента в URL будут проигнорированы.
• options <Object>
  • maxDeflateDynamicTableSize <number> Устанавливает максимальный размер динамической таблицы для дефлирования полей заголовка. По умолчанию: 4Kib.
  • maxSettings <number> Устанавливает максимальное количество записей настроек в рамке SETTINGS. Минимальное допустимое значение - 1. По умолчанию: 32.
  • maxSessionMemory<number> Задает максимальное количество памяти, которое разрешено использовать Http2Session. Значение выражается в количестве мегабайт, например, 1 равно 1 мегабайту. Минимально допустимое значение - 1. Это ограничение, основанное на кредите, существующие Http2Stream могут привести к превышению этого ограничения, но новые экземпляры Http2Stream будут отклонены при превышении этого ограничения. Текущее количество сессий Http2Stream, текущее использование памяти таблиц сжатия заголовков, текущие данные в очереди на отправку, а также непризнанные фреймы PING и SETTINGS учитываются в текущем лимите. По умолчанию: 10.
  • 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 1. Default: 128.
  • maxOutstandingPings <number> Sets the maximum number of outstanding, unacknowledged pings. Default: 10.
  • maxReservedRemoteStreams <number> Sets the maximum number of reserved push streams the client will accept at any given time. Once the current number of currently reserved push streams exceeds reaches this limit, new push streams sent by the server will be automatically rejected. The minimum allowed value is 0. The maximum allowed value is 2³²-1. A negative value sets this option to the maximum allowed value. Default: 200.
  • 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.
  • paddingStrategy <number> Стратегия, используемая для определения количества вставки для фреймов HEADERS и DATA. По умолчанию: http2.constants.PADDING_STRATEGY_NONE. Значение может быть одним из:
    • http2.constants.PADDING_STRATEGY_NONE: Никакая прокладка не применяется.
    • http2.constants.PADDING_STRATEGY_MAX: Применяется максимальное количество прокладок, определяемое внутренней реализацией.
    • http2.constants.PADDING_STRATEGY_ALIGNED: Попытка применить достаточное количество прокладок для того, чтобы общая длина кадра, включая

http2.constants¶

Коды ошибок для RST_STREAM и GOAWAY¶

Событие 'timeout' происходит, когда на сервере нет активности в течение заданного количества миллисекунд, установленного с помощью http2server.setTimeout().

http2.getDefaultSettings()¶

• Возвращает: {HTTP/2 Settings Object}

Возвращает объект, содержащий настройки по умолчанию для экземпляра Http2Session. Этот метод возвращает новый экземпляр объекта при каждом вызове, поэтому возвращаемые экземпляры могут быть безопасно изменены для использования.

http2.getPackedSettings([settings])¶

• settings {HTTP/2 Объект настроек}
• Возвращает: <Buffer>

Возвращает экземпляр Buffer, содержащий сериализованное представление заданных настроек HTTP/2, как указано в спецификации HTTP/2. Предназначен для использования с полем заголовка HTTP2-Settings.

1
2
3
4
5
6
7
8

const http2 = require('node:http2');

const packed = http2.getPackedSettings({
    enablePush: false,
});

console.log(packed.toString('base64'));
// Печатает: AAIAAAAAAA

http2.getUnpackedSettings(buf)¶

• buf {Buffer|TypedArray} Упакованные настройки.
• Возвращает: {HTTP/2 Settings Object}

Возвращает HTTP/2 Settings Object, содержащий десериализованные настройки из данного Buffer, сгенерированные http2.getPackedSettings().

http2.sensitiveHeaders¶

• {символ}

Этот символ может быть установлен как свойство объекта HTTP/2 headers со значением массива, чтобы предоставить список заголовков, считающихся чувствительными. Более подробную информацию смотрите в Sensitive headers.

Объект заголовков¶

Заголовки представляются как собственные свойства объектов JavaScript. Ключи свойств будут сериализованы в нижний регистр. Значения свойств должны быть строками (если это не так, они будут принудительно преобразованы в строки) или массивом строк (чтобы отправить более одного значения для каждого поля заголовка).

1
2
3
4
5
6
7

const headers = {
    ':status': '200',
    'content-type': 'text-plain',
    ABC: ['has', 'more', 'than', 'one', 'value'],
};

stream.respond(headers);

Объекты заголовков, передаваемые в функции обратного вызова, будут иметь прототип null. Это означает, что обычные объектные методы JavaScript, такие как Object.prototype.toString() и Object.prototype.hasOwnProperty() не будут работать.

Для входящих заголовков:

• Заголовок :status преобразуется в number.
• Дубликаты :status, :method, :authority, :scheme, :path, : protocol, age, authorization, access-control-allow-credentials, access-control-max-age, access-control-request-method, content-encoding, content-language, content-length, content-location, content-md5, content-range, content-type, date, dnt, etag, expires, from, host, if-match, if-modified-since, if-none-match, if-range, if-unmodified-since, last-modified, location, max-forwards, proxy-authorization, range, referer, retry-after, tk, upgrade-insecure-requests, user-agent или x-content-type-options отбрасываются.
• set-cookie всегда является массивом. Дубликаты добавляются в массив.
• Для дублирующихся заголовков cookie значения объединяются с помощью ';'.
• Для всех остальных заголовков значения объединяются с помощью ','.

1
2
3
4
5
6

const http2 = require('node:http2');
const server = http2.createServer();
server.on('stream', (stream, headers) => {
    console.log(headers[':path']);
    console.log(headers.ABC);
});

Чувствительные заголовки¶

Заголовки HTTP2 могут быть помечены как чувствительные, что означает, что алгоритм сжатия заголовков HTTP/2 никогда не будет их индексировать. Это может иметь смысл для заголовков с низкой энтропией, которые могут быть ценными для злоумышленника, например, Cookie или Authorization. Чтобы добиться этого, добавьте имя заголовка в свойство [http2.sensitiveHeaders] в виде массива:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

const headers = {
    ':status': '200',
    'content-type': 'text-plain',
    cookie: 'some-cookie',
    'other-sensitive-header': 'очень секретные данные',
    [http2.sensitiveHeaders]: [
        'cookie',
        'other-sensitive-header',
    ],
};

stream.respond(headers);

Для некоторых заголовков, таких как Authorization и короткие заголовки Cookie, этот флаг устанавливается автоматически.

Это свойство также устанавливается для полученных заголовков. Оно будет содержать имена всех заголовков, помеченных как чувствительные, включая те, которые были помечены таким образом автоматически.

Объект настроек¶

API http2.getDefaultSettings(), http2.getPackedSettings(), http2.createServer(), http2.createSecureServer(), http2session.settings(), http2session.localSettings и http2session.remoteSettings либо возвращают, либо получают на вход объект, определяющий настройки конфигурации для объекта Http2Session. Эти объекты представляют собой обычные объекты JavaScript, содержащие следующие свойства.

• headerTableSize <number> Specifies the maximum number of bytes used for header compression. The minimum allowed value is 0. The maximum allowed value is 2³²-1. Default: 4096.
• enablePush <boolean> Указывает true, если HTTP/2 Push-потоки должны быть разрешены для экземпляров Http2Session. По умолчанию: true.
• initialWindowSize <number> Specifies the sender’s initial window size in bytes for stream-level flow control. The minimum allowed value is 0. The maximum allowed value is 2³²-1. Default: 65535.
• maxFrameSize <number> Specifies the size in bytes of the largest frame payload. The minimum allowed value is 16,384. The maximum allowed value is 2²⁴-1. Default: 16384.
• maxConcurrentStreams <number> Specifies the maximum number of concurrent streams permitted on an Http2Session. There is no default value which implies, at least theoretically, 2³²-1 streams may be open concurrently at any given time in an Http2Session. The minimum value is 0. The maximum allowed value is 2³²-1. Default: 4294967295.
• maxHeaderListSize <number> Specifies the maximum size (uncompressed octets) of header list that will be accepted. The minimum allowed value is 0. The maximum allowed value is 2³²-1. Default: 65535.
• maxHeaderSize <number> Псевдоним для maxHeaderListSize.
• enableConnectProtocol<boolean> Указывает true, если должен быть включен "Расширенный протокол соединения", определенный в RFC 8441. Этот параметр имеет смысл только в том случае, если он отправлен сервером. После включения параметра enableConnectProtocol для данной Http2Session, он не может быть отключен. По умолчанию: false.

Все дополнительные свойства объекта настроек игнорируются.

Обработка ошибок¶

Существует несколько типов ошибок, которые могут возникнуть при использовании модуля node:http2:

Ошибки валидации возникают, когда передан неверный аргумент, опция или значение настройки. О них всегда сообщает синхронный throw.

Ошибки состояния возникают, когда действие выполняется в неправильное время (например, попытка отправить данные в потоке после его закрытия). О них будет сообщено либо с помощью синхронного throw, либо через событие 'error' на объектах Http2Stream, Http2Session или HTTP/2 Server, в зависимости от того, где и когда произошла ошибка.

Внутренние ошибки возникают, когда сессия HTTP/2 неожиданно завершается неудачей. О них будет сообщено через событие 'error' на объектах Http2Session или HTTP/2 Server.

Ошибки протокола возникают при нарушении различных ограничений протокола HTTP/2. О них будет сообщено либо с помощью синхронного throw, либо через событие 'error' на объектах Http2Stream, Http2Session или HTTP/2 Server, в зависимости от того, где и когда произошла ошибка.

Обработка недопустимых символов в именах и значениях заголовков¶

В реализации HTTP/2 применяется более строгая обработка недопустимых символов в именах и значениях заголовков HTTP, чем в реализации HTTP/1.

Имена полей заголовков нечувствительны к регистру и передаются по проводам строго в виде строк в нижнем регистре. API, предоставляемый Node.js, позволяет задавать имена заголовков в виде строк со смешанным регистром (например, Content-Type), но при передаче они будут преобразованы в строчные (например, content-type).

Имена полей заголовка должны содержать только один или несколько из следующих символов ASCII: a-z, A-Z, 0-9, !, #, $, %, &, ', *, +, -, ., ^, _, ````(обратный знак),|и~`.

Использование недопустимых символов в имени поля заголовка HTTP приведет к закрытию потока с сообщением об ошибке протокола.

Значения полей заголовков обрабатываются более мягко, но не должны содержать символов новой строки или возврата каретки и должны быть ограничены символами US-ASCII, согласно требованиям спецификации HTTP.

Push streams на клиенте¶

Чтобы получать потоки на клиенте, установите слушателя для события 'stream' на ClientHttp2Session:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

const http2 = require('node:http2');

const client = http2.connect('http://localhost');

client.on('stream', (pushedStream, requestHeaders) => {
    pushedStream.on('push', (responseHeaders) => {
        // Обработка заголовков ответа
    });
    pushedStream.on('data', (chunk) => {
        /* обрабатываем вталкиваемые данные */
    });
});

const req = client.request({ ':path': '/' });

Поддержка метода CONNECT¶

Метод CONNECT используется для того, чтобы позволить HTTP/2 серверу использоваться в качестве прокси для TCP/IP соединений.

Простой TCP-сервер:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

const net = require('node:net');

const server = net.createServer((socket) => {
    let name = '';
    socket.setEncoding('utf8');
    socket.on('data', (chunk) => (name += chunk));
    socket.on('end', () => socket.end(`hello ${name}`));
});

server.listen(8000);

HTTP/2 CONNECT прокси:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

const http2 = require('node:http2');
const { NGHTTP2_REFUSED_STREAM } = http2.constants;
const net = require('node:net');

const proxy = http2.createServer();
proxy.on('stream', (stream, headers) => {
    if (headers[':method'] !== 'CONNECT') {
        // Принимать только запросы CONNECT
        stream.close(NGHTTP2_REFUSED_STREAM);
        return;
    }
    const auth = new URL(`tcp://${headers[':authority']}`);
    // Очень хорошая идея проверить, что имя хоста и порт являются.
    // к которым должен подключаться этот прокси.
    const socket = net.connect(
        auth.port,
        auth.hostname,
        () => {
            stream.respond();
            socket.pipe(stream);
            stream.pipe(socket);
        }
    );
    socket.on('error', (error) => {
        stream.close(http2.constants.NGHTTP2_CONNECT_ERROR);
    });
});

proxy.listen(8001);

Клиент HTTP/2 CONNECT:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

const http2 = require('node:http2');

const client = http2.connect('http://localhost:8001');

// Не следует указывать заголовки ':path' и ':scheme'
// для запросов CONNECT, иначе будет выдана ошибка.
const req = client.request({
    ':method': 'CONNECT',
    ':authority': 'localhost:8000',
});

req.on('response', (headers) => {
    console.log(
        headers[http2.constants.HTTP2_HEADER_STATUS]
    );
});
let data = '';
req.setEncoding('utf8');
req.on('data', (chunk) => (data += chunk));
req.on('end', () => {
    console.log(`Сервер говорит: ${data}`);
    client.close();
});
req.end('Jane');

Расширенный протокол CONNECT¶

RFC 8441 определяет расширение "Extended CONNECT Protocol" для HTTP/2, которое может быть использовано для загрузки использования Http2Stream с помощью метода CONNECT в качестве туннеля для других коммуникационных протоколов (таких как WebSockets).

Использование расширенного протокола CONNECT включается серверами HTTP/2 с помощью параметра enableConnectProtocol:

1
2
3

const http2 = require('node:http2');
const settings = { enableConnectProtocol: true };
const server = http2.createServer({ settings });

Как только клиент получает от сервера фрейм SETTINGS, указывающий на возможность использования расширенного CONNECT, он может отправлять запросы CONNECT, использующие псевдозаголовок ':protocol' HTTP/2:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

const http2 = require('node:http2');
const client = http2.connect('http://localhost:8080');
client.on('remoteSettings', (settings) => {
    if (settings.enableConnectProtocol) {
        const req = client.request({
            ':method': 'CONNECT',
            ':protocol': 'foo',
        });
        // ...
    }
});

API совместимости¶

Целью Compatibility API является обеспечение схожего с HTTP/1 опыта разработчика при использовании HTTP/2, что делает возможным разработку приложений, поддерживающих как HTTP/1, так и HTTP/2. Этот API нацелен только на публичный API из HTTP/1. Однако многие модули используют внутренние методы или состояние, и они не поддерживаются, поскольку это совершенно другая реализация.

Следующий пример создает HTTP/2 сервер, используя API совместимости:

1
2
3
4
5
6
7
8
9

const http2 = require('node:http2');
const server = http2.createServer((req, res) => {
    res.setHeader('Content-Type', 'text/html');
    res.setHeader('X-Foo', 'bar');
    res.writeHead(200, {
        'Content-Type': 'text/plain; charset=utf-8',
    });
    res.end('ok');
});

Чтобы создать смешанный HTTPS и HTTP/2 сервер, обратитесь к разделу ALPN negotiation. Обновление с не-tls серверов HTTP/1 не поддерживается.

API совместимости HTTP/2 состоит из Http2ServerRequest и Http2ServerResponse. Они направлены на совместимость API с HTTP/1, но не скрывают различий между протоколами. Например, сообщение о статусе для HTTP-кодов игнорируется.

ALPN negotiation¶

Переговоры ALPN позволяют поддерживать HTTPS и HTTP/2 через один и тот же сокет. Объекты req и res могут быть как HTTP/1, так и HTTP/2, и приложение должно ограничиться публичным API HTTP/1 и определить, возможно ли использовать более продвинутые возможности HTTP/2.

В следующем примере создается сервер, поддерживающий оба протокола:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

const { createSecureServer } = require('node:http2');
const { readFileSync } = require('node:fs');

const cert = readFileSync('./cert.pem');
const key = readFileSync('./key.pem');

const server = createSecureServer(
    { cert, key, allowHTTP1: true },
    onRequest
).listen(4443);

function onRequest(req, res) {
    // Определяет, является ли это запрос HTTPS или HTTP/2
    const {
        socket: { alpnProtocol },
    } =
        req.httpVersion === '2.0'
            ? req.stream.session
            : req;
    res.writeHead(200, {
        'content-type': 'application/json',
    });
    res.end(
        JSON.stringify({
            alpnProtocol,
            httpVersion: req.httpVersion,
        })
    );
}

Событие 'request' работает одинаково как на HTTPS, так и на HTTP/2.

Класс: http2.Http2ServerRequest¶

• Расширяет: <stream.Readable>

Объект Http2ServerRequest создается http2.Server или http2.SecureServer и передается в качестве первого аргумента в событие 'request'. Он может быть использован для доступа к статусу запроса, заголовкам и данным.

Событие: 'aborted'¶

Событие 'aborted' генерируется всякий раз, когда экземпляр Http2ServerRequest аномально прерывается в середине коммуникации.

Событие 'aborted' будет испущено только в том случае, если записываемая сторона Http2ServerRequest не была завершена.

Событие: close¶

Указывает, что базовый Http2Stream был закрыт. Как и 'end', это событие происходит только один раз для каждого ответа.

request.aborted¶