1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: improve parameters for Http2Session:goaway event

Browse Source 
Improve parameters for the callback for the Http2Session:connect event
inline with the pattern in the rest of the documentation.

Refs: https://github.com/nodejs/help/issues/877#issuecomment-381253464
This commit is contained in:
Ujjwal Sharma 2018-04-26 23:16:57 +05:30
parent 602ffd6986
commit db10473e57
No known key found for this signature in database
GPG Key ID: 1FD3B47B83F46621
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/api/http2.md
View File

@ -179,15 +179,14 @@ immediately following the `'frameError'` event.
added: v8.4.0 added: v8.4.0
--> -->
The `'goaway'` event is emitted when a `GOAWAY` frame is received. When invoked,
the handler function will receive three arguments:
* `errorCode` {number} The HTTP/2 error code specified in the `GOAWAY` frame. * `errorCode` {number} The HTTP/2 error code specified in the `GOAWAY` frame.
* `lastStreamID` {number} The ID of the last stream the remote peer successfully * `lastStreamID` {number} The ID of the last stream the remote peer successfully
processed (or `0` if no ID is specified). processed (or `0` if no ID is specified).
* `opaqueData` {Buffer} If additional opaque data was included in the `GOAWAY` * `opaqueData` {Buffer} If additional opaque data was included in the `GOAWAY`
frame, a `Buffer` instance will be passed containing that data. frame, a `Buffer` instance will be passed containing that data.
The `'goaway'` event is emitted when a `GOAWAY` frame is received.
The `Http2Session` instance will be shut down automatically when the `'goaway'` The `Http2Session` instance will be shut down automatically when the `'goaway'`
event is emitted. event is emitted.