bdb_trans.hpp
上传用户:yhdzpy8989
上传日期:2007-06-13
资源大小:13604k
文件大小:4k
源码类别:

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: bdb_trans.hpp,v $
  4.  * PRODUCTION Revision 1000.0  2004/04/12 17:14:32  gouriano
  5.  * PRODUCTION PRODUCTION: IMPORTED [CATCHUP_003] Dev-tree R1.2
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef BDB_TRANS__HPP
  10. #define BDB_TRANS__HPP
  11. /* $Id: bdb_trans.hpp,v 1000.0 2004/04/12 17:14:32 gouriano Exp $
  12.  * ===========================================================================
  13.  *
  14.  *                            PUBLIC DOMAIN NOTICE
  15.  *               National Center for Biotechnology Information
  16.  *
  17.  *  This software/database is a "United States Government Work" under the
  18.  *  terms of the United States Copyright Act.  It was written as part of
  19.  *  the author's official duties as a United States Government employee and
  20.  *  thus cannot be copyrighted.  This software/database is freely available
  21.  *  to the public for use. The National Library of Medicine and the U.S.
  22.  *  Government have not placed any restriction on its use or reproduction.
  23.  *
  24.  *  Although all reasonable efforts have been taken to ensure the accuracy
  25.  *  and reliability of the software and data, the NLM and the U.S.
  26.  *  Government do not and cannot warrant the performance or results that
  27.  *  may be obtained by using this software or data. The NLM and the U.S.
  28.  *  Government disclaim all warranties, express or implied, including
  29.  *  warranties of performance, merchantability or fitness for any particular
  30.  *  purpose.
  31.  *
  32.  *  Please cite the author in any work or product based on this material.
  33.  *
  34.  * ===========================================================================
  35.  *
  36.  * Author:  Anatoliy Kuznetsov
  37.  *   
  38.  * File Description: Transaction support
  39.  *
  40.  */
  41. /// @file bdb_trans.hpp
  42. /// Wrapper around Berkeley DB transaction structure
  43. #include <bdb/bdb_env.hpp>
  44. #include <vector>
  45. BEGIN_NCBI_SCOPE
  46. /** @addtogroup BDB
  47.  *
  48.  * @{
  49.  */
  50. class   CBDB_RawFile;
  51. /// BDB transaction object.
  52. ///
  53. class NCBI_BDB_EXPORT CBDB_Transaction
  54. {
  55. public:
  56.     CBDB_Transaction(CBDB_Env& env);
  57.     ~CBDB_Transaction();
  58.         
  59.     /// Commit transaction
  60.     void Commit();
  61.     
  62.     /// Abort transaction
  63.     void Abort();
  64.     
  65.     /// Rollback transaction (same as Abort)
  66.     void Rollback() { Abort(); }
  67.     /// Get low level Berkeley DB transaction handle.
  68.     ///
  69.     /// Function uses lazy initialization paradigm, and actual
  70.     /// transaction is created "on demand". First call to GetTxn()
  71.     /// creates the handle which lives until commit or rollback point.
  72.     ///
  73.     /// @return Transaction handle
  74.     ///
  75.     DB_TXN*  GetTxn();
  76. protected:
  77.     /// Add file to the list of connected files
  78.     void AddFile(CBDB_RawFile* dbfile);
  79.     
  80.     /// Remove file from the list of connected files.
  81.     /// Has no effect if file has not been added before by AddFile
  82.     void RemoveFile(CBDB_RawFile* dbfile);
  83.     
  84.     /// Return TRUE if transaction handle has been requested by some
  85.     /// client (File)
  86.     bool IsInProgress() const { return m_Txn != 0; }
  87. private:
  88.     /// Abort transaction with error checking or without
  89.     void x_Abort(bool ignore_errors);
  90. private:
  91.     CBDB_Transaction(const CBDB_Transaction& trans);
  92.     CBDB_Transaction& operator=(const CBDB_Transaction& trans);
  93. protected:
  94.     CBDB_Env&               m_Env;        ///< Associated environment
  95.     DB_TXN*                 m_Txn;        ///< Transaction handle
  96.     vector<CBDB_RawFile*>   m_TransFiles; ///< Files connected to transaction
  97.     
  98. private:
  99.     friend class CBDB_RawFile;
  100. };
  101. /* @} */
  102. END_NCBI_SCOPE
  103. /*
  104.  * ===========================================================================
  105.  * $Log: bdb_trans.hpp,v $
  106.  * Revision 1000.0  2004/04/12 17:14:32  gouriano
  107.  * PRODUCTION: IMPORTED [CATCHUP_003] Dev-tree R1.2
  108.  *
  109.  * Revision 1.2  2003/12/29 17:07:13  kuznets
  110.  * GetTxn() - relaxed function visibility restriction to public
  111.  *
  112.  * Revision 1.1  2003/12/10 19:10:53  kuznets
  113.  * Initial revision
  114.  *
  115.  *
  116.  * ===========================================================================
  117.  */
  118. #endif  /* BDB_ENV__HPP */