X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=include%2Fyaz%2Fproto.h;h=7031804357adc69916977716ebbf3f03682ff887;hp=f1bf623de23981fc40637c376c414c8ff0533963;hb=d72929b7de6221054feb6a220dc72289b0f3e03d;hpb=c620a713f1418315efcd4e6fab225e036775d365 diff --git a/include/yaz/proto.h b/include/yaz/proto.h index f1bf623..7031804 100644 --- a/include/yaz/proto.h +++ b/include/yaz/proto.h @@ -1,9 +1,34 @@ /* - * Copyright (c) 1998-2003, Index Data - * See the file LICENSE for details. - * Sebastian Hammer, Adam Dickmeiss + * Copyright (c) 1995-2007, 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: proto.h,v 1.7 2003-02-12 15:06:43 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: proto.h,v 1.28 2007-12-16 11:08:50 adam Exp $ */ + +/** + * \file proto.h + * \brief Header for Z39.50 Protocol */ #ifndef Z_PROTO_H #define Z_PROTO_H @@ -40,11 +65,14 @@ #include #include #include -#include #include +#include +#include +#include YAZ_BEGIN_CDECL +#if 1 #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 @@ -94,69 +122,78 @@ 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); -typedef struct Z_HTTP_Header Z_HTTP_Header; - -struct Z_HTTP_Header { - char *name; - char *value; - Z_HTTP_Header *next; -}; - -typedef struct { - char *method; - char *version; - char *path; - Z_HTTP_Header *headers; - char *content_buf; - int content_len; -} Z_HTTP_Request; - -typedef struct { - int code; - char *version; - Z_HTTP_Header *headers; - char *content_buf; - int content_len; -} Z_HTTP_Response; - -#define Z_GDU_Z3950 1 -#define Z_GDU_HTTP_Request 2 -#define Z_GDU_HTTP_Response 3 -typedef struct { - int which; - union { - Z_APDU *z3950; - Z_HTTP_Request *HTTP_Request; - Z_HTTP_Response *HTTP_Response; - } u; -} Z_GDU ; -YAZ_EXPORT int z_GDU (ODR o, Z_GDU **p, int opt, const char *name); -YAZ_EXPORT void z_HTTP_header_add(ODR o, Z_HTTP_Header **hp, const char *n, - const char *v); -YAZ_EXPORT const char *z_HTTP_header_lookup(Z_HTTP_Header *hp, const char *n); - -YAZ_EXPORT const char *z_HTTP_errmsg(int code); - -YAZ_EXPORT Z_GDU *z_get_HTTP_Response(ODR o, int code); +/** \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); + +/** \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); +/** \brief Creates Default Diag Format Diagnostic */ +YAZ_EXPORT +Z_DefaultDiagFormat *zget_DefaultDiagFormat(ODR o, int error, + const char *addinfo); + +/** \brief Creates Surrogate Diagnostic Records */ +YAZ_EXPORT +Z_NamePlusRecord *zget_surrogateDiagRec(ODR o, const char *dbname, + 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 + * indent-tabs-mode: nil + * End: + * vim: shiftwidth=4 tabstop=8 expandtab + */ +