Merge pull request #774 from devlights/add-mutex-trylock-example

Author: devlights

examples/basic/syncs/README.md

@@ -2,19 +2,20 @@
 
 このディレクトリには以下のサンプルがあります。
 
-| file                      | example name                  | note                                            |
-|---------------------------|-------------------------------|-------------------------------------------------|
-| atomic\_add.go            | syncs\_atomic\_add            | atomic.AddXXX のサンプルです                           |
-| atomic\_compareandswap.go | syncs\_atomic\_compareandswap | sync/atomic.CompareAndSwap のサンプルです              |
-| atomic\_types.go          | syncs\_atomic\_types          | Go 1.19 から追加された sync/atomic パッケージ内の型についてのサンプルです |
-| use\_map.go               | syncs\_use\_map               | sync.Mapの使い方とそれをラップした型の紹介です                     |
-| no\_sync.go               | syncs\_no\_sync               | 同期なしで非同期処理をしているサンプルです                           |
-| use\_channel.go           | syncs\_use\_channel           | 値の同期をチャネルを使って実現しているサンプルです                       |
-| use\_cond\_broadcast.go   | syncs\_use\_cond\_broadcast   | sync.Cond.Broadcast() のサンプルです                   |
-| use\_cond\_siginal.go     | syncs\_use\_cond\_signal      | sync.Cond.Signal() のサンプルです                      |
-| use\_mutex.go             | syncs\_use\_mutex             | sync.Mutex のサンプルです                              |
-| use\_once.go              | syncs\_use\_once              | sync.Onceのサンプルです                                |
-| use\_oncefunc.go          | syncs\_use\_oncefunc          | Go 1.21 で追加された sync.OnceFunc() のサンプルです          |
-| use\_oncevalue.go         | syncs\_use\_oncevalue         | Go 1.21 で追加された sync.OnceValue() のサンプルです         |
-| use\_oncevalues.go        | syncs\_use\_oncevalues        | Go 1.21 で追加された sync.OnceValues() のサンプルです        |
-| use\_pool.go              | syncs\_use\_pool              | sync.Poolのサンプルです                                |
+| file                     | example name                | note                                                                      |
+| ------------------------ | --------------------------- | ------------------------------------------------------------------------- |
+| atomic_add.go            | syncs_atomic_add            | atomic.AddXXX のサンプルです                                              |
+| atomic_compareandswap.go | syncs_atomic_compareandswap | sync/atomic.CompareAndSwap のサンプルです                                 |
+| atomic_types.go          | syncs_atomic_types          | Go 1.19 から追加された sync/atomic パッケージ内の型についてのサンプルです |
+| use_map.go               | syncs_use_map               | sync.Mapの使い方とそれをラップした型の紹介です                            |
+| no_sync.go               | syncs_no_sync               | 同期なしで非同期処理をしているサンプルです                                |
+| use_channel.go           | syncs_use_channel           | 値の同期をチャネルを使って実現しているサンプルです                        |
+| use_cond_broadcast.go    | syncs_use_cond_broadcast    | sync.Cond.Broadcast() のサンプルです                                      |
+| use_cond_siginal.go      | syncs_use_cond_signal       | sync.Cond.Signal() のサンプルです                                         |
+| use_mutex.go             | syncs_use_mutex             | sync.Mutex のサンプルです                                                 |
+| use_once.go              | syncs_use_once              | sync.Onceのサンプルです                                                   |
+| use_oncefunc.go          | syncs_use_oncefunc          | Go 1.21 で追加された sync.OnceFunc() のサンプルです                       |
+| use_oncevalue.go         | syncs_use_oncevalue         | Go 1.21 で追加された sync.OnceValue() のサンプルです                      |
+| use_oncevalues.go        | syncs_use_oncevalues        | Go 1.21 で追加された sync.OnceValues() のサンプルです                     |
+| use_pool.go              | syncs_use_pool              | sync.Poolのサンプルです                                                   |
+| mutex_trylock.go         | syncs_mutex_trylock         | Go 1.18 で追加された mutex.TryLock() についてのサンプルです。             |

examples/basic/syncs/examples.go

@@ -27,4 +27,5 @@ func (r *register) Regist(m mapping.ExampleMapping) {
 	m["syncs_use_oncevalue"] = UseOnceValue
 	m["syncs_use_oncevalues"] = UseOnceValues
 	m["syncs_use_pool"] = UsePool
+	m["syncs_mutex_trylock"] = MutexTryLock
 }

examples/basic/syncs/mutex_trylock.go

@@ -0,0 +1,52 @@
+package syncs
+
+import (
+	"sync"
+	"time"
+
+	"github.com/devlights/gomy/output"
+)
+
+// MutexTryLock は、Go 1.18 で追加された mutex.TryLock() についてのサンプルです。
+//
+// > TryLock tries to lock m and reports whether it succeeded.
+//
+// > (TryLockはmをロックしようとし、成功したかどうかを報告します。)
+//
+// # REFERENCES
+//
+//   - https://pkg.go.dev/sync@go1.22.1#Mutex.TryLock
+func MutexTryLock() error {
+	const (
+		WAIT_SECS = 5
+	)
+
+	var (
+		m         sync.Mutex
+		start     = make(chan struct{})
+		lock5secs = func() {
+			m.Lock()
+			defer m.Unlock()
+
+			close(start)
+			time.Sleep(WAIT_SECS * time.Second)
+		}
+		printStatus = func() {
+			output.Stdoutf("[TryLock]", "%s\tTryLock=%v\n", time.Now().Format(time.TimeOnly), m.TryLock())
+		}
+	)
+
+	// 5秒間 mutex をロックし続ける
+	go lock5secs()
+	<-start
+
+	for range WAIT_SECS {
+		printStatus()
+		time.Sleep(1 * time.Second)
+	}
+
+	// ここは mutex がアンロックされているのでロックが取れる
+	printStatus()
+
+	return nil
+}