Change wording ot YAZ license the 'Revised BSD License'. YAZ has used a
[yaz-moved-to-github.git] / include / yaz / zgdu.h
1 /*
2  * Copyright (c) 1995-2006, 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.9 2006-10-09 21:02:41 adam Exp $ */
28
29 /*
30  * Copyright (C) 1995-2005, Index Data ApS
31  * See the file LICENSE for details.
32  *
33  * $Id: zgdu.h,v 1.9 2006-10-09 21:02:41 adam Exp $
34  */
35
36 /**
37  * \file zgdu.h
38  * \brief Header for the Z_GDU (HTTP or Z39.50 package)
39  */
40
41 #ifndef Z_GDU_H
42 #define Z_GDU_H
43
44 #include <yaz/z-core.h>
45
46 YAZ_BEGIN_CDECL
47
48 typedef struct Z_HTTP_Header Z_HTTP_Header;
49
50 struct Z_HTTP_Header {
51     char *name;
52     char *value;
53     Z_HTTP_Header *next;
54 };
55
56 typedef struct {
57     char *method;
58     char *version;
59     char *path;
60     Z_HTTP_Header *headers;
61     char *content_buf;
62     int content_len;
63 } Z_HTTP_Request;
64
65 typedef struct {
66     int code;
67     char *version;
68     Z_HTTP_Header *headers;
69     char *content_buf;
70     int content_len;
71 } Z_HTTP_Response;
72
73 #define Z_GDU_Z3950         1
74 #define Z_GDU_HTTP_Request  2
75 #define Z_GDU_HTTP_Response 3
76 typedef struct {
77     int which;
78     union {
79         Z_APDU *z3950;
80         Z_HTTP_Request *HTTP_Request;
81         Z_HTTP_Response *HTTP_Response;
82     } u;
83 } Z_GDU ;
84 YAZ_EXPORT int z_GDU (ODR o, Z_GDU **p, int opt, const char *name);
85 YAZ_EXPORT void z_HTTP_header_add(ODR o, Z_HTTP_Header **hp, const char *n,
86                                   const char *v);
87 YAZ_EXPORT void z_HTTP_header_add_content_type(ODR o, Z_HTTP_Header **hp,
88                                                const char *content_type,
89                                                const char *charset);
90
91 YAZ_EXPORT const char *z_HTTP_header_lookup(const Z_HTTP_Header *hp, const char *n);
92
93 YAZ_EXPORT const char *z_HTTP_errmsg(int code);
94
95 YAZ_EXPORT Z_GDU *z_get_HTTP_Response(ODR o, int code);
96 YAZ_EXPORT Z_GDU *z_get_HTTP_Request(ODR o);
97 YAZ_EXPORT Z_GDU *z_get_HTTP_Request_host_path(ODR odr,
98                                                const char *host,
99                                                const char *path);
100
101 YAZ_END_CDECL
102
103 #endif
104 /*
105  * Local variables:
106  * c-basic-offset: 4
107  * indent-tabs-mode: nil
108  * End:
109  * vim: shiftwidth=4 tabstop=8 expandtab
110  */
111