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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: test_mt.hpp,v $
  4.  * PRODUCTION Revision 1000.2  2004/04/21 14:35:02  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.8
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef CORELIB___TEST_MT__HPP
  10. #define CORELIB___TEST_MT__HPP
  11. /*  $Id: test_mt.hpp,v 1000.2 2004/04/21 14:35:02 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:  Aleksey Grichenko
  37.  *
  38.  *
  39.  */
  40. /// @file test_mt.hpp
  41. ///   Wrapper for testing modules in MT environment
  42. #include <corelib/ncbistd.hpp>
  43. #include <corelib/ncbiapp.hpp>
  44. #include <corelib/ncbithr.hpp>
  45. #include <corelib/ncbienv.hpp>
  46. #include <corelib/ncbiargs.hpp>
  47. BEGIN_NCBI_SCOPE
  48. /** @addtogroup MTWrappers
  49.  *
  50.  * @{
  51.  */
  52. /////////////////////////////////////////////////////////////////////////////
  53. // Globals
  54. /// Minimum number of threads.
  55. const unsigned int k_NumThreadsMin = 1;
  56. /// Maximum number of threads.
  57. const unsigned int k_NumThreadsMax = 500;
  58. /// Minimum number of spawn by threads.
  59. const int k_SpawnByMin = 1;
  60. /// Maximum number of spawn by threads.
  61. const int k_SpawnByMax = 100;
  62. extern unsigned int  s_NumThreads;
  63. extern int           s_SpawnBy;
  64. /////////////////////////////////////////////////////////////////////////////
  65. //  Test application
  66. //
  67. //    Core application class for MT-tests
  68. //
  69. /////////////////////////////////////////////////////////////////////////////
  70. ///
  71. /// CThreadedApp --
  72. ///
  73. /// Basic NCBI threaded application class.
  74. ///
  75. /// Defines the high level behavior of an NCBI threaded application.
  76. class NCBI_TEST_MT_EXPORT CThreadedApp : public CNcbiApplication
  77. {
  78. public:
  79.     /// Constructor.
  80.     ///
  81.     /// Override constructor to initialize the application.
  82.     CThreadedApp(void);
  83.     /// Destructor.
  84.     ~CThreadedApp(void);
  85.     // Functions to be called by the test thread's constructor, Main(),
  86.     // OnExit() and destructor. All methods should return "true" on
  87.     // success, "false" on failure.
  88.     /// Initialize the thread.
  89.     ///
  90.     /// Called from thread's constructor.
  91.     /// @return
  92.     ///   TRUE on success, and FALSE on failure.
  93.     virtual bool Thread_Init(int idx);
  94.     /// Run the thread.
  95.     ///
  96.     /// Called from thread's Main() method.
  97.     /// @return
  98.     ///   TRUE on success, and FALSE on failure.
  99.     virtual bool Thread_Run(int idx);
  100.     /// Exit the thread.
  101.     ///
  102.     /// Called from thread's OnExit() method.
  103.     /// @return
  104.     ///   TRUE on success, and FALSE on failure.
  105.     virtual bool Thread_Exit(int idx);
  106.     /// Destroy the thread.
  107.     ///
  108.     /// Called from thread's destroy() method.
  109.     /// @return
  110.     ///   TRUE on success, and FALSE on failure.
  111.     virtual bool Thread_Destroy(int idx);
  112. protected:
  113.     /// Override this method to add your custom arguments.
  114.     /// @return
  115.     ///   TRUE on success, and FALSE on failure.
  116.     virtual bool TestApp_Args( CArgDescriptions& args);
  117.     /// Override this method to execute code before running threads.
  118.     /// @return
  119.     ///   TRUE on success, and FALSE on failure.
  120.     virtual bool TestApp_Init(void);
  121.     /// Override this method to execute code after all threads terminate.
  122.     /// @return
  123.     ///   TRUE on success, and FALSE on failure.
  124.     virtual bool TestApp_Exit(void);
  125. private:
  126.     /// Initialize the thread.
  127.     void Init(void);
  128.     /// Run the thread.
  129.     int Run(void);
  130. };
  131. END_NCBI_SCOPE
  132. /* @} */
  133. /*
  134.  * ===========================================================================
  135.  * $Log: test_mt.hpp,v $
  136.  * Revision 1000.2  2004/04/21 14:35:02  gouriano
  137.  * PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.8
  138.  *
  139.  * Revision 1.8  2004/03/10 20:22:28  gorelenk
  140.  * Prefix NCBI_XNCBI_EXPORT changed to NCBI_TEST_MT_EXPORT.
  141.  *
  142.  * Revision 1.7  2003/11/18 11:59:00  siyan
  143.  * Changed so @addtogroup does not cross namespace boundary
  144.  *
  145.  * Revision 1.6  2003/09/08 12:18:13  siyan
  146.  * Documentation changes
  147.  *
  148.  * Revision 1.5  2003/05/08 20:50:08  grichenk
  149.  * Allow MT tests to run in ST mode using CThread::fRunAllowST flag.
  150.  *
  151.  * Revision 1.4  2003/04/01 19:19:44  siyan
  152.  * Added doxygen support
  153.  *
  154.  * Revision 1.3  2002/12/18 22:53:21  dicuccio
  155.  * Added export specifier for building DLLs in windows.  Added global list of
  156.  * all such specifiers in mswin_exports.hpp, included through ncbistl.hpp
  157.  *
  158.  * Revision 1.2  2002/04/30 19:10:26  gouriano
  159.  * added possibility to add custom arguments
  160.  *
  161.  * Revision 1.1  2002/04/23 13:12:28  gouriano
  162.  * test_mt.hpp moved into another location
  163.  *
  164.  * Revision 6.5  2002/04/16 18:49:07  ivanov
  165.  * Centralize threatment of assert() in tests.
  166.  * Added #include <test/test_assert.h>. CVS log moved to end of file.
  167.  *
  168.  * Revision 6.4  2002/04/11 20:00:46  ivanov
  169.  * Returned standard assert() vice CORE_ASSERT()
  170.  *
  171.  * Revision 6.3  2002/04/10 18:38:51  ivanov
  172.  * Moved CVS log to end of file. Changed assert() to CORE_ASSERT()
  173.  *
  174.  * Revision 6.2  2001/05/17 15:05:08  lavr
  175.  * Typos corrected
  176.  *
  177.  * Revision 6.1  2001/04/06 15:53:08  grichenk
  178.  * Initial revision
  179.  *
  180.  * ===========================================================================
  181.  */
  182. #endif  /* TEST_MT__HPP */