include/yaz/zgdu.h

   1 /*
   2  * Copyright (c) 1995-2007, Index Data
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of Index Data nor the names of its contributors
  13  *       may be used to endorse or promote products derived from this
  14  *       software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27 /* $Id: zgdu.h,v 1.12 2007-01-11 10:55:56 adam Exp $ */
  28
  29 /**
  30  * \file zgdu.h
  31  * \brief Header for the Z_GDU (HTTP or Z39.50 package)
  32  */
  33
  34 #ifndef Z_GDU_H
  35 #define Z_GDU_H
  36
  37 #include <yaz/z-core.h>
  38
  39 YAZ_BEGIN_CDECL
  40
  41 typedef struct Z_HTTP_Header Z_HTTP_Header;
  42
  43 struct Z_HTTP_Header {
  44     char *name;
  45     char *value;
  46     Z_HTTP_Header *next;
  47 };
  48
  49 typedef struct {
  50     char *method;
  51     char *version;
  52     char *path;
  53     Z_HTTP_Header *headers;
  54     char *content_buf;
  55     int content_len;
  56 } Z_HTTP_Request;
  57
  58 typedef struct {
  59     int code;
  60     char *version;
  61     Z_HTTP_Header *headers;
  62     char *content_buf;
  63     int content_len;
  64 } Z_HTTP_Response;
  65
  66 #define Z_GDU_Z3950         1
  67 #define Z_GDU_HTTP_Request  2
  68 #define Z_GDU_HTTP_Response 3
  69 typedef struct {
  70     int which;
  71     union {
  72         Z_APDU *z3950;
  73         Z_HTTP_Request *HTTP_Request;
  74         Z_HTTP_Response *HTTP_Response;
  75     } u;
  76 } Z_GDU ;
  77 YAZ_EXPORT int z_GDU (ODR o, Z_GDU **p, int opt, const char *name);
  78 YAZ_EXPORT void z_HTTP_header_add(ODR o, Z_HTTP_Header **hp, const char *n,
  79                                   const char *v);
  80 YAZ_EXPORT void z_HTTP_header_add_content_type(ODR o, Z_HTTP_Header **hp,
  81                                                const char *content_type,
  82                                                const char *charset);
  83
  84 YAZ_EXPORT const char *z_HTTP_header_lookup(const Z_HTTP_Header *hp, const char *n);
  85
  86 YAZ_EXPORT const char *z_HTTP_errmsg(int code);
  87
  88 YAZ_EXPORT Z_GDU *z_get_HTTP_Response(ODR o, int code);
  89 YAZ_EXPORT Z_GDU *z_get_HTTP_Request(ODR o);
  90 YAZ_EXPORT Z_GDU *z_get_HTTP_Request_host_path(ODR odr,
  91                                                const char *host,
  92                                                const char *path);
  93
  94 YAZ_EXPORT int yaz_decode_http_request(ODR o, Z_HTTP_Request **hr_p);
  95 YAZ_EXPORT int yaz_decode_http_response(ODR o, Z_HTTP_Response **hr_p);
  96 YAZ_EXPORT int yaz_encode_http_response(ODR o, Z_HTTP_Response *hr);
  97 YAZ_EXPORT int yaz_encode_http_request(ODR o, Z_HTTP_Request *hr);
  98
  99 YAZ_END_CDECL
 100
 101 #endif
 102 /*
 103  * Local variables:
 104  * c-basic-offset: 4
 105  * indent-tabs-mode: nil
 106  * End:
 107  * vim: shiftwidth=4 tabstop=8 expandtab
 108  */
 109