Close the socket gracefully on Windows#284
Merged
shibd merged 2 commits intoJun 20, 2023
Merged
Conversation
Fixes apache#261 ### Motivation When closing the socket on Windows, the `ERROR_CONNECTION_ABORTED` error might be returned in the callback of `async_receive`. It's caused by the `socket::close` method is not portable enough, see https://www.boost.org/doc/libs/1_81_0/doc/html/boost_asio/reference/basic_stream_socket/close/overload2.html > For portable behaviour with respect to graceful closure of a connected socket, call shutdown() before closing the socket. ### Modifications Call `shutdown` in `ClientConnection::closeSocket` before calling `close`. In addition, when no bytes are returned or the `eof` error happened, print the logs with debug level whatever the error code is in the read callback.
Contributor
Author
|
Here are some tests results with debug logs based on this patch. Without calling With calling There is a little chance that the error code could be |
shibd
approved these changes
Jun 19, 2023
RobertIndie
approved these changes
Jun 20, 2023
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
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 #261
Motivation
When closing the socket on Windows, the
ERROR_CONNECTION_ABORTEDerror might be returned in the callback ofasync_receive. It's caused by thesocket::closemethod is not portable enough, see https://www.boost.org/doc/libs/1_81_0/doc/html/boost_asio/reference/basic_stream_socket/close/overload2.htmlModifications
Call
shutdowninClientConnection::closeSocketbefore callingclose. In addition, when no bytes are returned or theeoferror happened, print the logs with debug level whatever the error code is in the read callback.Documentation
doc-required(Your PR needs to update docs and you will update later)
doc-not-needed(Please explain why)
doc(Your PR contains doc changes)
doc-complete(Docs have been already added)