Add timeout support to flushSendBuffer()#575
Open
awelzel wants to merge 1 commit into
Open
Conversation
When sending a lot of data to a client that does not reliably drain its
own socket, it can happen that 1) the thread on the server doing the
sending blocks in flushSendBuffer(). Additionally, the "receiver" thread
of WebSocket::run() on the server blocks in WebSocketTransport::poll() ->
sendHeartBeat() -> flushSendBuffer(). Because now WebSocket::run() is blocked,
it never reads data form the client, this can result in a deadlock scenario:
server: blocks sending to client in flushSendBuffer()
client: also blocked while sending to server (WebSocket::run() never receives)
The clients could unblock the situation if it receives from its socket.
If the client doesn't do so, this change allows the server to close the
socket after a configurable timeout that is honored during
flushSendBuffer(). The callback will see "Send timeout" as close reason
and an abnormal close code.
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.
When sending a lot of data to a client that does not reliably drain its own socket, it can happen that 1) the thread on the server doing the sending blocks in flushSendBuffer(). Additionally, the "receiver" thread of WebSocket::run() on the server blocks in WebSocketTransport::poll() -> sendHeartBeat() -> flushSendBuffer(). Because now WebSocket::run() is blocked, it never reads data form the client, this can result in a deadlock scenario:
The clients could unblock the situation if it receives from its socket. If the client doesn't do so, this change allows the server to close the socket after a configurable timeout that is honored during flushSendBuffer(). The callback will see "Send timeout" as close reason and an abnormal close code.
I've ran into this a few times during development/testing and forcefully disconnecting the client after 5 seconds or so and logging the reason in the server logs is a better experience than observing a "freeze" and looking with gdb what the thread stacks look like :-)