Improve docs for http/connection-pool's HTTP/2 support and ALPN config
#729
Conversation
|
Are you sure you want to mandate ALPN and update the docs, instead of updating the code? |
I think we should close the documentation PR and aim at updating the code with the snippet above. |
No I would prefer to update the code, as well. Will prepare a patch for that separately and once it's landed, we can get back to the doc update here.
The doc update is mostly orthogonal, only the wording about the ALPN config requirement would have to be changed once we've made it (more) optional again. |
DerGuteMoritz
force-pushed
the
727/improve-docs
branch
from
5e71c68 to
cb5c03e
Compare
src/aleph/netty.clj
Outdated
| Takes a vector of HTTP versions, in order of preference. E.g., `[:http2 :http1]` | ||
|
|
||
| Note that the returned config uses `SelectorFailureBehavior.NO_ADVERTISE`[1] and | ||
| `SelectedListenerFailureBehavior.ACCEPT`[2] since these are the only failure behaviors | ||
| supported by all SSL providers. See their documentation for details. One important | ||
| consequence of this is that it's not possible to completely opt out of HTTP/1.1 by way of | ||
| only specifying `[:http2]`. | ||
|
|
||
| 1: https://netty.io/4.1/api/io/netty/handler/ssl/ApplicationProtocolConfig.SelectorFailureBehavior.html#NO_ADVERTISE | ||
| 2: https://netty.io/4.1/api/io/netty/handler/ssl/ApplicationProtocolConfig.SelectedListenerFailureBehavior.html#ACCEPT" |
There was a problem hiding this comment.
Maybe add a line to the effect of: "If you want this behavior, you will need to supply an SslContext with a different config."
There was a problem hiding this comment.
Done via 439214b -- I made it about ApplicationProtocolConfig instead since it can also be used with an ssl-context options map, custom SslContext isn't even required.
DerGuteMoritz
force-pushed
the
727/improve-docs
branch
from
5caa131 to
7b562ae
Compare
Prompted by #727