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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: ncbi_host_info.h,v $
  4.  * PRODUCTION Revision 1000.0  2003/10/29 16:31:05  gouriano
  5.  * PRODUCTION PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R6.5
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef CONNECT___NCBI_HOST_INFO__H
  10. #define CONNECT___NCBI_HOST_INFO__H
  11. /*  $Id: ncbi_host_info.h,v 1000.0 2003/10/29 16:31:05 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:  Anton Lavrentiev
  37.  *
  38.  * File Description:
  39.  *   NCBI host info getters
  40.  *
  41.  *   Host information handle becomes available from SERV_Get[Next]InfoEx()
  42.  *   calls of the service mapper (ncbi_service.c) and remains valid until
  43.  *   destructed by passing into free(). All API functions declared below
  44.  *   accept NULL as 'host_info' parameter, and as the result return a failure
  45.  *   status as described individually for each API call.
  46.  *
  47.  */
  48. #include <connect/connect_export.h>
  49. /** @addtogroup ServiceSupport
  50.  *
  51.  * @{
  52.  */
  53. #ifdef __cplusplus
  54. extern "C" {
  55. #endif
  56. struct SHostInfoTag;
  57. typedef struct SHostInfoTag* HOST_INFO;
  58. /* Return CPU count or -1 if error occurred.
  59.  */
  60. extern NCBI_XCONNECT_EXPORT int HINFO_CpuCount(HOST_INFO host_info);
  61. /* Return task count or -1 if error occurred.
  62.  */
  63. extern NCBI_XCONNECT_EXPORT int HINFO_TaskCount(HOST_INFO host_info);
  64. /* Return non-zero on success and store load averages in the
  65.  * provided array "lavg", with the standard load average for last
  66.  * minute stored at index [0], and instant load average
  67.  * (aka BLAST) stored at index [1]. Return 0 on error.
  68.  */
  69. extern NCBI_XCONNECT_EXPORT int/*bool*/ HINFO_LoadAverage
  70. (HOST_INFO host_info,
  71.  double    lavg[2]
  72.  );
  73. /* Return non-zero on success and store host status coefficients in
  74.  * the provided array "status", with status based on the standard
  75.  * load average stored at index [0], and that based on instant load
  76.  * average stored at index [1]. Status may return as 0 if the host
  77.  * does not provide such information. Return 0 on error.
  78.  */
  79. extern NCBI_XCONNECT_EXPORT int/*bool*/ HINFO_Status
  80. (HOST_INFO host_info,
  81.  double    status[2]
  82.  );
  83. /* Return non-zero on success and store BLAST counters in the
  84.  * provided array "blast", with first five entries (indices [0..4])
  85.  * containing task counters, and last 3 entries (indices [5..7])
  86.  * containing queue sizes. Return 0 on error.
  87.  */
  88. extern NCBI_XCONNECT_EXPORT int/*bool*/ HINFO_BLASTParams
  89. (HOST_INFO    host_info,
  90.  unsigned int blast[8]
  91.  );
  92. /* Obtain and return host environment. The host environment is the
  93.  * sequence of lines (separated by n), all having the form "name=value",
  94.  * which are provided to load-balancing service mapping daemon (LBSMD)
  95.  * in the configuration file on that host. Return 0 if the host
  96.  * environment cannot be obtained. If completed successfully, the
  97.  * host environment remains valid until the handle 'host_info' deleted
  98.  * in the application program.
  99.  */
  100. extern NCBI_XCONNECT_EXPORT const char* HINFO_Environment(HOST_INFO host_info);
  101. #ifdef __cplusplus
  102. }  /* extern "C" */
  103. #endif
  104. /* @} */
  105. /*
  106.  * --------------------------------------------------------------------------
  107.  * $Log: ncbi_host_info.h,v $
  108.  * Revision 1000.0  2003/10/29 16:31:05  gouriano
  109.  * PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R6.5
  110.  *
  111.  * Revision 6.5  2003/04/09 19:05:42  siyan
  112.  * Added doxygen support
  113.  *
  114.  * Revision 6.4  2003/02/08 21:03:51  lavr
  115.  * Unimportant change in comments
  116.  *
  117.  * Revision 6.3  2003/01/08 01:59:32  lavr
  118.  * DLL-ize CONNECT library for MSVC (add NCBI_XCONNECT_EXPORT)
  119.  *
  120.  * Revision 6.2  2002/11/08 17:16:11  lavr
  121.  * NULL parameter acceptance explicitly stated
  122.  *
  123.  * Revision 6.1  2002/10/28 20:12:02  lavr
  124.  * Initial revision
  125.  *
  126.  * ==========================================================================
  127.  */
  128. #endif /* CONNECT___NCBI_HOST_INFO__H */