Merge branch 'master' into unicode

4 files changed, 92 insertions, 6 deletions

diff --git a/src/stable/event.h b/src/stable/event.h
index db4f846..5f3c819 100644
--- a/src/stable/event.h
+++ b/src/stable/event.h
@@ -16,12 +16,24 @@
 namespace Bu
 {
     /**
+     * Represents a true/false state that controls thread synchronization. This
+     * is primarilly intended to control the synchronization state of
+     * multithreaded services. For example, telling all threads when to exit.
+     *
+     * An Event is either set or unset. If the Event is unset then it can be
+     * waited on for something to happen. As soon as the Event is set all
+     * waiting threads are released and new requests to wait are ignored until
+     * the Event is cleared again.
+     *
+     * Threads can also be woken up without setting the Event, which may be
+     * handy in certain circumstances.
      *@ingroup Threading
      */
     class Event
     {
     public:
-        Event()
+        Event() :
+            bIsSet( false )
         {
         }
         
@@ -29,20 +41,50 @@ namespace Bu
         {
         }
 
-        void wait()
+        /**
+         * Wait indefinitely for the Event to trigger. If the event is already
+         * set, then return immediately.  It's important to note that this may
+         * return at any time, not only when the Event is set, so examining the
+         * return value is important.
+         *@returns the set status of the Event.
+         */
+        bool wait()
         {
             cBlock.lock();
+            if( bIsSet )
+            {
+                cBlock.unlock();
+                return true;
+            }
             cBlock.wait();
+            bool bRet = bIsSet;
             cBlock.unlock();
+            return bRet;
         }
 
-        void wait( int nSec, int nUSec )
+        /**
+         * Wait for up to nSec seconds and nUSec nanoseconds for the event to
+         * trigger. If the Event is already set then return immediately.
+         *@returns the set status of the Event.
+         */
+        bool wait( int nSec, int nUSec )
         {
             cBlock.lock();
+            if( bIsSet )
+            {
+                cBlock.unlock();
+                return true;
+            }
             cBlock.wait( nSec, nUSec );
+            bool bRet = bIsSet;
             cBlock.unlock();
+            return bRet;
         }
 
+        /**
+         * Allow one of the waiting threads to unlock without updating the set
+         * state of the Event.
+         */
         void unblockOne()
         {
             cBlock.lock();
@@ -50,6 +92,10 @@ namespace Bu
             cBlock.unlock();
         }
 
+        /**
+         * Allow all waiting threads to unlock and proceed without updating the
+         * set state of the Event.
+         */
         void unblockAll()
         {
             cBlock.lock();
@@ -57,8 +103,43 @@ namespace Bu
             cBlock.unlock();
         }
 
+        /**
+         * Find out if the Event is in the set state or not.
+         *@returns True if set, false otherwise.
+         */
+        bool isSet()
+        {
+            cBlock.lock();
+            bool bRet = bIsSet;
+            cBlock.unlock();
+            return bRet;
+        }
+
+        /**
+         * Sets the Event's state to true and triggers all waiting threads.
+         */
+        void set()
+        {
+            cBlock.lock();
+            bIsSet = true;
+            cBlock.broadcast();
+            cBlock.unlock();
+        }
+        
+        /**
+         * Sets the Event's state to false. This does NOT trigger any waiting
+         * threads.
+         */
+        void clear()
+        {
+            cBlock.lock();
+            bIsSet = false;
+            cBlock.unlock();
+        }
+
     private:
         Condition cBlock;   /**< The condition for blocking dequeues. */
+        bool bIsSet;
     };
 }
 
diff --git a/src/stable/optparser.cpp b/src/stable/optparser.cpp
index 0f9b2b1..c0f5732 100644
--- a/src/stable/optparser.cpp
+++ b/src/stable/optparser.cpp
@@ -77,7 +77,7 @@ void Bu::OptParser::parse( int argc, char **argv )
                         {
                             pOpt->pProxy->setValueFromStr( sExtraParam );
                         }
-                        else if( argv[j+1] != '\0' )
+                        else if( argv[j+1] != 0 )
                         {
                             pOpt->pProxy->setValueFromStr( argv[j+1] );
                             j++;
diff --git a/src/stable/thread.cpp b/src/stable/thread.cpp
index 98f08ec..7d362e9 100644
--- a/src/stable/thread.cpp
+++ b/src/stable/thread.cpp
@@ -51,7 +51,7 @@ bool Bu::Thread::start()
     return true;
 }
 
-bool Bu::Thread::stop()
+bool Bu::Thread::forceStop()
 {
     pthread_cancel( ptHandle );
 
diff --git a/src/stable/thread.h b/src/stable/thread.h
index 294c250..5174d1c 100644
--- a/src/stable/thread.h
+++ b/src/stable/thread.h
@@ -79,11 +79,16 @@ namespace Bu
          * probably create a memory leak type of situation.  Instead of stop,
          * consider using cancel, which can be handled by the running thread in
          * a graceful manner.
+         *
+         * NOTE: This was called stop(), but that was too ambiguous and common
+         * of a name to implement in subclasses. The functionality was not
+         * obvious, and this was sometimes used in place of a clean stopping
+         * routine.
          *@returns True if the thread was stopped, false otherwise.  When this
          * function returns the thread may not have stopped, to ensure that the
          * thread has really stopped, call join.
          */
-        bool stop();
+        bool forceStop();
 
         /**
          * Join the thread in action.  This function performs what is commonly