Author: wyoung
Date: Thu Jul 12 04:33:11 2007
New Revision: 1673

URL: http://svn.gna.org/viewcvs/mysqlpp?rev=1673&view=rev
Log:
Renamed BasicLock class to DiaryLock to better reflect its level of
usefulness.  Also updated its documentation in anticipation of better
alternatives to come soon.

Modified:
    trunk/Wishlist
    trunk/lib/lockable.h

Modified: trunk/Wishlist
URL: 
http://svn.gna.org/viewcvs/mysqlpp/trunk/Wishlist?rev=1673&r1=1672&r2=1673&view=diff
==============================================================================
--- trunk/Wishlist (original)
+++ trunk/Wishlist Thu Jul 12 04:33:11 2007
@@ -12,9 +12,6 @@
     The items in this section are those things we definitely want to
     get done in v3.0.  Most of them break the ABI, so they can't wait
     for a future version, because v4 could be years out.
-
-    o Rename BasicLock to DiaryLock, to reflect its strength and
-      usefulness.
 
     o Add conditional code to the Lockable mechanism to use platform
       mutexes if available, to implement these MySQL C API

Modified: trunk/lib/lockable.h
URL: 
http://svn.gna.org/viewcvs/mysqlpp/trunk/lib/lockable.h?rev=1673&r1=1672&r2=1673&view=diff
==============================================================================
--- trunk/lib/lockable.h (original)
+++ trunk/lib/lockable.h Thu Jul 12 04:33:11 2007
@@ -68,24 +68,26 @@
 };
 
 
-/// \brief Trivial Lock subclass, using a boolean variable as the
-/// lock flag.
+/// \brief A trivial Lock subclass, using an unprotected boolean variable
+/// as the lock flag.
 ///
-/// This is the only Lock implementation available in this version of
-/// MySQL++.  It will be supplemented with a better implementation for
-/// use with threads at a later date.
+/// As its name indicates, this lock is about as useful as the one on
+/// a child's diary.  It is only used when no better option using
+/// platform mutexes can be found.  If this is all you have available,
+/// you mustn't call MySQL++ from multiple threads.  Havoc is all but
+/// guaranteed.
 
-class MYSQLPP_EXPORT BasicLock : public Lock
+class MYSQLPP_EXPORT DiaryLock : public Lock
 {
 public:
        /// \brief Create object
-       BasicLock(bool is_locked = false) :
+       DiaryLock(bool is_locked = false) :
        locked_(is_locked)
        {
        }
        
        /// \brief Destroy object
-       ~BasicLock() { }
+       ~DiaryLock() { }
 
        /// \brief Lock the object
        ///
@@ -123,7 +125,7 @@
 protected:
        /// \brief Default constructor
        Lockable(bool is_locked) :
-       pimpl_(new BasicLock(is_locked))
+       pimpl_(new DiaryLock(is_locked))
        {
        }
 


_______________________________________________
Mysqlpp-commits mailing list
[email protected]
https://mail.gna.org/listinfo/mysqlpp-commits

Reply via email to