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

Jump to bottom

doc: add params for ClientHttp2Session:altsvc #20598

Closed
wants to merge 2 commits into from
Closed

doc: add params for ClientHttp2Session:altsvc #20598

wants to merge 2 commits into from

Conversation

ryzokuken
Copy link
Contributor

Add parameters for the callback for the ClientHttp2Session:altsvc
event inline with the pattern in the rest of the documentation.

Refs: nodejs/help#877 (comment)

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

/cc @mcollina @nodejs/http2 @vsemozhetbyt

P.S. I swapped out streamId for stream, because of the following code in lib/http2/core.js:

function onAltSvc(stream, origin, alt) {
  const session = this[kOwner];
  if (session.destroyed)
    return;
  debug(`Http2Session ${sessionName(session[kType])}: altsvc received: ` +
        `stream: ${stream}, origin: ${origin}, alt: ${alt}`);
  session[kUpdateTimer]();
  session.emit('altsvc', alt, origin, stream);
}

Let me know if it should be reverted.

@ryzokuken
doc: add params for ClientHttp2Session:altsvc
c534dcb 
Add parameters for the callback for the ClientHttp2Session:altsvc
event inline with the pattern in the rest of the documentation.

Refs: nodejs/help#877 (comment)
@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. http2 Issues or PRs related to the http2 subsystem. labels May 8, 2018
@ryzokuken ryzokuken self-assigned this May 8, 2018
vsemozhetbyt
vsemozhetbyt approved these changes May 8, 2018
View reviewed changes
Copy link
Contributor

@vsemozhetbyt vsemozhetbyt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doc format LGTM.

@ryzokuken
Copy link
Contributor Author

Respond with a 👍 to approve fast-tracking.

@ryzokuken
Copy link
Contributor Author

CI Lite: https://ci.nodejs.org/job/node-test-pull-request-lite/688/

@ryzokuken ryzokuken added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label May 8, 2018
lpinca
lpinca reviewed May 8, 2018
View reviewed changes
doc/api/http2.md Outdated
be an empty string.

```js
const http2 = require('http2');
const client = http2.connect('https://example.org');

client.on('altsvc', (alt, origin, streamId) => {
client.on('altsvc', (alt, origin, stream) => {
Copy link
Member

@lpinca lpinca May 8, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know there is a type annotation by I think streamId makes it explicit that's an id and not a stream.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, if you say so, I'd change it back.

@ryzokuken
Copy link
Contributor Author

Resolved. @lpinca PTAL.

@ryzokuken
Copy link
Contributor Author

Awaiting a few more LGs, will land this tomorrow.

@ryzokuken ryzokuken added the fast-track PRs that do not need to wait for 48 hours to land. label May 8, 2018
@ryzokuken
Copy link
Contributor Author

CI Lite: https://ci.nodejs.org/job/node-test-pull-request-lite/693/

@ryzokuken
Copy link
Contributor Author

Landed in 4214c2f

@ryzokuken ryzokuken closed this May 9, 2018
ryzokuken added a commit that referenced this pull request May 9, 2018
@ryzokuken
doc: add params for ClientHttp2Session:altsvc
4214c2f 
Add parameters for the callback for the ClientHttp2Session:altsvc
event inline with the pattern in the rest of the documentation.

Refs: nodejs/help#877 (comment)

PR-URL: #20598
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Tiancheng "Timothy" Gu <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
targos pushed a commit that referenced this pull request May 12, 2018
@ryzokuken @targos
doc: add params for ClientHttp2Session:altsvc
b3b267a 
Add parameters for the callback for the ClientHttp2Session:altsvc
event inline with the pattern in the rest of the documentation.

Refs: nodejs/help#877 (comment)

PR-URL: #20598
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Tiancheng "Timothy" Gu <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
@addaleax addaleax mentioned this pull request May 14, 2018
Merged
kjin pushed a commit to kjin/node that referenced this pull request Aug 23, 2018
@ryzokuken @kjin
doc: add params for ClientHttp2Session:altsvc
c8475bb 
Add parameters for the callback for the ClientHttp2Session:altsvc
event inline with the pattern in the rest of the documentation.

Refs: nodejs/help#877 (comment)

PR-URL: nodejs#20598
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Tiancheng "Timothy" Gu <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
kjin pushed a commit to kjin/node that referenced this pull request Sep 11, 2018
@ryzokuken @kjin
doc: add params for ClientHttp2Session:altsvc
bdbabbc 
Add parameters for the callback for the ClientHttp2Session:altsvc
event inline with the pattern in the rest of the documentation.

Refs: nodejs/help#877 (comment)

PR-URL: nodejs#20598
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Tiancheng "Timothy" Gu <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
kjin pushed a commit to kjin/node that referenced this pull request Sep 19, 2018
@ryzokuken @kjin
doc: add params for ClientHttp2Session:altsvc
03e47da 
Add parameters for the callback for the ClientHttp2Session:altsvc
event inline with the pattern in the rest of the documentation.

Refs: nodejs/help#877 (comment)

PR-URL: nodejs#20598
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Tiancheng "Timothy" Gu <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
kjin pushed a commit to kjin/node that referenced this pull request Oct 16, 2018
@ryzokuken @kjin
doc: add params for ClientHttp2Session:altsvc
e3e16d7 
Add parameters for the callback for the ClientHttp2Session:altsvc
event inline with the pattern in the rest of the documentation.

Refs: nodejs/help#877 (comment)

PR-URL: nodejs#20598
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Tiancheng "Timothy" Gu <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
BethGriggs pushed a commit that referenced this pull request Oct 17, 2018
@ryzokuken @BethGriggs
doc: add params for ClientHttp2Session:altsvc
77acef4 
Add parameters for the callback for the ClientHttp2Session:altsvc
event inline with the pattern in the rest of the documentation.

Refs: nodejs/help#877 (comment)

Backport-PR-URL: #22850
PR-URL: #20598
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Tiancheng "Timothy" Gu <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
@BethGriggs BethGriggs mentioned this pull request Oct 30, 2018
Merged
@beevelop beevelop mentioned this pull request Nov 20, 2018
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@trivikr trivikr trivikr approved these changes

@vsemozhetbyt vsemozhetbyt vsemozhetbyt approved these changes

@cjihrig cjihrig cjihrig approved these changes

@TimothyGu TimothyGu TimothyGu approved these changes

@lpinca lpinca lpinca approved these changes

@jasnell jasnell jasnell approved these changes

Assignees

@ryzokuken ryzokuken

Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations. fast-track PRs that do not need to wait for 48 hours to land. http2 Issues or PRs related to the http2 subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@ryzokuken @jasnell @lpinca @TimothyGu @cjihrig @vsemozhetbyt @trivikr @nodejs-github-bot