~ubuntu-branches/ubuntu/precise/ncbi-tools6/precise

« back to all changes in this revision

Viewing changes to ctools/asn_connection.h

  • Committer: Bazaar Package Importer
  • Author(s): Aaron M. Ucko
  • Date: 2005-03-27 12:00:15 UTC
  • mfrom: (2.1.2 hoary)
  • Revision ID: james.westby@ubuntu.com-20050327120015-embhesp32nj73p9r
Tags: 6.1.20041020-3
* Fix FTBFS under GCC 4.0 caused by inconsistent use of "static" on
  functions.  (Closes: #295110.)
* Add a watch file, now that we can.  (Upstream's layout needs version=3.)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#ifndef NCBI_ASN_CONNECTION__H
2
 
#define NCBI_ASN_CONNECTION__H
 
1
#ifndef CTOOLS___ASN_CONNECTION__H
 
2
#define CTOOLS___ASN_CONNECTION__H
3
3
 
4
 
/*  $Id: asn_connection.h,v 1.4 2001/12/02 21:17:28 lavr Exp $
 
4
/*  $Id: asn_connection.h,v 1.8 2003/11/13 15:58:47 lavr Exp $
5
5
 * ===========================================================================
6
6
 *
7
7
 *                            PUBLIC DOMAIN NOTICE
31
31
 * File Description:
32
32
 *    Build C Toolkit ANS streams on top of CONN (connection).
33
33
 *
34
 
 * --------------------------------------------------------------------------
35
 
 * $Log: asn_connection.h,v $
36
 
 * Revision 1.4  2001/12/02 21:17:28  lavr
37
 
 * Fix in comment
38
 
 *
39
 
 * Revision 1.3  2001/09/24 20:32:34  lavr
40
 
 * +SSERVICE_Extra* parameter in CreateAsnConn_ServiceEx()
41
 
 *
42
 
 * Revision 1.2  2001/06/28 23:01:53  vakatov
43
 
 * Typo fixed (self-#include)
44
 
 *
45
 
 * Revision 1.1  2001/06/28 21:59:24  lavr
46
 
 * Initial revision
47
 
 *
48
 
 * ==========================================================================
49
34
 */
50
35
 
51
36
#include <connect/ncbi_connection.h>
52
37
#include <asn.h>
53
38
 
54
39
 
 
40
/** @addtogroup CToolsASNConn
 
41
 *
 
42
 * @{
 
43
 */
 
44
 
 
45
 
55
46
#ifdef __cplusplus
56
47
extern "C" {
57
48
#endif
70
61
 
71
62
 
72
63
/* Build ASN stream on top of CONN (connection) handle.
73
 
 * According to arguments, the stream is created
74
 
 * either for reading or writing, and is capable to handle
 
64
 * According to arguments, the stream is created for
 
65
 * either reading or writing, and is capable to handle
75
66
 * either binary or text ASN.
76
67
 * Return ASN stream pointer on success, or 0 on error.
77
68
 * NOTE: Returned stream is valid while the underlying conn exists. After call
78
69
 *       to CONN_Close() the stream becomes invalid, and should not be used.
 
70
 *       Don't destroy the ASN stream explicitly using AsnIoFree or AsnIoFree!
79
71
 */
80
72
AsnIoPtr CreateAsnConn
81
73
(CONN               conn,
84
76
 );
85
77
 
86
78
 
87
 
/* Create service connection using provided service name,
 
79
/* Create service connection using the service name,
88
80
 * type and connection parameters, info (use default connection
89
81
 * parameters if info is passed NULL).
90
82
 * Create two ASN streams based on the connection -- one stream is for
91
83
 * input and one is for output. Return pointers to the streams 
92
84
 * via 'input' and 'output' arguments.
93
 
 * No corresponding stream is created if pointer is passed NULL.
 
85
 * No corresponding stream is created if either pointer is passed NULL.
94
86
 * On success, return created CONN handle; otherwise, return 0.
95
87
 * NOTE: Returned ASN stream pointers are valid as long as connection
96
88
 *       handle exists, that is after the connection handle is passed to
97
89
 *       CONN_Close(), both pointers become invalid, and should not be used.
 
90
 *       Don't destroy the ASN streams explicitly using AsnIoFree or AsnIoFree!
98
91
 */
99
92
CONN CreateAsnConn_ServiceEx
100
93
(const char*           service,
123
116
}  /* extern "C" */
124
117
#endif
125
118
 
126
 
#endif /* NCBI_ASN_CONNECTION__H */
 
119
 
 
120
/* @} */
 
121
 
 
122
 
 
123
/*
 
124
 * ===========================================================================
 
125
 * $Log: asn_connection.h,v $
 
126
 * Revision 1.8  2003/11/13 15:58:47  lavr
 
127
 * Guard macro changed
 
128
 *
 
129
 * Revision 1.7  2003/04/11 17:46:29  siyan
 
130
 * Added doxygen support
 
131
 *
 
132
 * Revision 1.6  2003/01/17 15:39:38  lavr
 
133
 * Slightly modify API description for clarity
 
134
 *
 
135
 * Revision 1.5  2002/03/14 22:45:45  vakatov
 
136
 * Warn against explicit destruction of ASN streams
 
137
 *
 
138
 * Revision 1.4  2001/12/02 21:17:28  lavr
 
139
 * Fix in comment
 
140
 *
 
141
 * Revision 1.3  2001/09/24 20:32:34  lavr
 
142
 * +SSERVICE_Extra* parameter in CreateAsnConn_ServiceEx()
 
143
 *
 
144
 * Revision 1.2  2001/06/28 23:01:53  vakatov
 
145
 * Typo fixed (self-#include)
 
146
 *
 
147
 * Revision 1.1  2001/06/28 21:59:24  lavr
 
148
 * Initial revision
 
149
 *
 
150
 * ==========================================================================
 
151
 */
 
152
 
 
153
#endif /* CTOOLS___ASN_CONNECTION__H */