X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=include%2Fyaz%2Fzoom.h;h=9d4451c53c4108df98251714799cbb7b94d17819;hp=09383a8e441ef7829c47e5a108bbdf33a2b0507a;hb=c83035e0e0177b385091cd273562ea0d222b5908;hpb=fb6d99a0c7e07d9cc4a315c447deaf6564a85505 diff --git a/include/yaz/zoom.h b/include/yaz/zoom.h index 09383a8..9d4451c 100644 --- a/include/yaz/zoom.h +++ b/include/yaz/zoom.h @@ -1,9 +1,31 @@ /* - * Copyright (C) 1995-2005, Index Data ApS - * See the file LICENSE for details. + * Copyright (c) 1995-2006, Index Data + * All rights reserved. + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: * - * $Id: zoom.h,v 1.26 2005-06-25 15:46:03 adam Exp $ + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * * Neither the name of Index Data nor the names of its contributors + * may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY + * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY + * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/* $Id: zoom.h,v 1.39 2006-10-13 11:30:37 adam Exp $ */ + /** * \file zoom.h * \brief Header for ZOOM @@ -30,7 +52,6 @@ typedef struct ZOOM_options_p *ZOOM_options; typedef struct ZOOM_query_p *ZOOM_query; typedef struct ZOOM_connection_p *ZOOM_connection; typedef struct ZOOM_resultset_p *ZOOM_resultset; -typedef struct ZOOM_task_p *ZOOM_task; typedef struct ZOOM_record_p *ZOOM_record; typedef struct ZOOM_scanset_p *ZOOM_scanset; typedef struct ZOOM_package_p *ZOOM_package; @@ -62,6 +83,9 @@ ZOOM_connection_destroy (ZOOM_connection c); ZOOM_API(const char *) ZOOM_connection_option_get (ZOOM_connection c, const char *key); +ZOOM_API(const char *) +ZOOM_connection_option_getl (ZOOM_connection c, const char *key, int *lenp); + ZOOM_API(void) ZOOM_connection_option_set (ZOOM_connection c, const char *key, const char *val); @@ -90,6 +114,9 @@ ZOOM_connection_errmsg (ZOOM_connection c); /* returns additional info */ ZOOM_API(const char *) ZOOM_connection_addinfo (ZOOM_connection c); +/* returns diagnostic set */ +ZOOM_API(const char *) +ZOOM_connection_diagset (ZOOM_connection c); /* translates error code into human-readable string */ ZOOM_API(const char *) ZOOM_diag_str (int error); @@ -106,6 +133,10 @@ ZOOM_diag_str (int error); #define ZOOM_ERROR_UNSUPPORTED_PROTOCOL 10008 #define ZOOM_ERROR_UNSUPPORTED_QUERY 10009 #define ZOOM_ERROR_INVALID_QUERY 10010 +#define ZOOM_ERROR_CQL_PARSE 10011 +#define ZOOM_ERROR_CQL_TRANSFORM 10012 +#define ZOOM_ERROR_CCL_CONFIG 10013 +#define ZOOM_ERROR_CCL_PARSE 10014 ZOOM_API(int) ZOOM_connection_last_event(ZOOM_connection cs); @@ -120,6 +151,7 @@ ZOOM_connection_last_event(ZOOM_connection cs); #define ZOOM_EVENT_RECV_APDU 7 #define ZOOM_EVENT_RECV_RECORD 8 #define ZOOM_EVENT_RECV_SEARCH 9 +#define ZOOM_EVENT_END 10 /* ----------------------------------------------------------- */ /* result sets */ @@ -189,6 +221,14 @@ ZOOM_query_destroy(ZOOM_query s); /* CQL */ ZOOM_API(int) ZOOM_query_cql(ZOOM_query s, const char *str); +/* CQL translated client-side into RPN: `conn' is optional for diagnostics */ +ZOOM_API(int) +ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn); +/* CCL translated client-side into RPN: `conn' is optional for diagnostics */ +ZOOM_API(int) +ZOOM_query_ccl2rpn(ZOOM_query s, const char *query_str, + const char *config, + int *ccl_error, const char **error_string, int *error_pos); /* PQF */ ZOOM_API(int) ZOOM_query_prefix(ZOOM_query s, const char *str); @@ -201,6 +241,9 @@ ZOOM_query_sortby(ZOOM_query s, const char *criteria); ZOOM_API(ZOOM_scanset) ZOOM_connection_scan (ZOOM_connection c, const char *startterm); +ZOOM_API(ZOOM_scanset) +ZOOM_connection_scan1 (ZOOM_connection c, ZOOM_query startterm); + ZOOM_API(const char *) ZOOM_scanset_term(ZOOM_scanset scan, size_t pos, int *occ, int *len); @@ -241,10 +284,13 @@ ZOOM_API(void) const char *val); /* ----------------------------------------------------------- */ -/* Sort */ +/* Sort. First function is deprecated, use second instead */ ZOOM_API(void) ZOOM_resultset_sort(ZOOM_resultset r, const char *sort_type, const char *sort_spec); +ZOOM_API(int) + ZOOM_resultset_sort1(ZOOM_resultset r, + const char *sort_type, const char *sort_spec); /* ----------------------------------------------------------- */ /* options */ @@ -266,6 +312,9 @@ ZOOM_API(ZOOM_options) ZOOM_API(const char *) ZOOM_options_get (ZOOM_options opt, const char *name); +ZOOM_API(const char *) +ZOOM_options_getl (ZOOM_options opt, const char *name, int *lenp); + ZOOM_API(void) ZOOM_options_set (ZOOM_options opt, const char *name, const char *v); @@ -294,6 +343,9 @@ ZOOM_options_set_int(ZOOM_options opt, const char *name, int value); ZOOM_API(int) ZOOM_event (int no, ZOOM_connection *cs); +ZOOM_API(int) +ZOOM_connection_is_idle(ZOOM_connection cs); + ZOOM_END_CDECL /* * Local variables: