X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=include%2Fyaz%2Fproto.h;h=1d796baad91670643720bd5d5f7014d6f8df6f6c;hb=3a12e23d93ba2aadcddefc74ebe02b90f53381c3;hp=9dc54c2889220440941d3957b2ad2d578f04e545;hpb=76bd6780cebee47ffefa4170fa2daa1f079d9559;p=yaz-moved-to-github.git diff --git a/include/yaz/proto.h b/include/yaz/proto.h index 9dc54c2..1d796ba 100644 --- a/include/yaz/proto.h +++ b/include/yaz/proto.h @@ -1,8 +1,12 @@ /* - * Copyright (c) 1998-2004, Index Data + * Copyright (C) 1995-2005, Index Data ApS * See the file LICENSE for details. * - * $Id: proto.h,v 1.13 2004-01-15 10:16:26 adam Exp $ + * $Id: proto.h,v 1.21 2005-06-25 15:46:03 adam Exp $ + */ +/** + * \file proto.h + * \brief Header for Z39.50 Protocol */ #ifndef Z_PROTO_H #define Z_PROTO_H @@ -44,8 +48,10 @@ #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 @@ -95,6 +101,7 @@ 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; @@ -102,25 +109,67 @@ 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); + int oid_value); YAZ_EXPORT Odr_oid *yaz_str_to_z3950oid (ODR o, int oid_class, - const char *str); + 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); +/** \brief Performs "pretty" display of OPAC record to WRBUF */ YAZ_EXPORT void yaz_display_OPAC(WRBUF wrbuf, Z_OPACRecord *r, int flags); +/** \brief Performs "pretty" display of OPAC record to WRBUF using marc_t */ +void yaz_opac_decode_wrbuf(yaz_marc_t mt, Z_OPACRecord *r, WRBUF wrbuf); + +/** \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); + +/** \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); + YAZ_END_CDECL #include #endif +/* + * Local variables: + * c-basic-offset: 4 + * indent-tabs-mode: nil + * End: + * vim: shiftwidth=4 tabstop=8 expandtab + */ +