Skip to content

Commit

Permalink
doc: clarify http2 docs around class exports
Browse files Browse the repository at this point in the history
PR-URL: #22247
Fixes: #21434
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
  • Loading branch information
jasnell authored and George Adams committed Aug 12, 2018
1 parent 74d3363 commit d3d5982
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions doc/api/http2.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,11 @@ have occasion to work with the `Http2Session` object directly, with most
actions typically taken through interactions with either the `Http2Server` or
`Http2Stream` objects.

User code will not create `Http2Session` instances directly. Server-side
`Http2Session` instances are created by the `Http2Server` instance when a
new HTTP/2 connection is received. Client-side `Http2Session` instances are
created using the `http2.connect()` method.

#### `Http2Session` and Sockets

Every `Http2Session` instance is associated with exactly one [`net.Socket`][] or
Expand Down Expand Up @@ -1510,6 +1515,10 @@ added: v8.4.0

* Extends: {net.Server}

Instances of `Http2Server` are created using the `http2.createServer()`
function. The `Http2Server` class is not exported directly by the `http2`
module.

#### Event: 'checkContinue'
<!-- YAML
added: v8.5.0
Expand Down Expand Up @@ -1617,6 +1626,10 @@ added: v8.4.0

* Extends: {tls.Server}

Instances of `Http2SecureServer` are created using the
`http2.createSecureServer()` function. The `Http2SecureServer` class is not
exported directly by the `http2` module.

#### Event: 'checkContinue'
<!-- YAML
added: v8.5.0
Expand Down

0 comments on commit d3d5982

Please sign in to comment.