Skip to content

Commit

Permalink
Update README.md - clarify timeout toxic behavior (#598)
Browse files Browse the repository at this point in the history
The code for the timeout toxic when timeout is set to zero simply reads from the input and then if it gets some data just has a comment: "// Drop the data on the ground".  This change updates the docs do indicate the data is dropped, not delayed, until the texic is removed.
  • Loading branch information
bjornbyte authored Nov 3, 2024
1 parent 519deae commit 1c8b9b1
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -413,7 +413,7 @@ Attributes:
#### timeout

Stops all data from getting through, and closes the connection after `timeout`. If
`timeout` is 0, the connection won't close, and data will be delayed until the
`timeout` is 0, the connection won't close, and data will be dropped until the
toxic is removed.

Attributes:
Expand Down

0 comments on commit 1c8b9b1

Please sign in to comment.