Changeset 2212 in Sophya for trunk/SophyaLib/SysTools/zthread.h

Timestamp:

Oct 15, 2002, 5:48:53 PM (23 years ago)

Author:

ansari

Message:

Mise a jour de la documentation SysTools, Reza 15/10/2002

File:

• trunk/SophyaLib/SysTools/zthread.h (modified) (4 diffs)

trunk/SophyaLib/SysTools/zthread.h

@@ -14 +14 @@
 
 typedef void (* ZThreadAction) (void *);
-  
+
+/*!
+  \class SOPHYA::ZThreadExc
+  \ingroup SysTools
+  This exception class is used by the classes implementing the interface 
+  to the POSIX threads (\b ZThread ...)
+*/  
 class ZThreadExc : public PException {
 public:
@@ -31 +37 @@
   virtual void  run();
 
+  //! Sets the return code for the thread object
   inline void   setRC(int rc) { _rc = rc; }
+  //! Return the value of the return code for the thread object
   inline int    getRC(int rc) { return(_rc);
  }
@@ -61 +69 @@
   explicit      ZMutex();
   virtual       ~ZMutex();
+  //! Locks the mutex object
   inline void   lock()
     { pthread_mutex_lock(_mutx); } 
+  //! Unlocks the mutex object
   inline void   unlock()
-    { pthread_mutex_unlock(_mutx); } 
+    { pthread_mutex_unlock(_mutx); }
+  //! Waits for a condition change
   inline void   wait()
     { pthread_cond_wait(_condv, _mutx); }
+  //! Signal a condition change on the mutex object
   inline void   signal()
   { pthread_cond_signal(_condv); }
+  //! Broadcasts a condition change on the mutex object
   inline void   broadcast()
   { pthread_cond_broadcast(_condv); }
@@ -81 +94 @@
 public:
   explicit inline  ZSync(ZMutex & mtx) {_mtx = &mtx; mtx.lock(); }
-  inline           ~ZSync() { _mtx->unlock(); }
+  inline           ~ZSync() { if (_mtx) _mtx->unlock(); }
 
 private: