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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: asn_connection.h,v $
  4.  * PRODUCTION Revision 1000.1  2003/11/17 22:11:11  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [ORIGINAL] Dev-tree R1.8
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef CTOOLS___ASN_CONNECTION__H
  10. #define CTOOLS___ASN_CONNECTION__H
  11. /*  $Id: asn_connection.h,v 1000.1 2003/11/17 22:11:11 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:  Denis Vakatov, Anton Lavrentiev
  37.  *
  38.  * File Description:
  39.  *    Build C Toolkit ANS streams on top of CONN (connection).
  40.  *
  41.  */
  42. #include <connect/ncbi_connection.h>
  43. #include <asn.h>
  44. /** @addtogroup CToolsASNConn
  45.  *
  46.  * @{
  47.  */
  48. #ifdef __cplusplus
  49. extern "C" {
  50. #endif
  51. typedef enum {
  52.     eAsnConn_Input,
  53.     eAsnConn_Output
  54. } EAsnConn_Direction;
  55. typedef enum {
  56.     eAsnConn_Binary,
  57.     eAsnConn_Text
  58. } EAsnConn_Format;
  59. /* Build ASN stream on top of CONN (connection) handle.
  60.  * According to arguments, the stream is created for
  61.  * either reading or writing, and is capable to handle
  62.  * either binary or text ASN.
  63.  * Return ASN stream pointer on success, or 0 on error.
  64.  * NOTE: Returned stream is valid while the underlying conn exists. After call
  65.  *       to CONN_Close() the stream becomes invalid, and should not be used.
  66.  *       Don't destroy the ASN stream explicitly using AsnIoFree or AsnIoFree!
  67.  */
  68. AsnIoPtr CreateAsnConn
  69. (CONN               conn,
  70.  EAsnConn_Direction direction,
  71.  EAsnConn_Format    fmt
  72.  );
  73. /* Create service connection using the service name,
  74.  * type and connection parameters, info (use default connection
  75.  * parameters if info is passed NULL).
  76.  * Create two ASN streams based on the connection -- one stream is for
  77.  * input and one is for output. Return pointers to the streams 
  78.  * via 'input' and 'output' arguments.
  79.  * No corresponding stream is created if either pointer is passed NULL.
  80.  * On success, return created CONN handle; otherwise, return 0.
  81.  * NOTE: Returned ASN stream pointers are valid as long as connection
  82.  *       handle exists, that is after the connection handle is passed to
  83.  *       CONN_Close(), both pointers become invalid, and should not be used.
  84.  *       Don't destroy the ASN streams explicitly using AsnIoFree or AsnIoFree!
  85.  */
  86. CONN CreateAsnConn_ServiceEx
  87. (const char*           service,
  88.  EAsnConn_Format       input_fmt,
  89.  AsnIoPtr*             input,
  90.  EAsnConn_Format       output_fmt,
  91.  AsnIoPtr*             output,
  92.  TSERV_Type            type,
  93.  const SConnNetInfo*   net_info,
  94.  const SSERVICE_Extra* params
  95.  );
  96. /* Equivalent of CreateAsnConn_ServiceEx with zeroes in last three arguments.
  97.  */
  98. CONN CreateAsnConn_Service
  99. (const char*     service,
  100.  EAsnConn_Format input_fmt,
  101.  AsnIoPtr*       input,
  102.  EAsnConn_Format output_fmt,
  103.  AsnIoPtr*       output
  104.  );
  105. #ifdef __cplusplus
  106. }  /* extern "C" */
  107. #endif
  108. /* @} */
  109. /*
  110.  * ===========================================================================
  111.  * $Log: asn_connection.h,v $
  112.  * Revision 1000.1  2003/11/17 22:11:11  gouriano
  113.  * PRODUCTION: UPGRADED [ORIGINAL] Dev-tree R1.8
  114.  *
  115.  * Revision 1.8  2003/11/13 15:58:47  lavr
  116.  * Guard macro changed
  117.  *
  118.  * Revision 1.7  2003/04/11 17:46:29  siyan
  119.  * Added doxygen support
  120.  *
  121.  * Revision 1.6  2003/01/17 15:39:38  lavr
  122.  * Slightly modify API description for clarity
  123.  *
  124.  * Revision 1.5  2002/03/14 22:45:45  vakatov
  125.  * Warn against explicit destruction of ASN streams
  126.  *
  127.  * Revision 1.4  2001/12/02 21:17:28  lavr
  128.  * Fix in comment
  129.  *
  130.  * Revision 1.3  2001/09/24 20:32:34  lavr
  131.  * +SSERVICE_Extra* parameter in CreateAsnConn_ServiceEx()
  132.  *
  133.  * Revision 1.2  2001/06/28 23:01:53  vakatov
  134.  * Typo fixed (self-#include)
  135.  *
  136.  * Revision 1.1  2001/06/28 21:59:24  lavr
  137.  * Initial revision
  138.  *
  139.  * ==========================================================================
  140.  */
  141. #endif /* CTOOLS___ASN_CONNECTION__H */