Merge pull request #105 from dominicm/queue_return_items_disposed

Return items disposed when disposing queue

Author: dustinhiatt-wf

queue/queue.go

@@ -276,9 +276,10 @@ func (q *Queue) Disposed() bool {
 	return q.disposed
 }
 
-// Dispose will dispose of this queue.  Any subsequent
-// calls to Get or Put will return an error.
-func (q *Queue) Dispose() {
+// Dispose will dispose of this queue and returns
+// the items disposed. Any subsequent calls to Get
+// or Put will return an error.
+func (q *Queue) Dispose() []interface{} {
 	q.lock.Lock()
 	defer q.lock.Unlock()
 
@@ -288,8 +289,12 @@ func (q *Queue) Dispose() {
 		waiter.ready <- true
 	}
 
+	disposedItems := q.items
+
 	q.items = nil
 	q.waiters = nil
+
+	return disposedItems
 }
 
 // New is a constructor for a new threadsafe queue.

queue/queue_test.go

@@ -210,6 +210,26 @@ func TestMultipleGetEmpty(t *testing.T) {
 	}
 }
 
+func TestDispose(t *testing.T) {
+	// when the queue is empty
+	q := New(10)
+	itemsDisposed := q.Dispose()
+
+	assert.Empty(t, itemsDisposed)
+
+	// when the queue is not empty
+	q = New(10)
+	q.Put(`1`)
+	itemsDisposed = q.Dispose()
+
+	expected := []interface{}{`1`}
+	assert.Equal(t, expected, itemsDisposed)
+
+	// when the queue has been disposed
+	itemsDisposed = q.Dispose()
+	assert.Nil(t, itemsDisposed)
+}
+
 func TestEmptyGetWithDispose(t *testing.T) {
 	q := New(10)
 	var wg sync.WaitGroup