Changeset 12765 for source/ariba/utility/system/SystemQueue.h

Timestamp:

Mar 14, 2014, 8:26:33 PM (10 years ago)

Author:

hock@…

Message:

new functionality: SystemQueue::leave() and SystemQueue::join()

( + unit tests)

File:

• source/ariba/utility/system/SystemQueue.h (modified) (1 diff)

source/ariba/utility/system/SystemQueue.h

@@ -117 +117 @@
          * Cancels the system queue and ends the processing after the
          * currently processed event is processed.
+     * 
+     * NOTE: Do not call this function from within a SystemQueue-Event.
+     *   Use SystemQueue::leave() instead.
          *
          * This method is thread-safe.
          */
         void cancel();
+    
+    /**
+     * Like SystemQueue::cancel(), but may only be called from within a SystemQueue-Event.
+     * 
+     * NOTE: In this case some cleanup can not be made. -- If the SystemQueue is 
+     *   restarted, SystemQueue::cancel() must be called before SystemQueue::run()
+     *   can be called again.
+     */
+    void leave();
+    
+    /**
+     * Join the SystemQueue thread -- the current thread is blocked until the
+     * SystemQueue finishes.
+     * 
+     * NOTE: Use this only in combination with SystemQueue::leave()
+     * 
+     * [ There is a possible race condition with SystemQueue::cancel(), but 
+     *   SystemQueue::join() should not be used at the same time as 
+     *   SystemQueue::cancel() anyway. (SystemQueue::leave() is fine, though.)
+     */
+    void join();
 
         /**