commit 88a156646fb679ccace5963bd94d6b23abbce39a
author Daniel Petti <djpetti@me.com> Sun Apr 12 17:42:22 2015 -0400
committer Brian Silverman <brians> Mon Apr 13 02:09:07 2015 -0400
tree 4dae3ddacf5dd4ad3174d631fa070f243c77299a
parent 1dfe48bd65494317da1e119cd05a15c58ddfd879

Rename a status enum member for Mutex::TryLock.

I changed it to kLockFailed, because kUnlocked seemed not to be a
particularly descriptive name.

Change-Id: Ifdb2ecbf0837cc4b6c40036eedd35d609ada747f

aos/common/condition_test.cc

diff --git a/aos/common/condition_test.cc b/aos/common/condition_test.cc
index 05990e5..2310273 100644
--- a/aos/common/condition_test.cc
+++ b/aos/common/condition_test.cc
@@ -307,7 +307,7 @@
   Settle();
   shared_->condition.Signal();
   EXPECT_FALSE(child.Hung());
-  EXPECT_EQ(Mutex::State::kUnlocked, shared_->mutex.TryLock());
+  EXPECT_EQ(Mutex::State::kLockFailed, shared_->mutex.TryLock());
 }
 
 // Tests that Signal() stops exactly 1 Wait()er.

aos/common/mutex.h

diff --git a/aos/common/mutex.h b/aos/common/mutex.h
index b952644..ca35b10 100644
--- a/aos/common/mutex.h
+++ b/aos/common/mutex.h
@@ -20,8 +20,12 @@
 // Otherwise, the destructor will LOG(FATAL).
 class Mutex {
  public:
+  // States that signify the result of TryLock.
   enum class State {
-    kLocked, kUnlocked
+    // The mutex was acquired successfully.
+    kLocked,
+    // TryLock tried to grab the mutex and failed.
+    kLockFailed
   };
 
   // Creates an unlocked mutex.

aos/common/mutex_test.cc

diff --git a/aos/common/mutex_test.cc b/aos/common/mutex_test.cc
index 75323c8..6614d5c 100644
--- a/aos/common/mutex_test.cc
+++ b/aos/common/mutex_test.cc
@@ -39,21 +39,21 @@
 
 TEST_F(MutexTest, TryLock) {
   EXPECT_EQ(Mutex::State::kLocked, test_mutex_.TryLock());
-  EXPECT_EQ(Mutex::State::kUnlocked, test_mutex_.TryLock());
+  EXPECT_EQ(Mutex::State::kLockFailed, test_mutex_.TryLock());
 
   test_mutex_.Unlock();
 }
 
 TEST_F(MutexTest, Lock) {
   ASSERT_FALSE(test_mutex_.Lock());
-  EXPECT_EQ(Mutex::State::kUnlocked, test_mutex_.TryLock());
+  EXPECT_EQ(Mutex::State::kLockFailed, test_mutex_.TryLock());
 
   test_mutex_.Unlock();
 }
 
 TEST_F(MutexTest, Unlock) {
   ASSERT_FALSE(test_mutex_.Lock());
-  EXPECT_EQ(Mutex::State::kUnlocked, test_mutex_.TryLock());
+  EXPECT_EQ(Mutex::State::kLockFailed, test_mutex_.TryLock());
   test_mutex_.Unlock();
   EXPECT_EQ(Mutex::State::kLocked, test_mutex_.TryLock());
 
@@ -215,7 +215,7 @@
 TEST_F(MutexLockerTest, Basic) {
   {
     aos::MutexLocker locker(&test_mutex_);
-    EXPECT_EQ(Mutex::State::kUnlocked, test_mutex_.TryLock());
+    EXPECT_EQ(Mutex::State::kLockFailed, test_mutex_.TryLock());
   }
   EXPECT_EQ(Mutex::State::kLocked, test_mutex_.TryLock());
 
@@ -225,7 +225,7 @@
 TEST_F(IPCMutexLockerTest, Basic) {
   {
     aos::IPCMutexLocker locker(&test_mutex_);
-    EXPECT_EQ(Mutex::State::kUnlocked, test_mutex_.TryLock());
+    EXPECT_EQ(Mutex::State::kLockFailed, test_mutex_.TryLock());
     EXPECT_FALSE(locker.owner_died());
   }
   EXPECT_EQ(Mutex::State::kLocked, test_mutex_.TryLock());
@@ -243,7 +243,7 @@
 TEST_F(IPCRecursiveMutexLockerTest, Basic) {
   {
     aos::IPCRecursiveMutexLocker locker(&test_mutex_);
-    EXPECT_EQ(Mutex::State::kUnlocked, test_mutex_.TryLock());
+    EXPECT_EQ(Mutex::State::kLockFailed, test_mutex_.TryLock());
     EXPECT_FALSE(locker.owner_died());
   }
   EXPECT_EQ(Mutex::State::kLocked, test_mutex_.TryLock());
@@ -255,13 +255,13 @@
 TEST_F(IPCRecursiveMutexLockerTest, RecursiveLock) {
   {
     aos::IPCRecursiveMutexLocker locker(&test_mutex_);
-    EXPECT_EQ(Mutex::State::kUnlocked, test_mutex_.TryLock());
+    EXPECT_EQ(Mutex::State::kLockFailed, test_mutex_.TryLock());
     {
       aos::IPCRecursiveMutexLocker locker(&test_mutex_);
-      EXPECT_EQ(Mutex::State::kUnlocked, test_mutex_.TryLock());
+      EXPECT_EQ(Mutex::State::kLockFailed, test_mutex_.TryLock());
       EXPECT_FALSE(locker.owner_died());
     }
-    EXPECT_EQ(Mutex::State::kUnlocked, test_mutex_.TryLock());
+    EXPECT_EQ(Mutex::State::kLockFailed, test_mutex_.TryLock());
     EXPECT_FALSE(locker.owner_died());
   }
   EXPECT_EQ(Mutex::State::kLocked, test_mutex_.TryLock());