Comments

Author: bbrockbernd

atomicfu/src/commonMain/kotlin/kotlinx/atomicfu/locks/SynchronousMutex.kt

@@ -37,7 +37,14 @@ expect class SynchronousMutex() {
      * lock acquisition.     
      */
     fun tryLock(): Boolean
-    
+
+    /**
+     * Tries to lock this mutex within the given [timeout] period, 
+     * returning `false` if the duration passed without locking.
+     * 
+     * Note: when [tryLock] succeeds the lock needs to be released by [unlock].
+     * When [tryLock] does not succeed the lock does not have to be released.
+     */
     fun tryLock(timeout: Duration): Boolean
 
     /**

atomicfu/src/concurrentMain/kotlin/kotlinx/atomicfu/locks/Mutex.kt

@@ -5,14 +5,16 @@ import kotlinx.atomicfu.atomic
 import kotlin.time.Duration
 import kotlin.time.TimeSource
 
+/**
+ * Mutex implementation for Kotlin/Native.
+ * In concurrentMain sourceSet to be testable with Lincheck.
+ * [park] and [unpark] functions can be passed for testability.
+ */
 internal class NativeMutex(
     val park : (Duration) -> Unit = { ParkingSupport.park(it) },
     val unpark : (ParkingHandle) -> Unit = ParkingSupport::unpark,
 ) {
     /**
-     * Mutex implementation for Kotlin/Native.
-     * In concurrentMain sourceSet to be testable with Lincheck.
-     *
      * The [state] variable stands for: 0 -> Lock is free
      *                                  1 -> Lock is locked but no waiters
      *                                  4 -> Lock is locked with 3 waiters