Skip to content
This repository has been archived by the owner on Oct 25, 2018. It is now read-only.

Seeking Review: Documentation of the feature. #2

Merged
merged 4 commits into from
Nov 3, 2017

Conversation

edburns
Copy link
Member

@edburns edburns commented Nov 2, 2017

No description provided.

Edward Burns added 3 commits November 1, 2017 14:44
modified:   README.md
modified:   api/src/main/java/org/glassfish/grizzly/npn/AlpnClientNegotiator.java
modified:   api/src/main/java/org/glassfish/grizzly/npn/AlpnServerNegotiator.java
README.md Outdated

---

## How to Avoid IP Taint When Examining this Code
Copy link
Member

Choose a reason for hiding this comment

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

I don't think this is necessary.

Copy link
Member Author

Choose a reason for hiding this comment

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

Removed.

README.md Outdated
[`Http2AddOn`](https://github.com/javaee/grizzly/blob/e0e9200479851078d9cf2bad1cf29fa72f525437/modules/http2/src/main/java/org/glassfish/grizzly/http2/Http2AddOn.java)
This `AddOn` implementation inserts some filters in the chain in the
proper order to ensure that ALPN concerns are handled first, and then
the HTTP/2 protocol is handled. The former is of interest here.
Copy link
Member

Choose a reason for hiding this comment

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

Better phrased as something like: in addition to registering filters for HTTP/2 processing, it registers a callback with the ALPN extension.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done.

README.md Outdated

By the time `onStart` is invoked, the handshake listener will have
been initialized with implementations of `AlpnClientNegotiator` and
`AlpnServerNegotiator`.
Copy link
Member

Choose a reason for hiding this comment

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

via the Http2Addon

Copy link
Member Author

Choose a reason for hiding this comment

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

Done.

README.md Outdated
The above programmatic configuration steps will make it so the simple
act of including the module built from the `bootstrap` sub-module of
this repository in the "endorsed" directory of the JVM will enable ALPN
support in that JVM.
Copy link
Member

Choose a reason for hiding this comment

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

I would recommend documenting the use of bootclasspath vs endorsed of the JVM so as to not impact all applications that are using the JVM, only those that need ALPN.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done.

@edburns
Copy link
Member Author

edburns commented Nov 3, 2017

@rlubke Please review and accept this PR if you agree. Once you do, I'll point the customer to it.

Thanks,

Ed

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants