Updated docs.

Author: hinoshiba

docs/Finish.md

@@ -0,0 +1,50 @@
+# type Finish
+特定のgorotineから、全部のgoroutineを完了させるためのモジュールです。  
+Missionの軽量版で、完了通知に特化した機能のみを有します。  
+Doneを持たせたgoroutine全てに対して、どこかのgoroutineから一度に完了を通知することができます。  
+
+context.Contextで同様のことを行う場合、Doneの活用されかたによってpanicする問題があります。  
+Doneは上記問題を解決しつつ、goroutineの完了通知処理だけに特化したモジュールです。  
+
+go標準のcontext.Contextとの違いは以下の通り
+* 複数の箇所から完了通知が可能
+* 完了通知以外の機能を有さない
+
+## import
+```go
+import "github.com/l4go/task"
+```
+vendoringして使うことを推奨します。
+
+## 機能の概略
+Finishが、提供する機能です。
+
+1. Done()メソッドで、全てのDone待ちに完了を通知します。
+1. 完了の通知をRecvDone()で受け取って、処理の完了を実装できるようにしています。
+	* なお、受け取った側の処理の完了を通知元のgoroutineで待ちたい場合は、より高機能な[task.Mission](./Mission.md) を用いる必要があります
+
+sync.WaitGroupでは、生成タスク数が未定の場合、複数タスク生成完了前に生成済みタスクがすべて完了すると、間違った完了通知が起こる問題があります。  
+この問題への対策が、子供のタスク完了の通知を遅延する機能です。
+
+## 利用サンプル
+複数のworkerがある構造のgoroutineに完了処理を実装したコードサンプルです。  
+
+[example](../examples/ex_finish/ex_finish.go)
+
+## メソッド概略
+
+### func NewFinish() \*Finish
+
+Finishを生成します。
+
+### func (f \*Finish) Done()
+
+完了を通知します。  
+
+### func (f \*Finish) RecvDone() <-chan struct{}
+
+完了を通知するchannelを取得します。
+
+### func (f \*Finish) AsContext() \*context.Context
+
+Finishをgo標準のcontext\.Contextインタフェース互換形式に変換します。

docs/README.md

@@ -3,15 +3,20 @@
 goroutineの処理(task)の管理を支援するモジュール群です。
 
 * [task.Mission](Mission.md)
-    * 親子関係のあるgoroutine群の終了管理を、簡素かつ柔軟に行うためのモジュールです。
+    * 親子関係のあるgoroutine群の完了管理を、簡素かつ柔軟に行うためのモジュールです。
 * [task.Cancel](Cancel.md)
     * 1つのgoroutineから、複数のgoroutineのキャンセルを行うためのモジュールです。
+* [task.Finish](Finish.md)
+    * 1つのgoroutineから、複数のgoroutineの完了を行うためのモジュールです。
 * [task.Pool](Pool.md)
     * goroutine pool(thread poolのgoroutine版)を実装するモジュールです。
 
 # type task.Canceller interface
 task.Cancelおよびtask.Missionのキャンセル機能のみを取り出した互換コード用のinterface(task.Cancelおよびtask.Missionから変換可能)
 
+# type task.Finisher interface
+task.Finishおよびtask.Missionの完了機能のみを取り出した互換コード用のinterface(task.Finishおよびtask.Missionから変換可能)
+
 # func task.IsCanceled(cc task.Canceller) bool
 キャンセルの有無を確認します。task.Cancelおよびtask.Missionの両方に利用できます。  
 処理を開始する前に実施の判断をしたい時に利用します。

examples/ex_finish/ex_finish.go

@@ -0,0 +1,52 @@
+package main
+
+import (
+	"log"
+	"time"
+
+	"github.com/l4go/task"
+	"github.com/l4go/timer"
+)
+
+const (
+	WORKERS = 3
+)
+
+func main() {
+	log.Println("START boss")
+	defer log.Println("END boss")
+
+	f := task.NewFinish()
+
+	w := WORKERS
+	for w > 0 {
+		go worker(f)
+		w --
+	}
+
+	select {
+	case <-f.RecvDone():
+		log.Println("Got 'done' from worker!!")
+	}
+	tm := timer.NewTimer()
+	defer tm.Stop()
+	tm.Start(time.Second * 3)
+	<-tm.Recv()
+}
+
+func worker(f task.Finisher) {
+	log.Println("START worker")
+	defer log.Println("END worker")
+
+	tm := timer.NewTimer()
+	defer tm.Stop()
+	tm.Start(time.Second * 3)
+	select {
+	case <-f.RecvDone():
+		log.Println("Got 'done' from other one!!")
+		return
+	case <- tm.Recv():
+		log.Println("Worked!!")
+	}
+	f.Done()
+}