diff options
| author | James M Snell <jasnell@gmail.com> | 2018-08-10 11:49:00 -0700 |
|---|---|---|
| committer | George Adams <george.adams@uk.ibm.com> | 2018-08-12 20:10:40 +0100 |
| commit | d3d59821dd136a36dc2e1b4a7d02c936762240f4 (patch) | |
| tree | 64ebbb9e6fe6ceb064049bbd522648ebe2aa1ca4 /doc | |
| parent | 74d33630ce34969d6abf57e1e597fcdafef56ab2 (diff) | |
| download | android-node-v8-d3d59821dd136a36dc2e1b4a7d02c936762240f4.tar.gz android-node-v8-d3d59821dd136a36dc2e1b4a7d02c936762240f4.tar.bz2 android-node-v8-d3d59821dd136a36dc2e1b4a7d02c936762240f4.zip | |
doc: clarify http2 docs around class exports
PR-URL: https://github.com/nodejs/node/pull/22247
Fixes: https://github.com/nodejs/node/issues/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>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/http2.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/api/http2.md b/doc/api/http2.md index d99052003a..4d56b61839 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -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 @@ -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 @@ -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 |