ringbuffer: discard pending data when buffer is closed (#387)

This commit is contained in:
Alessandro Ros
2023-08-26 17:23:54 +02:00
committed by GitHub
parent bf3de06b3c
commit 04a3c45f60
2 changed files with 26 additions and 19 deletions

View File

@@ -38,7 +38,14 @@ func New(size uint64) (*RingBuffer, error) {
// Close makes Pull() return false.
func (r *RingBuffer) Close() {
r.mutex.Lock()
r.closed = true
// discard pending data to make Pull() exit immediately
for i := uint64(0); i < r.size; i++ {
r.buffer[i] = nil
}
r.mutex.Unlock()
r.cond.Broadcast()
}
@@ -48,6 +55,7 @@ func (r *RingBuffer) Reset() {
for i := uint64(0); i < r.size; i++ {
r.buffer[i] = nil
}
r.writeIndex = 0
r.readIndex = 0
r.closed = false
@@ -64,6 +72,7 @@ func (r *RingBuffer) Push(data interface{}) bool {
r.buffer[r.writeIndex] = data
r.writeIndex = (r.writeIndex + 1) % r.size
r.mutex.Unlock()
r.cond.Broadcast()

View File

@@ -51,30 +51,28 @@ func TestClose(t *testing.T) {
r, err := New(1024)
require.NoError(t, err)
done := make(chan struct{})
go func() {
defer close(done)
_, ok := r.Pull()
require.Equal(t, true, ok)
_, ok = r.Pull()
require.Equal(t, false, ok)
}()
ok := r.Push([]byte{1, 2, 3, 4})
require.Equal(t, true, ok)
r.Close()
<-done
r.Reset()
ok = r.Push([]byte{5, 6, 7, 8})
require.Equal(t, true, ok)
_, ok = r.Pull()
require.Equal(t, true, ok)
ok = r.Push([]byte{5, 6, 7, 8})
require.Equal(t, true, ok)
r.Close()
_, ok = r.Pull()
require.Equal(t, false, ok)
r.Reset()
ok = r.Push([]byte{9, 10, 11, 12})
require.Equal(t, true, ok)
data, ok := r.Pull()
require.Equal(t, true, ok)
require.Equal(t, []byte{9, 10, 11, 12}, data)
}
func TestOverflow(t *testing.T) {