asn_connection.h

ncbi源码

/*
 * ===========================================================================
 * PRODUCTION $Log: asn_connection.h,v $
 * PRODUCTION Revision 1000.1  2003/11/17 22:11:11  gouriano
 * PRODUCTION PRODUCTION: UPGRADED [ORIGINAL] Dev-tree R1.8
 * PRODUCTION
 * ===========================================================================
 */

#ifndef CTOOLS___ASN_CONNECTION__H
#define CTOOLS___ASN_CONNECTION__H

/*  $Id: asn_connection.h,v 1000.1 2003/11/17 22:11:11 gouriano Exp $
 * ===========================================================================
 *
 *                            PUBLIC DOMAIN NOTICE
 *               National Center for Biotechnology Information
 *
 *  This software/database is a "United States Government Work" under the
 *  terms of the United States Copyright Act.  It was written as part of
 *  the author's official duties as a United States Government employee and
 *  thus cannot be copyrighted.  This software/database is freely available
 *  to the public for use. The National Library of Medicine and the U.S.
 *  Government have not placed any restriction on its use or reproduction.
 *
 *  Although all reasonable efforts have been taken to ensure the accuracy
 *  and reliability of the software and data, the NLM and the U.S.
 *  Government do not and cannot warrant the performance or results that
 *  may be obtained by using this software or data. The NLM and the U.S.
 *  Government disclaim all warranties, express or implied, including
 *  warranties of performance, merchantability or fitness for any particular
 *  purpose.
 *
 *  Please cite the author in any work or product based on this material.
 *
 * ===========================================================================
 *
 * Author:  Denis Vakatov, Anton Lavrentiev
 *
 * File Description:
 *    Build C Toolkit ANS streams on top of CONN (connection).
 *
 */

#include <connect/ncbi_connection.h>
#include <asn.h>


/** @addtogroup CToolsASNConn
 *
 * @{
 */


#ifdef __cplusplus
extern "C" {
#endif


typedef enum {
    eAsnConn_Input,
    eAsnConn_Output
} EAsnConn_Direction;


typedef enum {
    eAsnConn_Binary,
    eAsnConn_Text
} EAsnConn_Format;


/* Build ASN stream on top of CONN (connection) handle.
 * According to arguments, the stream is created for
 * either reading or writing, and is capable to handle
 * either binary or text ASN.
 * Return ASN stream pointer on success, or 0 on error.
 * NOTE: Returned stream is valid while the underlying conn exists. After call
 *       to CONN_Close() the stream becomes invalid, and should not be used.
 *       Don't destroy the ASN stream explicitly using AsnIoFree or AsnIoFree!
 */
AsnIoPtr CreateAsnConn
(CONN               conn,
 EAsnConn_Direction direction,
 EAsnConn_Format    fmt
 );


/* Create service connection using the service name,
 * type and connection parameters, info (use default connection
 * parameters if info is passed NULL).
 * Create two ASN streams based on the connection -- one stream is for
 * input and one is for output. Return pointers to the streams 
 * via 'input' and 'output' arguments.
 * No corresponding stream is created if either pointer is passed NULL.
 * On success, return created CONN handle; otherwise, return 0.
 * NOTE: Returned ASN stream pointers are valid as long as connection
 *       handle exists, that is after the connection handle is passed to
 *       CONN_Close(), both pointers become invalid, and should not be used.
 *       Don't destroy the ASN streams explicitly using AsnIoFree or AsnIoFree!
 */
CONN CreateAsnConn_ServiceEx
(const char*           service,
 EAsnConn_Format       input_fmt,
 AsnIoPtr*             input,
 EAsnConn_Format       output_fmt,
 AsnIoPtr*             output,
 TSERV_Type            type,
 const SConnNetInfo*   net_info,
 const SSERVICE_Extra* params
 );


/* Equivalent of CreateAsnConn_ServiceEx with zeroes in last three arguments.
 */
CONN CreateAsnConn_Service
(const char*     service,
 EAsnConn_Format input_fmt,
 AsnIoPtr*       input,
 EAsnConn_Format output_fmt,
 AsnIoPtr*       output
 );


#ifdef __cplusplus
}  /* extern "C" */
#endif


/* @} */


/*
 * ===========================================================================
 * $Log: asn_connection.h,v $
 * Revision 1000.1  2003/11/17 22:11:11  gouriano
 * PRODUCTION: UPGRADED [ORIGINAL] Dev-tree R1.8
 *
 * Revision 1.8  2003/11/13 15:58:47  lavr
 * Guard macro changed
 *
 * Revision 1.7  2003/04/11 17:46:29  siyan
 * Added doxygen support
 *
 * Revision 1.6  2003/01/17 15:39:38  lavr
 * Slightly modify API description for clarity
 *
 * Revision 1.5  2002/03/14 22:45:45  vakatov
 * Warn against explicit destruction of ASN streams
 *
 * Revision 1.4  2001/12/02 21:17:28  lavr
 * Fix in comment
 *
 * Revision 1.3  2001/09/24 20:32:34  lavr
 * +SSERVICE_Extra* parameter in CreateAsnConn_ServiceEx()
 *
 * Revision 1.2  2001/06/28 23:01:53  vakatov
 * Typo fixed (self-#include)
 *
 * Revision 1.1  2001/06/28 21:59:24  lavr
 * Initial revision
 *
 * ==========================================================================
 */

#endif /* CTOOLS___ASN_CONNECTION__H */