feat: add DisableTCPNoDelay (#650)

* feat: add DisableTCPNoDelay to turn on Nagle's algorithm Signed-off-by: Rueian <[email protected]> * perf: turn off TCP NoDelay on pipeline mode Signed-off-by: Rueian <[email protected]> --------- Signed-off-by: Rueian <[email protected]>
redis · Oct 20, 2024 · 28fba8c · 28fba8c
1 parent 73544b3
commit 28fba8c
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/pipe.go b/pipe.go
@@ -73,6 +73,7 @@ type pipe struct {
 	waits           int32
 	recvs           int32
 	r2ps            bool // identify this pipe is used for resp2 pubsub or not
+	noNoDelay       bool
 }
 
 type pipeFn func(connFn func() (net.Conn, error), option *ClientOption) (p *pipe, err error)
@@ -98,6 +99,7 @@ func _newPipe(connFn func() (net.Conn, error), option *ClientOption, r2ps, nobg
 		timeout:       option.ConnWriteTimeout,
 		pinggap:       option.Dialer.KeepAlive,
 		maxFlushDelay: option.MaxFlushDelay,
+		noNoDelay:     option.DisableTCPNoDelay,
 
 		r2ps: r2ps,
 	}
@@ -321,6 +323,9 @@ func (p *pipe) _exit(err error) {
 
 func (p *pipe) _background() {
 	p.conn.SetDeadline(time.Time{})
+	if conn, ok := p.conn.(*net.TCPConn); ok && p.noNoDelay {
+		conn.SetNoDelay(false)
+	}
 	go func() {
 		p._exit(p._backgroundWrite())
 		close(p.close)

diff --git a/rueidis.go b/rueidis.go
@@ -161,6 +161,11 @@ type ClientOption struct {
 	// produce notable CPU usage reduction under load. Ref: https://github.com/redis/rueidis/issues/156
 	MaxFlushDelay time.Duration
 
+	// DisableTCPNoDelay turns on Nagle's algorithm in pipelining mode by using conn.SetNoDelay(false).
+	// Turning this on can result in lower p99 latencies and lower CPU usages if all your requests are small.
+	// But if you have large requests or fast network, this might degrade the performance. Ref: https://github.com/redis/rueidis/pull/650
+	DisableTCPNoDelay bool
+
 	// ShuffleInit is a handy flag that shuffles the InitAddress after passing to the NewClient() if it is true
 	ShuffleInit bool
 	// ClientNoTouch controls whether commands alter LRU/LFU stats