Clarify resolution and failure values

amphp · Nov 29, 2017 · afa726d · afa726d
1 parent 2443b33
commit afa726d
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/lib/Mutex.php b/lib/Mutex.php
@@ -15,7 +15,8 @@ interface Mutex {
     /**
      * Acquires a lock on the mutex.
      *
-     * @return \Amp\Promise<\Amp\Sync\Lock> Resolves with a lock object with an ID of 0 when the acquire is successful.
+     * @return \Amp\Promise<\Amp\Sync\Lock> Resolves with a lock object with an ID of 0. May fail with a SyncException
+     *     if an error occurs when attempting to obtain the lock (e.g. a shared memory segment closed).
      */
     public function acquire(): Promise;
 }
diff --git a/lib/Semaphore.php b/lib/Semaphore.php
@@ -15,9 +15,9 @@ interface Semaphore {
     /**
      * Acquires a lock on the semaphore.
      *
-     * @return \Amp\Promise<\Amp\Sync\Lock> Resolves with an integer keyed lock object when the acquire is
-     *    successful. Identifiers returned by the locks should be 0-indexed. Releasing an idenifier MUST make that same
-     *    identifier available.
+     * @return \Amp\Promise<\Amp\Sync\Lock> Resolves with an integer keyed lock object. Identifiers returned by the
+     *    locks should be 0-indexed. Releasing an identifier MUST make that same identifier available. May fail with
+     *    a SyncException if an error occurs when attempting to obtain the lock (e.g. a shared memory segment closed).
      */
     public function acquire(): Promise;
 }