Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJames M Snell <jasnell@gmail.com>2018-09-22 00:14:04 +0300
committerBeth Griggs <Bethany.Griggs@uk.ibm.com>2018-10-17 02:07:24 +0300
commit10576d6e772eb4a0002d63327563cfb0a09625e5 (patch)
tree9ab8d65c856345e8130dc9aed573e7d352abf8eb /doc
parentca933ce5778364b46d6a8ad6dd4dca456119b948 (diff)
http2: add ping event
Add a `Http2Session` event whenever a non-ack `PING` is received. Fixes: https://github.com/nodejs/node/issues/18514 Backport-PR-URL: https://github.com/nodejs/node/pull/22850 PR-URL: https://github.com/nodejs/node/pull/23009 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ujjwal Sharma <usharma1998@gmail.com> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/http2.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/api/http2.md b/doc/api/http2.md
index 349e2b9b710..ebb89c1bd4c 100644
--- a/doc/api/http2.md
+++ b/doc/api/http2.md
@@ -217,6 +217,16 @@ session.on('localSettings', (settings) => {
});
```
+#### Event: 'ping'
+<!-- YAML
+added: REPLACEME
+-->
+
+* `payload` {Buffer} The `PING` frame 8-byte payload
+
+The `'ping'` event is emitted whenever a `PING` frame is received from the
+connected peer.
+
#### Event: 'remoteSettings'
<!-- YAML
added: v8.4.0