← Back to branch summary

~ubuntu-branches/ubuntu/edgy/ncbi-tools6/edgy

« back to all changes in this revision

Viewing changes to connect/urlquery.h

  • Committer: Bazaar Package Importer
  • Author(s): Barry deFreese
  • Date: 2006-07-19 23:28:07 UTC
  • mfrom: (1.1.5 upstream)
  • Revision ID: james.westby@ubuntu.com-20060719232807-et3cdmcjgmnyleyx
Tags: 6.1.20060507-3ubuntu1
Re-merge with Debian

Show diffs side-by-side

added added

removed removed

Lines of Context:
connect/urlquery.h
1
1
/*   urlquery.h
2
 
* ===========================================================================
3
 
*
4
 
*                            PUBLIC DOMAIN NOTICE
5
 
*            National Center for Biotechnology Information (NCBI)
6
 
*
7
 
*  This software/database is a "United States Government Work" under the
8
 
*  terms of the United States Copyright Act.  It was written as part of
9
 
*  the author's official duties as a United States Government employee and
10
 
*  thus cannot be copyrighted.  This software/database is freely available
11
 
*  to the public for use. The National Library of Medicine and the U.S.
12
 
*  Government do not place any restriction on its use or reproduction.
13
 
*  We would, however, appreciate having the NCBI and the author cited in
14
 
*  any work or product based on this material
15
 
*
16
 
*  Although all reasonable efforts have been taken to ensure the accuracy
17
 
*  and reliability of the software and data, the NLM and the U.S.
18
 
*  Government do not and cannot warrant the performance or results that
19
 
*  may be obtained by using this software or data. The NLM and the U.S.
20
 
*  Government disclaim all warranties, express or implied, including
21
 
*  warranties of performance, merchantability or fitness for any particular
22
 
*  purpose.
23
 
*
24
 
* ===========================================================================
25
 
*
26
 
* File Name:  urlquery.h
27
 
*
28
 
* Author:  Jonathan Kans
29
 
*
30
 
* Version Creation Date:   4/16/98
31
 
*
32
 
* $Revision: 6.12 $
33
 
*
34
 
* File Description: 
35
 
*
36
 
* Modifications:  
37
 
* --------------------------------------------------------------------------
38
 
* $Log: urlquery.h,v $
39
 
* Revision 6.12  2003/09/03 21:15:29  lavr
40
 
* Reuse "arguments" in QUERY_OpenServiceQuery() to be real service argument
41
 
* (formely it was to modify the dispatcher and was not really used anywhere)
42
 
*
43
 
* Revision 6.11  2002/11/21 15:24:31  johnson
44
 
* changed 'queue' vars to 'q' to avoid stl conflict
45
 
*
46
 
* Revision 6.10  2001/06/07 20:07:41  kans
47
 
* added QUERY_OpenServiceQuery
48
 
*
49
 
* Revision 6.9  2001/02/21 22:02:04  lavr
50
 
* Changes for use new CONN interface
51
 
*
52
 
* Revision 6.8  2000/08/18 19:08:58  kans
53
 
* added QUERY_WaitForNextMacEvent, otherwise QuickDraw collides with mmdbapi
54
 
*
55
 
* Revision 6.7  2000/06/30 12:46:11  kans
56
 
* added QUERY_CloseQueue
57
 
*
58
 
* Revision 6.6  2000/06/29 18:27:10  kans
59
 
* QUERY_OpenUrlQuery has new EMIME_Type type and EMIME_Encoding encoding parameters
60
 
*
61
 
* Revision 6.5  2000/06/13 12:58:15  kans
62
 
* added closeConn parameter to QUERY_AddToQueue
63
 
*
64
 
* Revision 6.4  1999/07/28 21:05:23  vakatov
65
 
* Moved all #include's from inside the NLM_EXTERN & `extern "C"' block
66
 
*
67
 
* ==========================================================================
68
 
*/
 
2
 * ===========================================================================
 
3
 *
 
4
 *                            PUBLIC DOMAIN NOTICE
 
5
 *            National Center for Biotechnology Information (NCBI)
 
6
 *
 
7
 *  This software/database is a "United States Government Work" under the
 
8
 *  terms of the United States Copyright Act.  It was written as part of
 
9
 *  the author's official duties as a United States Government employee and
 
10
 *  thus cannot be copyrighted.  This software/database is freely available
 
11
 *  to the public for use. The National Library of Medicine and the U.S.
 
12
 *  Government do not place any restriction on its use or reproduction.
 
13
 *  We would, however, appreciate having the NCBI and the author cited in
 
14
 *  any work or product based on this material
 
15
 *
 
16
 *  Although all reasonable efforts have been taken to ensure the accuracy
 
17
 *  and reliability of the software and data, the NLM and the U.S.
 
18
 *  Government do not and cannot warrant the performance or results that
 
