feat: implement configurable ping timeout for nhooyr.io/websocket
#113
Conversation
This file contains 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
denopink
commented
May 2, 2024
denopink
force-pushed
the
denopink/feat/configurable-ping-timeout
branch
from
6decc55 to
67a106f
Compare
- added `pingTimeout time.Duration` to `internal/nhooyr.io/websocket/conn.go`'s `Conn struct` - implemented `SetPingTimeout`, following how `nhooyr.io/websocket` exposes configurable conn values - if `conn`'s `pingTimeout` is nonpositive, then use `handleControl`'s 5 second timeout https://github.com/xmidt-org/xmidt-agent/blob/78dffe0cad394ab82f581940e3a8117f04941077/internal/nhooyr.io/websocket/read.go#L301
denopink
force-pushed
the
denopink/feat/configurable-ping-timeout
branch
from
67a106f to
924a2c6
Compare
denopink
changed the title
nhooyr.io/websocket #88nhooyr.io/websocket #83
denopink
changed the title
nhooyr.io/websocket #83nhooyr.io/websocket
denopink
commented
May 3, 2024
denopink
commented
May 3, 2024
denopink
commented
May 3, 2024
denopink
commented
May 3, 2024
denopink
commented
May 3, 2024
denopink
commented
May 6, 2024
Comment on lines
-160
to
+163
| writeErr := c.writeControl(context.Background(), opClose, p) | ||
| ctx, cancel := context.WithTimeout(context.Background(), time.Second*5) | ||
| defer cancel() | ||
|
|
||
| writeErr := c.writeControl(ctx, opClose, p) |
There was a problem hiding this comment.
c.writeControl uses the 5 seconds default timeout
denopink
commented
May 6, 2024
Comment on lines
-238
to
237
| ctx, cancel := context.WithTimeout(ctx, time.Second*5) | ||
| defer cancel() | ||
|
|
||
| _, err := c.writeFrame(ctx, true, false, opcode, p) |
There was a problem hiding this comment.
this default time.Second*5 is only used here https://github.com/xmidt-org/xmidt-agent/pull/113/files#r1591363724
denopink
commented
May 9, 2024
Comment on lines
+98
to
+104
| // SetPingTimeout sets the maximum time allowed between PINGs for the connection | ||
| // before the connection is closed. | ||
| // Nonpositive PingTimeout will default to handleControl's 5 second timeout. | ||
| func (c *Conn) SetPingTimeout(d time.Duration) { | ||
| c.pingTimeout = d | ||
| } | ||
|
|
There was a problem hiding this comment.
following how nhooyr.io/websocket exposes configurable conn values
denopink
commented
May 9, 2024
Comment on lines
+237
to
+239
| if ctx.Err() != nil { | ||
| return | ||
| } |
There was a problem hiding this comment.
in case of timeouts/cancels
schmidtw
approved these changes
May 15, 2024
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.
implements #83 #88
pingTimeouttointernal/nhooyr.io/websocket/conn.go'sConn struct.