Skip to content

Commit

Permalink
doc: improve parameters for Http2Session:goaway event
Browse files Browse the repository at this point in the history
Improve parameters for the callback for the Http2Session:connect event
inline with the pattern in the rest of the documentation.

Refs: nodejs/help#877 (comment)

Backport-PR-URL: #22850
  • Loading branch information
ryzokuken authored and BethGriggs committed Oct 16, 2018
1 parent c7ba556 commit 1a6a054
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions doc/api/http2.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,17 +179,16 @@ 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.

*Note*: The `Http2Session` instance will be shut down automatically when the
`'goaway'` event is emitted.
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.

#### Event: 'localSettings'
<!-- YAML
Expand Down

0 comments on commit 1a6a054

Please sign in to comment.