增加查询等待中的任务数量的方法

Author: FishGoddess

FUTURE.md

@@ -8,7 +8,7 @@
 * [ ] 支持任务数量优先调度策略
 * [ ] 支持任务时间优先调度策略
 * [ ] 支持 worker 动态扩缩容
-* [x] 支持查询当前的 worker 数量
+* [x] 支持查询可用的 worker 数量
 * [x] 支持设置 worker 任务队列大小
 * [x] 支持设置 panic 处理函数
 * [x] 支持自定义 sync.Locker 实现

README.en.md

@@ -15,7 +15,7 @@
 * Limits the number of simultaneous goroutines and reuses them by Executor.
 * Supports multiple scheduling strategies, including round robin, random, etc.
 * Supports spin lock with backoff strategy.
-* Supports getting the number of workers in the executor.
+* Supports getting the number of workers available in the executor.
 
 _Check [HISTORY.md](./HISTORY.md) and [FUTURE.md](./FUTURE.md) to know about more information._
 

README.md

@@ -15,7 +15,7 @@
 * 支持限制同时执行的协程数，且复用协程，使用 Executor。
 * 支持多种调度策略，包括轮询、随机等。
 * 支持使用退避策略的自旋锁。
-* 支持查询当前的 worker 数量。
+* 支持查询可用的 worker 数量。
 
 _历史版本的特性请查看 [HISTORY.md](./HISTORY.md)。未来版本的新特性和计划请查看 [FUTURE.md](./FUTURE.md)。_
 

executor.go

@@ -62,8 +62,8 @@ func NewExecutor(workerNum int, opts ...Option) *Executor {
 	return executor
 }
 
-// WorkerNum returns the number of workers in the executor.
-func (e *Executor) WorkerNum() int {
+// AvailableWorkers returns the number of workers available in the executor.
+func (e *Executor) AvailableWorkers() int {
 	e.lock.Lock()
 	defer e.lock.Unlock()
 
@@ -102,6 +102,6 @@ func (e *Executor) Close() {
 		worker.Done()
 	}
 
-	e.wg.Wait()
+	e.Wait()
 	e.closed = true
 }

executor_test.go

@@ -68,15 +68,15 @@ func TestExecutorError(t *testing.T) {
 	}
 }
 
-// go test -v -cover -run=^TestExecutorWorkerNum$
-func TestExecutorWorkerNum(t *testing.T) {
+// go test -v -cover -run=^TestExecutorAvailableWorkers$
+func TestExecutorAvailableWorkers(t *testing.T) {
 	workerNum := 16
 	workers := make([]*worker, workerNum)
 
 	executor := NewExecutor(workerNum)
 	executor.workers = workers
 
-	if executor.WorkerNum() != workerNum {
-		t.Fatalf("executor.WorkerNum() %d != workerNum %d", executor.WorkerNum(), workerNum)
+	if executor.AvailableWorkers() != workerNum {
+		t.Fatalf("executor.AvailableWorkers() %d != workerNum %d", executor.AvailableWorkers(), workerNum)
 	}
 }

worker.go

@@ -27,6 +27,11 @@ func newWorker(executor *Executor) *worker {
 	return w
 }
 
+// WaitingTasks returns the number of tasks waiting in the worker.
+func (w *worker) WaitingTasks() int {
+	return len(w.taskQueue)
+}
+
 func (w *worker) handle(task Task) {
 	defer func() {
 		if r := recover(); r != nil {

worker_test.go

@@ -37,3 +37,28 @@ func TestWorkerHandle(t *testing.T) {
 		t.Fatalf("got %d != want %d", got, want)
 	}
 }
+
+// go test -v -cover -run=^TestWorkerWaitingTasks$
+func TestWorkerWaitingTasks(t *testing.T) {
+	taskQueue := make(chan Task, 4)
+	worker := &worker{taskQueue: taskQueue}
+
+	if worker.WaitingTasks() != len(taskQueue) {
+		t.Fatalf("got %d != want %d", worker.WaitingTasks(), len(taskQueue))
+	}
+
+	if worker.WaitingTasks() != 0 {
+		t.Fatalf("got %d != 0", worker.WaitingTasks())
+	}
+
+	taskQueue <- nil
+	taskQueue <- nil
+
+	if worker.WaitingTasks() != len(taskQueue) {
+		t.Fatalf("got %d != want %d", worker.WaitingTasks(), len(taskQueue))
+	}
+
+	if worker.WaitingTasks() != 2 {
+		t.Fatalf("got %d != 2", worker.WaitingTasks())
+	}
+}