Add TLSSocket.applicationProtocolOption and better docs for TLSSocket.applicationProtocol
#3215
Conversation
…ket.applicationProtocol`
| /** Provides access to the current application protocol that has been negotiated. | ||
| * | ||
| * Raises a [[NoSuchElementException]] if it has not yet been determined if application protocols might | ||
| * be used for this connection. See [[applicationProtocolOption]] for a safer option. | ||
| * | ||
| * @see https://discord.com/channels/632277896739946517/632310980449402880/1100649913223745597 | ||
| */ | ||
| def applicationProtocol: F[String] |
There was a problem hiding this comment.
I think we can even deprecate this API to encourage the other one :)
Not sure about linking to Discord. We should record anything important either in discussion on this PR or in code / comments themselves.
There was a problem hiding this comment.
In my experience linking to Discord gives the perspective on back-and-forth that we had until we arrived at this. It's not super important, but it might give some insight into the context for a person looking at it.
| */ | ||
| def applicationProtocol: F[String] | ||
|
|
||
| /** Provides access to the current application protocol that has been negotiated. | ||
| * | ||
| * Returns [[None]] if it has not yet been determined if application protocols might be used for this connection. |
There was a problem hiding this comment.
Maybe we should include the bit about the empty String? Actually, this almost deserves its own ADT but I'm not sure if it's worth it 🤔 or, maybe that case should be mapped to None as well? I'm not sure if there is a meaningful distinction.
null if it has not yet been determined if application protocols might be used for this connection, an empty String if application protocols values will not be used, or a non-empty application protocol String if a value was successfully negotiated.
| def applicationProtocol: F[String] | ||
| /** Returns [[None]] if there is no protocol being negotiated. | ||
| * | ||
| * @see [[https://aws.github.io/s2n-tls/doxygen/s2n_8h.html#ae53faa26669e258afff875d45140f14e]] |
There was a problem hiding this comment.
The doc says:
In the event of no protocol being negotiated, NULL is returned.
Is this actually equivalent to the empty string "" case on the JVM? I'm not sure. On the JVM None is if it's not yet determined, but "" is if it's not being used (not being negotiated?).
There was a problem hiding this comment.
I am even less qualified to answer this question, not familiar with TLS enough :)
See https://discord.com/channels/632277896739946517/632310980449402880/1100649913223745597