Add a note about Nagle's algorithm on the SSL_connect man page#6143
Closed
mattcaswell wants to merge 2 commits intoopenssl:masterfrom
Closed
Add a note about Nagle's algorithm on the SSL_connect man page#6143mattcaswell wants to merge 2 commits intoopenssl:masterfrom
mattcaswell wants to merge 2 commits intoopenssl:masterfrom
Conversation
mattcaswell
added
branch: master
dot-asm
reviewed
May 1, 2018
doc/man3/SSL_connect.pod
Outdated
|
|
||
| In many operating systems the TCP_NODELAY socket option is available to disable | ||
| Nagle's algorithm. If an application opts to disable Nagle's algorithm | ||
| consideration should be given to turning it back on again later if appropriate. |
Contributor
There was a problem hiding this comment.
There is convenience BIO_set_tcp_ndelay, which would be appropriate to mention here.
Contributor
There was a problem hiding this comment.
On hardly related note, #if-spaghetti in BIO_set_tcp_ndelay formally opens for uninitialized variable use. It might be more appropriate to add #error directive as last resort option...
Member
Author
There was a problem hiding this comment.
I added a sentence mentioning it.
richsalz
suggested changes
May 1, 2018
doc/man3/SSL_connect.pod
Outdated
| condition. When using a buffering BIO, like a BIO pair, data must be written | ||
| into or retrieved out of the BIO before being able to continue. | ||
|
|
||
| Many OSes implement Nagle's algorithm by default which means that the OS will |
Contributor
There was a problem hiding this comment.
s/OSes/system/ or platforms
s/the OS/it/
doc/man3/SSL_connect.pod
Outdated
| impacts after a successful TLSv1.3 handshake or a successful TLSv1.2 (or below) | ||
| resumption handshake because the last peer to communicate in the handshake is | ||
| the client. If the client is also the first to send application data (as is | ||
| typical for many protocols) then this data could be buffered by the OS until an |
doc/man3/SSL_connect.pod
Outdated
| typical for many protocols) then this data could be buffered by the OS until an | ||
| ACK has been received for the final handshake message. | ||
|
|
||
| In many operating systems the TCP_NODELAY socket option is available to disable |
Contributor
There was a problem hiding this comment.
The B<TCP_NODELAY> option is often available
doc/man3/SSL_connect.pod
Outdated
| buffer outgoing TCP data if a TCP packet has already been sent for which no | ||
| corresponding ACK has been received yet from the peer. This can have performance | ||
| impacts after a successful TLSv1.3 handshake or a successful TLSv1.2 (or below) | ||
| resumption handshake because the last peer to communicate in the handshake is |
Contributor
There was a problem hiding this comment.
that's a long sentence, perhaps a comma after handshake
Member
Author
|
I pushed a fixup commit addressing all of the above comments. |
richsalz
approved these changes
May 1, 2018
richsalz
added
the
approval: done
kaduk
approved these changes
May 1, 2018
Member
Author
|
Pushed. Thanks. |
levitte
pushed a commit
that referenced
this pull request
May 2, 2018
Fixes #4237 Reviewed-by: Rich Salz <[email protected]> Reviewed-by: Ben Kaduk <[email protected]> (Merged from #6143)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #4237