[rhmessaging-commits] rhmessaging commits: r1522 - store/trunk/cpp/lib/jrnl.

[rhmessaging-commits at lists.jboss.org]

Author: kpvdr
Date: 2007-12-19 09:32:22 -0500 (Wed, 19 Dec 2007)
New Revision: 1522

Modified:
   store/trunk/cpp/lib/jrnl/txn_map.hpp
Log:
Some additional doxygen comments for txn_map class.

Modified: store/trunk/cpp/lib/jrnl/txn_map.hpp
===================================================================
--- store/trunk/cpp/lib/jrnl/txn_map.hpp	2007-12-19 14:18:17 UTC (rev 1521)
+++ store/trunk/cpp/lib/jrnl/txn_map.hpp	2007-12-19 14:32:22 UTC (rev 1522)
@@ -61,7 +61,7 @@
         u_int64_t _drid;    ///< Dequeue record id for this operation
         u_int16_t _fid;     ///< File id, to be used when transferring to emap on commit
         bool _enq_flag;     ///< If true, enq op, otherwise deq op
-        bool _aio_compl;    ///< Initially false, set to true when AIO returns
+        bool _aio_compl;    ///< Initially false, set to true when record AIO returns
         txn_data_struct(const u_int64_t rid, const u_int64_t drid, const u_int16_t fid,
                 const bool enq_flag);
     };
@@ -79,13 +79,17 @@
     * for each operation included as part of the same transaction is mapped against the
     * xid.
     *
-    * On transaction commit, then for each operation is handled as follows:
+    * The aio_compl flag is set true as each AIO write operation for the enqueue or dequeue
+    * returns. Checking that all of these flags are true for a given xid is the mechanism
+    * used to determine if the transaction is syncronized (through method is_txn_synced()).
     *
+    * On transaction commit, then each operation is handled as follows:
+    *
     * If an enqueue (_enq_flag is true), then the rid and fid are transferred to the enq_map.
     * If a dequeue (_enq_flag is false), then the rid stored in the drid field is used to
     * remove the corresponding record from the enq_map.
     *
-    * On transaction abort, then for each operation is handled as follows:
+    * On transaction abort, then each operation is handled as follows:
     *
     * If an enqueue (_enq_flag is true), then the data is simply discarded.
     * If a dequeue (_enq_flag is false), then the lock for the corresponding enqueue in enq_map