Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: improve parameters for Http2Session:goaway event #20338

Closed
wants to merge 2 commits into from
Closed

doc: improve parameters for Http2Session:goaway event #20338

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c9aba0a
doc: improve parameters for Http2Session:goaway event
ryzokuken Apr 26, 2018
41147a9
fixup! doc: improve parameters for Http2Session:goaway event
ryzokuken Apr 27, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions doc/api/http2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,15 +179,14 @@ immediately following the `'frameError'` event.
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.
* `lastStreamID` {number} The ID of the last stream the remote peer successfully
processed (or `0` if no ID is specified).
* `opaqueData` {Buffer} If additional opaque data was included in the `GOAWAY`
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'`
event is emitted.

Expand Down