Request for comment on this line

[rkarthick]

Thank you so much for your work on this tool.

Could you please add a comment to this line?

redcon/redcon.go

Line 28 in 52d396e

const maxBufferCap = 262144

Is it to ensure buffer cap is bounded? Curious to understand if you have seen an issue in production that triggered this change.

Thanks!

[Fusl]

redcon temporarily buffers all written data in w.b (a []byte, not an actual bytes.Buffer) of the Writer before writing it to the client during a Flush() operation. maxBufferCap is to ensure that if the temporary internal buffer ever grows above 256KiB, memory from this buffer is afterwards released again during a next run of the garbage collector:

// Flush writes all unflushed Write* calls to the underlying writer.
func (w *Writer) Flush() error {
	if w.err != nil {
		return w.err
	}
	_, w.err = w.w.Write(w.b)
	if cap(w.b) > maxBufferCap || w.err != nil {
		w.b = nil // <- frees memory during the next gc run
	} else {
		w.b = w.b[:0] // <- just resets the write cursor/length back to 0 without freeing memory
	}
	return w.err
}