开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > 数值算法/人工智能 > 生物技术 > 查看源码
ncbi_servicep.h
资源名称：ncbi_cxx_win--Jul_08_2004.zip　[点击查看]
上传用户：yhdzpy8989
上传日期：2007-06-13
资源大小：13604k
文件大小：9k
源码类别：

生物技术

开发平台：

C/C++

ncbi_servicep.h：源码内容
  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: ncbi_servicep.h,v $
  4.  * PRODUCTION Revision 1000.0  2003/10/29 16:39:59  gouriano
  5.  * PRODUCTION PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R6.23
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  10. #ifndef CONNECT___NCBI_SERVICEP__H
  11. #define CONNECT___NCBI_SERVICEP__H
  13. /*  $Id: ncbi_servicep.h,v 1000.0 2003/10/29 16:39:59 gouriano Exp $
  14.  * ===========================================================================
  15.  *
  16.  *                            PUBLIC DOMAIN NOTICE
  17.  *               National Center for Biotechnology Information
  18.  *
  19.  *  This software/database is a "United States Government Work" under the
  20.  *  terms of the United States Copyright Act.  It was written as part of
  21.  *  the author's official duties as a United States Government employee and
  22.  *  thus cannot be copyrighted.  This software/database is freely available
  23.  *  to the public for use. The National Library of Medicine and the U.S.
  24.  *  Government have not placed any restriction on its use or reproduction.
  25.  *
  26.  *  Although all reasonable efforts have been taken to ensure the accuracy
  27.  *  and reliability of the software and data, the NLM and the U.S.
  28.  *  Government do not and cannot warrant the performance or results that
  29.  *  may be obtained by using this software or data. The NLM and the U.S.
  30.  *  Government disclaim all warranties, express or implied, including
  31.  *  warranties of performance, merchantability or fitness for any particular
  32.  *  purpose.
  33.  *
  34.  *  Please cite the author in any work or product based on this material.
  35.  *
  36.  * ===========================================================================
  37.  *
  38.  * Author:  Anton Lavrentiev, Denis Vakatov
  39.  *
  40.  * File Description:
  41.  *   Private API to define server iterator structure.
  42.  *
  43.  */
  45. #include "ncbi_server_infop.h"
  46. #include <connect/ncbi_service.h>
  49. #ifdef __cplusplus
  50. extern "C" {
  51. #endif
  54. /* Table of iterator "virtual functions"
  55.  */
  56. typedef struct {
  57.     void        (*Reset)(SERV_ITER iter);
  58.     SSERV_Info* (*GetNextInfo)(SERV_ITER iter, HOST_INFO* host_info);
  59.     int/*bool*/ (*Update)(SERV_ITER iter, TNCBI_Time now, const char* text);
  60.     int/*bool*/ (*Penalize)(SERV_ITER iter, double penalty);
  61.     void        (*Close)(SERV_ITER iter);
  62.     const char* name;
  63. } SSERV_VTable;
  66. /* Iterator structure
  67.  */
  68. struct SSERV_IterTag {
  69.     const char*  service;        /* requested service name                 */
  70.     TSERV_Type   type;           /* requested server type(s)               */
  71.     unsigned int preferred_host; /* preferred host to select, network b.o. */
  72.     double       preference;     /* range [0..100] %%                      */
  73.     SSERV_Info** skip;           /* servers to skip                        */
  74.     size_t       n_skip;         /* number of servers in the array         */
  75.     size_t       n_max_skip;     /* number of allocated slots in the array */
  76.     SSERV_Info*  last;           /* last server info taken out             */
  78.     const SSERV_VTable* op;      /* table of virtual functions             */
  80.     void*        data;           /* private data field                     */
  81.     int/*bool*/  external;       /* true for mapping of external requests  */
  82. };
  85. /* Modified 'fast track' routine for one-shot obtaining of a service info.
  86.  * Please see <connect/ncbi_service.h> for explanations [SERV_GetInfoEx()].
  87.  * For now, this call is to exclusively support MYgethostbyname() replacement
  88.  * of standard gethostbyname() libcall in apache Web daemon (see in daemons/).
  89.  *
  90.  * NOTE: Preference 0.0 does not prohibit the preferred_host to be selected;
  91.  *       nor preference 100.0 ultimately opts for the preferred_host; rather,
  92.  *       the preference is considered as an estimate for the selection
  93.  *       probability when all other conditions for favoring the host are
  94.  *       optimal, i.e. preference 0.0 actually means not to favor the preferred
  95.  *       host at all, while 100.0 means to opt for that as much as possible.
  96.  */
  97. SSERV_Info* SERV_GetInfoP
  98. (const char*         service,       /* service name                          */
  99.  TSERV_Type          types,         /* mask of type(s) of servers requested  */
  100.  unsigned int        preferred_host,/* preferred host to use service on, nbo */
  101.  double              preference,    /* [0=min..100=max] preference in %%     */
  102.  int/*bool*/         external       /* whether mapping is not local to NCBI  */
  103.  );
  105. /* same as above but creates an iterator to get services one by one */
  106. SERV_ITER SERV_OpenP
  107. (const char*         service,
  108.  TSERV_Type          type,
  109.  unsigned int        preferred_host,
  110.  double              preference,
  111.  int/*bool*/         external
  112.  );
  115. /* Private interface: update mapper information from the given text
  116.  * (<CR><LF> separated lines, usually taken from HTTP header).
  117.  */
  118. int/*bool*/ SERV_Update(SERV_ITER iter, const char* text);
  121. /* Private interface: print and return the HTTP-compliant header portion
  122.  * (<CR><LF> separated lines, including the last line) out of the information
  123.  * contained in the iterator; to be used in mapping requests to DISPD.
  124.  * Return value must be 'free'd.
  125.  */
  126. char* SERV_Print(SERV_ITER iter);
  129. /* Get name of underlying service mapper.
  130.  */
  131. const char* SERV_MapperName(SERV_ITER iter);
  134. /* Get final service name, using CONN_SERVICE_NAME_service environment
  135.  * variable, then (if not found) registry section [service] and a key
  136.  * CONN_SERVICE_NAME. Return resulting name (perhaps, an exact copy of
  137.  * "service" if no override name was found in environment/registry), which
  138.  * is to be freed by a caller when no longer needed. Return NULL on error.
  139.  * NOTE: This procedure does not detect cyclical redefinitions.
  140.  */
  141. char* SERV_ServiceName(const char* service);
  144. /* Get configuration file name. Returned ''-terminated string
  145.  * is to be free()'d by a caller when no longer needed.
  146.  * Return NULL if no configuration file name available.
  147.  */
  148. char* SERV_GetConfig(void);
  151. /* Given the status gap and wanted preference, calculate
  152.  * acceptable stretch for the gap (the number of candidates is n).
  153.  */
  154. double SERV_Preference(double pref, double gap, unsigned int n);
  157. #ifdef __cplusplus
  158. }  /* extern "C" */
  159. #endif
  162. /*
  163.  * --------------------------------------------------------------------------
  164.  * $Log: ncbi_servicep.h,v $
  165.  * Revision 1000.0  2003/10/29 16:39:59  gouriano
  166.  * PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R6.23
  167.  *
  168.  * Revision 6.23  2003/06/26 15:19:56  lavr
  169.  * Additional parameter "external" for SERV_{Open|GetInfo}P()
  170.  *
  171.  * Revision 6.22  2003/06/09 19:53:11  lavr
  172.  * +SERV_OpenP()
  173.  *
  174.  * Revision 6.21  2003/03/07 22:21:55  lavr
  175.  * Explain what is "preference" for SERV_GetInfoP()
  176.  *
  177.  * Revision 6.20  2003/02/28 14:49:09  lavr
  178.  * SERV_Preference(): redeclare last argument 'unsigned'
  179.  *
  180.  * Revision 6.19  2003/02/13 21:37:28  lavr
  181.  * Comment SERV_Preference(), change last argument
  182.  *
  183.  * Revision 6.18  2003/01/31 21:19:41  lavr
  184.  * +SERV_Preference()
  185.  *
  186.  * Revision 6.17  2002/10/28 20:16:00  lavr
  187.  * Take advantage of host info API
  188.  *
  189.  * Revision 6.16  2002/10/11 19:48:25  lavr
  190.  * +SERV_GetConfig()
  191.  * const dropped in return value of SERV_ServiceName()
  192.  *
  193.  * Revision 6.15  2002/09/19 18:08:43  lavr
  194.  * Header file guard macro changed; log moved to end
  195.  *
  196.  * Revision 6.14  2002/05/06 19:17:04  lavr
  197.  * +SERV_ServiceName() - translation of service name
  198.  *
  199.  * Revision 6.13  2001/09/28 20:50:41  lavr
  200.  * Update VT method changed - now called on per-line basis
  201.  *
  202.  * Revision 6.12  2001/09/24 20:23:39  lavr
  203.  * Reset() method added to VT
  204.  *
  205.  * Revision 6.11  2001/06/25 15:38:00  lavr
  206.  * Heap of services is now not homogeneous, but can
  207.  * contain entries of different types. As of now,
  208.  * Service and Host entry types are introduced and defined
  209.  *
  210.  * Revision 6.10  2001/05/11 15:30:02  lavr
  211.  * Correction in comment
  212.  *
  213.  * Revision 6.9  2001/04/26 14:18:45  lavr
  214.  * SERV_MapperName moved to the private header
  215.  *
  216.  * Revision 6.8  2001/04/24 21:33:58  lavr
  217.  * Added members of mapper V-table: penalize(method) and name(data).
  218.  * Service iterator has got new field 'last' to keep the latest given info.
  219.  *
  220.  * Revision 6.7  2001/03/06 23:57:49  lavr
  221.  * Minor beautifications
  222.  *
  223.  * Revision 6.6  2000/12/29 18:12:51  lavr
  224.  * SERV_Print added to private interface
  225.  *
  226.  * Revision 6.5  2000/12/06 22:21:27  lavr
  227.  * SERV_Print added to private interface
  228.  *
  229.  * Revision 6.4  2000/10/20 17:22:55  lavr
  230.  * VTable changed to have 'Update' method
  231.  * 'SERV_Update' added to private interface
  232.  *
  233.  * Revision 6.3  2000/10/05 21:37:51  lavr
  234.  * Mapper-specific private data field added
  235.  *
  236.  * Revision 6.2  2000/05/22 16:53:12  lavr
  237.  * Rename service_info -> server_info everywhere (including
  238.  * file names) as the latter name is more relevant
  239.  *
  240.  * Revision 6.1  2000/05/12 18:38:16  lavr
  241.  * First working revision
  242.  *
  243.  * ==========================================================================
  244.  */
  246. #endif /* CONNECT___NCBI_SERVICEP__H */