X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=include%2Fyaz%2Fproto.h;h=60d3ec7e61cad182e56fa548e3594040dcfa4f5d;hp=647c11ebd79b218acda9a5fb51f3a1cfcc25595c;hb=5ee6205eb9bac20f3c6d033ff5926a7c1786a882;hpb=4c176312acdc3444c9afc820f76a393e64668e52 diff --git a/include/yaz/proto.h b/include/yaz/proto.h index 647c11e..60d3ec7 100644 --- a/include/yaz/proto.h +++ b/include/yaz/proto.h @@ -1,9 +1,30 @@ -/* - * Copyright (C) 1995-2005, Index Data ApS - * See the file LICENSE for details. +/* This file is part of the YAZ toolkit. + * Copyright (C) 1995-2010 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: + * + * * 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. * - * $Id: proto.h,v 1.18 2005-01-15 19:47:09 adam Exp $ + * 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. */ + /** * \file proto.h * \brief Header for Z39.50 Protocol @@ -23,6 +44,7 @@ #include #include #include +#include #include #include #include @@ -43,14 +65,18 @@ #include #include #include -#include #include +#include #include #include +#include YAZ_BEGIN_CDECL -#if 1 +/* Here are a lot of definitions that were defined in YAZ 1 and which + are still in use by some applications. We keep those to preserve + backwards compatibility.. They cause no harm. +*/ #define Z_PRES_SUCCESS Z_PresentStatus_success #define Z_PRES_PARTIAL_1 Z_PresentStatus_partial_1 #define Z_PRES_PARTIAL_2 Z_PresentStatus_partial_2 @@ -100,50 +126,77 @@ YAZ_BEGIN_CDECL #define Z_SortResultSetStatus_interim Z_SortResponse_interim #define Z_SortResultSetStatus_unchanged Z_SortResponse_unchanged #define Z_SortResultSetStatus_none Z_SortResponse_none -#endif typedef Z_External Z_DatabaseRecord; typedef struct Z_IOItemOrder Z_ItemOrder; YAZ_EXPORT Z_APDU *zget_APDU(ODR o, int which); -YAZ_EXPORT Z_Close *zget_Close (ODR o); -YAZ_EXPORT Odr_oid *yaz_oidval_to_z3950oid (ODR o, int oid_class, - int oid_value); -YAZ_EXPORT Odr_oid *yaz_str_to_z3950oid (ODR o, int oid_class, - const char *str); -YAZ_EXPORT const char *yaz_z3950oid_to_str (Odr_oid *oid, int *oid_class); - -YAZ_EXPORT const char* yaz_z3950_oid_value_to_str(oid_value ov, oid_class oc); +/** \brief Performs "pretty" display of GRS-1 record to WRBUF */ YAZ_EXPORT void yaz_display_grs1(WRBUF wrbuf, Z_GenericRecord *r, int flags); -YAZ_EXPORT void yaz_display_OPAC(WRBUF wrbuf, Z_OPACRecord *r, int flags); - +/** \brief Encodes Z39.50 Init OPtions based on string mnemonics */ YAZ_EXPORT int yaz_init_opt_encode(Z_Options *opt, const char *opt_str, - int *error_pos); + int *error_pos); + +/** \brief Decodes Z39.50 Init Options - for printing */ YAZ_EXPORT void yaz_init_opt_decode(Z_Options *opt, - void (*pr)(const char *name, - void *clientData), - void *clientData); + void (*pr)(const char *name, + void *clientData), + void *clientData); +/** \brief Creates Default Diag Format Diagnostic */ YAZ_EXPORT Z_DefaultDiagFormat *zget_DefaultDiagFormat(ODR o, int error, - const char *addinfo); + const char *addinfo); +/** \brief Creates Surrogate Diagnostic Records */ YAZ_EXPORT Z_NamePlusRecord *zget_surrogateDiagRec(ODR o, const char *dbname, - int error, const char *addinfo); + int error, const char *addinfo); +/** \brief Creates Initialize Response diagnostics */ YAZ_EXPORT Z_External *zget_init_diagnostics(ODR odr, int error, const char *addinfo); +/** \brief Creates Initialize Response diagnostics (Octet-aligned EXTERNAL) */ +YAZ_EXPORT +Z_External *zget_init_diagnostics_octet(ODR odr, int error, const char *addinfo); + +/** \brief Creates Diagnostic record - Z_DiagRecs type */ YAZ_EXPORT Z_DiagRecs *zget_DiagRecs(ODR o, int error, const char *addinfo); +/** \brief Creates Diagnostic record - Z_DiagRecs type */ YAZ_EXPORT Z_DiagRec *zget_DiagRec(ODR o, int error, const char *addinfo); +/** \brief get element set name from RecordComposition + \param comp record composition + \returns element set name or NULL if no element set name was given +*/ +YAZ_EXPORT +const char *yaz_get_esn(Z_RecordComposition *comp); + +/** \brief set element set name in RecordComposition struct + \param comp_p record composition ptr + \param esn element set name string + \param nmem memory for result composition +*/ +YAZ_EXPORT +void yaz_set_esn(Z_RecordComposition **comp_p, const char *esn, NMEM nmem); + + YAZ_END_CDECL #include #endif +/* + * Local variables: + * c-basic-offset: 4 + * c-file-style: "Stroustrup" + * indent-tabs-mode: nil + * End: + * vim: shiftwidth=4 tabstop=8 expandtab + */ +