Skip to content

Commit 882c2c0

Browse files
jasnellrvagg
authored andcommitted
doc: clarify http2 docs around class exports
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>
1 parent ec2209d commit 882c2c0

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

doc/api/http2.md

+13
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,11 @@ have occasion to work with the `Http2Session` object directly, with most
108108
actions typically taken through interactions with either the `Http2Server` or
109109
`Http2Stream` objects.
110110

111+
User code will not create `Http2Session` instances directly. Server-side
112+
`Http2Session` instances are created by the `Http2Server` instance when a
113+
new HTTP/2 connection is received. Client-side `Http2Session` instances are
114+
created using the `http2.connect()` method.
115+
111116
#### `Http2Session` and Sockets
112117

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

15111516
* Extends: {net.Server}
15121517

1518+
Instances of `Http2Server` are created using the `http2.createServer()`
1519+
function. The `Http2Server` class is not exported directly by the `http2`
1520+
module.
1521+
15131522
#### Event: 'checkContinue'
15141523
<!-- YAML
15151524
added: v8.5.0
@@ -1617,6 +1626,10 @@ added: v8.4.0
16171626

16181627
* Extends: {tls.Server}
16191628

1629+
Instances of `Http2SecureServer` are created using the
1630+
`http2.createSecureServer()` function. The `Http2SecureServer` class is not
1631+
exported directly by the `http2` module.
1632+
16201633
#### Event: 'checkContinue'
16211634
<!-- YAML
16221635
added: v8.5.0

0 commit comments

Comments
 (0)