redis/go-redis
1
0
Fork 0
mirror of https://github.com/redis/go-redis.git synced 2025-10-23 08:08:28 +03:00
Code Activity

add design decision comment

Browse Source
This commit is contained in:
Nedyalko Dyakov
2025-10-15 14:51:18 +03:00
parent 90bfdb3aa3
commit 07283ecfc6
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
redis.go
View File

@@ -319,9 +319,15 @@ func (c *baseClient) connReAuthCredentialsListener(poolCn *pool.Conn) (auth.Cred
c.reAuthConnection(),
c.onAuthenticationErr(),
)
// main case where the connection can be stuck in the listener for a long time is when we have a handoff
// so we set the checkUsableTimeout to the handoff timeout if maintnotifications are enabled
// the default timeout if no maintnotifications config is provided is 1 second
// Design decision: The main case we expect the connection to be in a non-usable state is when it is being reconnected
// during a handoff from maintnotifications.
// Setting the checkUsableTimeout to the handoff timeout if maintnotifications are enabled
// the default timeout if no maintnotifications are disabled is going to be 1 second.
//
// Note: Due to the auto by default mode of MaintNotificationsConfig
// the timeout for the first connection will probably be the value of MaintNotificationsConfig.HandoffTimeout
// (15s by default) which is not ideal if maintnotifications are not needed, but safer than timing out in the case
// of enabling maintnotifications later.
if c.opt.MaintNotificationsConfig != nil && c.opt.MaintNotificationsConfig.Mode != maintnotifications.ModeDisabled {
newCredListener.SetCheckUsableTimeout(c.opt.MaintNotificationsConfig.HandoffTimeout)
}