X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=include%2Fyaz%2Fzoom.h;h=09383a8e441ef7829c47e5a108bbdf33a2b0507a;hb=fb6d99a0c7e07d9cc4a315c447deaf6564a85505;hp=0937a20bbba3272ea9be7e818c828b6317f8e957;hpb=162ddfa4248521c7af9183eac839353434c67f3c;p=yaz-moved-to-github.git diff --git a/include/yaz/zoom.h b/include/yaz/zoom.h index 0937a20..09383a8 100644 --- a/include/yaz/zoom.h +++ b/include/yaz/zoom.h @@ -1,8 +1,15 @@ /* - * Public header for ZOOM C. - * $Id: zoom.h,v 1.14 2002-11-30 22:30:51 mike Exp $ + * Copyright (C) 1995-2005, Index Data ApS + * See the file LICENSE for details. + * + * $Id: zoom.h,v 1.26 2005-06-25 15:46:03 adam Exp $ + */ +/** + * \file zoom.h + * \brief Header for ZOOM */ +#include #include #define ZOOM_BEGIN_CDECL YAZ_BEGIN_CDECL @@ -22,7 +29,7 @@ ZOOM_BEGIN_CDECL 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_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; @@ -45,7 +52,7 @@ ZOOM_connection_create (ZOOM_options options); /* connect given existing connection */ ZOOM_API(void) ZOOM_connection_connect(ZOOM_connection c, const char *host, - int portnum); + int portnum); /* destroy connection (close connection also) */ ZOOM_API(void) @@ -59,12 +66,20 @@ ZOOM_API(void) ZOOM_connection_option_set (ZOOM_connection c, const char *key, const char *val); +ZOOM_API(void) +ZOOM_connection_option_setl (ZOOM_connection c, const char *key, + const char *val, int len); + /* return error code (0 == success, failure otherwise). cp holds error string on failure, addinfo holds addititional info (if any) */ ZOOM_API(int) ZOOM_connection_error (ZOOM_connection c, const char **cp, - const char **addinfo); + const char **addinfo); + +ZOOM_API(int) +ZOOM_connection_error_x (ZOOM_connection c, const char **cp, + const char **addinfo, const char **diagset); /* returns error code */ ZOOM_API(int) @@ -88,6 +103,9 @@ ZOOM_diag_str (int error); #define ZOOM_ERROR_INIT 10005 #define ZOOM_ERROR_INTERNAL 10006 #define ZOOM_ERROR_TIMEOUT 10007 +#define ZOOM_ERROR_UNSUPPORTED_PROTOCOL 10008 +#define ZOOM_ERROR_UNSUPPORTED_QUERY 10009 +#define ZOOM_ERROR_INVALID_QUERY 10010 ZOOM_API(int) ZOOM_connection_last_event(ZOOM_connection cs); @@ -100,6 +118,8 @@ ZOOM_connection_last_event(ZOOM_connection cs); #define ZOOM_EVENT_UNKNOWN 5 #define ZOOM_EVENT_SEND_APDU 6 #define ZOOM_EVENT_RECV_APDU 7 +#define ZOOM_EVENT_RECV_RECORD 8 +#define ZOOM_EVENT_RECV_SEARCH 9 /* ----------------------------------------------------------- */ /* result sets */ @@ -138,6 +158,10 @@ ZOOM_resultset_record (ZOOM_resultset s, size_t pos); ZOOM_API(ZOOM_record) ZOOM_resultset_record_immediate (ZOOM_resultset s, size_t pos); +/* reset record cache for result set */ +ZOOM_API(void) +ZOOM_resultset_cache_reset(ZOOM_resultset r); + /* ----------------------------------------------------------- */ /* records */ @@ -162,7 +186,10 @@ ZOOM_query_create(void); /* destroy it */ ZOOM_API(void) ZOOM_query_destroy(ZOOM_query s); -/* specify prefix query for search */ +/* CQL */ +ZOOM_API(int) +ZOOM_query_cql(ZOOM_query s, const char *str); +/* PQF */ ZOOM_API(int) ZOOM_query_prefix(ZOOM_query s, const char *str); /* specify sort criteria for search */ @@ -178,6 +205,10 @@ ZOOM_API(const char *) ZOOM_scanset_term(ZOOM_scanset scan, size_t pos, int *occ, int *len); +ZOOM_API(const char *) +ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos, + int *occ, int *len); + ZOOM_API(size_t) ZOOM_scanset_size(ZOOM_scanset scan); @@ -210,6 +241,12 @@ ZOOM_API(void) const char *val); /* ----------------------------------------------------------- */ +/* Sort */ +ZOOM_API(void) + ZOOM_resultset_sort(ZOOM_resultset r, + const char *sort_type, const char *sort_spec); + +/* ----------------------------------------------------------- */ /* options */ ZOOM_API(ZOOM_options_callback) @@ -258,3 +295,11 @@ ZOOM_API(int) ZOOM_event (int no, ZOOM_connection *cs); ZOOM_END_CDECL +/* + * Local variables: + * c-basic-offset: 4 + * indent-tabs-mode: nil + * End: + * vim: shiftwidth=4 tabstop=8 expandtab + */ +