19
 *  may be obtained by using this software or data. The NLM and the U.S.
 
20
 *  Government disclaim all warranties, express or implied, including
 
21
 *  warranties of performance, merchantability or fitness for any particular
 
22
 *  purpose.
 
23
 *
 
24
 * ===========================================================================
 
25
 *
 
26
 * File Name:  urlquery.h
 
27
 *
 
28
 * Author:  Jonathan Kans
 
29
 *
 
30
 * Version Creation Date:   4/16/98
 
31
 *
 
32
 * $Revision: 6.15 $
 
33
 *
 
34
 * File Description: 
 
35
 *
 
36
 * Modifications:  
 
37
 * --------------------------------------------------------------------------
 
38
 * $Log: urlquery.h,v $
 
39
 * Revision 6.15  2006/04/15 01:59:01  lavr
 
40
 * +QUERY_OpenServiceQueryEx
 
41
 *
 
42
 * Revision 6.14  2006/01/24 20:22:26  lavr
 
43
 * The boiler plate and revision log reindented
 
44
 *
 
45
 * Revision 6.13  2006/01/19 21:11:42  lavr
 
46
 * QUERY_SendQuery() to return EIO_Status
 
47
 *
 
48
 * Revision 6.12  2003/09/03 21:15:29  lavr
 
49
 * Reuse "arguments" in QUERY_OpenServiceQuery() to be real service argument
 
50
 * (formely it was to modify the dispatcher and was not really used anywhere)
 
51
 *
 
52
 * Revision 6.11  2002/11/21 15:24:31  johnson
 
53
 * changed 'queue' vars to 'q' to avoid stl conflict
 
54
 *
 
55
 * Revision 6.10  2001/06/07 20:07:41  kans
 
56
 * added QUERY_OpenServiceQuery
 
57
 *
 
58
 * Revision 6.9  2001/02/21 22:02:04  lavr
 
59
 * Changes for use new CONN interface
 
60
 *
 
61
 * Revision 6.8  2000/08/18 19:08:58  kans
 
62
 * added QUERY_WaitForNextMacEvent, otherwise QuickDraw collides with mmdbapi
 
63
 *
 
64
 * Revision 6.7  2000/06/30 12:46:11  kans
 
65
 * added QUERY_CloseQueue
 
66
 *
 
67
 * Revision 6.6  2000/06/29 18:27:10  kans
 
68
 * QUERY_OpenUrlQuery has new EMIME_Type type and EMIME_Encoding encoding parameters
 
69
 *
 
70
 * Revision 6.5  2000/06/13 12:58:15  kans
 
71
 * added closeConn parameter to QUERY_AddToQueue
 
72
 *
 
73
 * Revision 6.4  1999/07/28 21:05:23  vakatov
 
74
 * Moved all #include's from inside the NLM_EXTERN & `extern "C"' block
 
75
 *
 
76
 * ==========================================================================
 
77
 */
69
78
 
70
79
#ifndef _URLQUERY_
71
80
#define _URLQUERY_
118
127
);
119
128
 
120
129
/*
121
 
  Returns connection to NCBI named service.  Pass arguments (if any)
122
 
  via the connection to the service (if successful).  Return NULL on error.
123
 
*/
124
 
 
 
130
  Returns connection to NCBI named service.  Pass parameters (if any)
 
131
  via the connection to the service (if successful).  Optionally,
 
132
  arguments may be passed to services that support connections via
 
133
  URLs (note that unlike the service parameters these is no guarantee
 
134
  that the arguments will be passed since the service can be implemented
 
135
  in a non-URL-compatible manner, like e.g. via a standalone server).
 
136
  Return NULL on error.
 
137
*/
 
138
 
 
139
NLM_EXTERN CONN QUERY_OpenServiceQueryEx (
 
140
  Nlm_CharPtr service, Nlm_CharPtr parameters, Nlm_Uint4 timeoutsec,
 
141
  Nlm_CharPtr arguments
 
142
);
 
143
 
 
144
/*
 
145
  Same as QUERY_OpenServiceQueryEx(service, parameters, timeoutsec, 0);
 
146
*/
125
147
NLM_EXTERN CONN QUERY_OpenServiceQuery (
126
 
  Nlm_CharPtr service, Nlm_CharPtr arguments, Nlm_Uint4 timeoutsec
 
148
  Nlm_CharPtr service, Nlm_CharPtr parameters, Nlm_Uint4 timeoutsec
127
149
);
128
150
 
129
151
/*
133
155
  either with CONN_Read, QUERY_CopyFileToQuery, or with QUERY_AsnIoConnOpen
134
156
  followed by a specific AsnWrite function.
135
157
*/
136
 
NLM_EXTERN void QUERY_SendQuery (
 
158
NLM_EXTERN EIO_Status QUERY_SendQuery (
137
159
  CONN conn
138
160
);
139
161