Merge pull request #794 from devlights/add-cancallable-sleep

Author: devlights

examples/basic/times/README.md

@@ -26,3 +26,5 @@
 | time_format_microsecond.go | time_format_microsecond  | time.Format() にてマイクロ秒を出力するサンプルす。                                    |
 | time_calc_nextmonth.go     | time_calc_nextmonth      | 翌月の日付を求めるサンプルです                                                        |
 | time_daysinmonth.go        | time_daysinmonth         | 月の日数を求めるサンプルです                                                          |
+| time_sleep.go              | time_sleep               | time.Sleep() のサンプルです。                                                         |
+| time_cancellable_sleep.go  | time_cancellable_sleep   | キャンセル可能なスリープ処理のサンプルです。                                          |

examples/basic/times/examples.go

@@ -36,4 +36,6 @@ func (r *register) Regist(m mapping.ExampleMapping) {
 	m["time_format_microsecond"] = FormatMicrosecond
 	m["time_calc_nextmonth"] = CalcNextMonth
 	m["time_daysinmonth"] = DaysInMonth
+	m["time_sleep"] = Sleep
+	m["time_cancellable_sleep"] = CancellableSleep
 }

examples/basic/times/time_cancallable_sleep.go

@@ -0,0 +1,63 @@
+package times
+
+import (
+	"context"
+	"time"
+
+	"github.com/devlights/gomy/output"
+)
+
+// CancellableSleep は、キャンセル可能なスリープ処理のサンプルです。
+//
+// time.Sleep() は、ブロックしてしまうためキャンセル可能な状態で
+// スリープ処理を行いたい場合は、time.Tickerを利用して処理する。
+//
+// # REFERENCES
+//   - https://pkg.go.dev/time@go1.22.2#NewTicker
+func CancellableSleep() error {
+	const (
+		timeFormat = time.TimeOnly + ".000"
+	)
+
+	var (
+		ctx, cxl = context.WithTimeout(context.Background(), 3500*time.Millisecond)
+		ticker   = time.NewTimer(5 * time.Second)
+	)
+	defer cxl()
+	defer ticker.Stop()
+
+	output.Stdoutl("[begin]", time.Now().Format(timeFormat))
+	defer func() { output.Stdoutl("[end  ]", time.Now().Format(timeFormat)) }()
+
+	//
+	// 以下は5秒間スリープする処理があるとして、3.5秒でキャンセルします。
+	// time.Sleep(5 * time.Second) とすると 5秒間 ブロックされますが
+	// context.Context と *time.Ticker.C を利用してselectで待機するようにしているため
+	// 先に完了した方で抜けていきます。
+	//
+	select {
+	case <-ctx.Done():
+		output.Stdoutl("[cancel]", ctx.Err())
+	case <-ticker.C:
+		output.Stdoutl("[sleep]", "done")
+	}
+
+	return nil
+
+	/*
+	   $ task
+	   task: [build] go build .
+	   task: [run] ./try-golang -onetime
+
+	   ENTER EXAMPLE NAME: time_cancellable_sleep
+
+	   [Name] "time_cancellable_sleep"
+	   [begin]              07:33:29.449
+	   [cancel]             context deadline exceeded
+	   [end  ]              07:33:32.951
+
+
+	   [Elapsed] 3.502395005s
+	*/
+
+}

examples/basic/times/time_sleep.go

@@ -0,0 +1,48 @@
+package times
+
+import (
+	"time"
+
+	"github.com/devlights/gomy/output"
+)
+
+// Sleep は、time.Sleep() のサンプルです。
+//
+// > Sleep pauses the current goroutine for at least the duration d. A negative or zero duration causes Sleep to return immediately.
+//
+// > スリープは、少なくとも継続時間dの間、現在のゴルーチンを一時停止します。継続時間が負またはゼロの場合、スリープは即座に戻ります。
+//
+// # REFERENCES
+//   - https://pkg.go.dev/time@go1.22.2#Sleep
+func Sleep() error {
+	const (
+		timeFormat = time.TimeOnly + ".000"
+	)
+
+	//
+	// time.Sleep() は、他の言語のSleep関数と同じ挙動。
+	// 指定した時間分、現在のスレッドをブロックする。
+	//
+	output.Stdoutl("[begin]", time.Now().Format(timeFormat))
+	defer func() { output.Stdoutl("[end]", time.Now().Format(timeFormat)) }()
+
+	time.Sleep(3 * time.Second)
+
+	return nil
+
+	/*
+	   $ task
+	   task: [build] go build .
+	   task: [run] ./try-golang -onetime
+
+	   ENTER EXAMPLE NAME: time_sleep
+
+	   [Name] "time_sleep"
+	   [begin]              07:32:51.959
+	   [end]                07:32:54.960
+
+
+	   [Elapsed] 3.000651935s
+	*/
+
+}