summaryrefslogtreecommitdiff
path: root/doc/api/http2.md
diff options
context:
space:
mode:
authorJames M Snell <jasnell@gmail.com>2018-09-21 14:14:04 -0700
committerJames M Snell <jasnell@gmail.com>2018-09-23 16:36:24 -0700
commita0c1326257b9679b056d8611ccdee2d6757b0bf0 (patch)
tree4914f6072d5b6b4365cda762114c25923f22145c /doc/api/http2.md
parentc67d3d0c3caf74795871f813dbef2ec3fc196e58 (diff)
downloadandroid-node-v8-a0c1326257b9679b056d8611ccdee2d6757b0bf0.tar.gz
android-node-v8-a0c1326257b9679b056d8611ccdee2d6757b0bf0.tar.bz2
android-node-v8-a0c1326257b9679b056d8611ccdee2d6757b0bf0.zip
http2: add ping event
Add a `Http2Session` event whenever a non-ack `PING` is received. Fixes: https://github.com/nodejs/node/issues/18514 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/api/http2.md')
-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 205c0dc85b..698f1bf2d8 100644
--- a/doc/api/http2.md
+++ b/doc/api/http2.md
@@ -222,6 +222,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