1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
/******************************************************************
* $Id: soap-server.h,v 1.29 2007/11/04 06:57:32 m0gg Exp $
*
* CSOAP Project: A SOAP client/server library in C
* Copyright (C) 2003 Ferhat Ayaz
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*
* Email: ferhatayaz@yahoo.com
******************************************************************/
#ifndef __csoap_server_h
#define __csoap_server_h
/** @page csoap_server_page Howto write a SOAP server
*
* @section soap_server_toc_sec Table of contents
*
* - @ref soap_server_init_sec
* - @ref soap_server_router_sec
* - @ref soap_server_registration_sec
* - @ref soap_server_running_sec
* - @ref soap_server_cleanup_sec
* - @ref soap_server_function_sec
*
* @section soap_server_init_sec Server initialization
*
* @code
* static const char const *url = "/csoapserver";
* static const char const *urn = "urn:examples";
* static const char const *method = "sayHello";
*
* int main(int argc, char **argv)
* {
* herror_t err;
* struct SoapRouter *router;
*
* if ((err = soap_server_init_args(argc, argv)) != H_OK)
* {
* printf("%s(): %s [%d]\n", herror_func(err), herror_message(err), herror_code(err));
* herror_release(err);
* exit(1);
* }
* @endcode
*
* @section soap_server_router_sec Router creation
*
* @code
* if (!(router = soap_router_new()))
* {
* printf("soap_router_new failed (router == %p)\n", router);
* herror_release(err);
* exit(1);
* }
* @endcode
*
* @section soap_server_registration_sec Service registration
*
* @code
* if ((err = soap_router_register_service(router, say_hello, method, urn)) != H_OK)
* {
* printf("%s(): %s [%d]\n", herror_func(err), herror_message(err), herror_code(err));
* herror_release(err);
* exit(1);
* }
* @endcode
*
* @code
* if ((err = soap_server_register_router(router, url)))
* {
* printf("%s(): %s [%d]\n", herror_func(err), herror_message(err), herror_code(err));
* herror_release(err);
* exit(1);
* }
* printf("router (%p) registered for \"%s\"\n", router, url);
* @endcode
*
* @section soap_server_running_sec Serving requests
*
* @code
* printf("press ctrl-c to shutdown\n");
* if ((err = soap_server_run()) != H_OK)
* {
* printf("%s(): %s [%d]\n", herror_func(err), herror_message(err), herror_code(err));
* herror_release(err);
* exit(1);
* }
* @endcode
*
* @section soap_server_cleanup_sec Server cleanup
*
* @code
* soap_server_destroy();
*
* exit(0);
* }
* @endcode
*
* @section soap_server_function_sec Service function
*
* @code
* herror_t say_hello(struct SoapCtx *req, struct SoapCtx *res)
* {
* herror_t err;
* char *name;
* xmlNodePtr method, node;
*
* printf("processing service request\n");
*
* xmlDocFormatDump(stdout, req->env->root->doc, 1);
*
* if ((err = soap_env_new_with_response(req->env, &res->env)) != H_OK)
* {
* printf("soap_env_new_with_response failed (%s)\n", herror_message(err));
* return err;
* }
* printf("empty response created\n");
*
* if (!(method = soap_env_get_method(req->env)))
* {
* printf("soap_env_get_method failed\n");
* return herror_new("say_hello", 0, "There may be a bug in the library...");
* }
* printf("method found\n");
*
* printf("adding response content...\n");
* node = soap_xml_get_children(method);
*
* while (node)
* {
* name = (char *) xmlNodeListGetString(node->doc, node->xmlChildrenNode, 1);
* soap_env_add_itemf(res->env, "xsd:string", "echo", "Hello '%s'", name);
* node = soap_xml_get_next(node);
* if (name)
* xmlFree(name);
* }
* printf("service request done\n");
* return H_OK;
* }
* @endcode
*
*/
/** @file soap-server.h SOAP server interface
*
* @defgroup CSOAP cSOAP
*/
/** @defgroup CSOAP_SERVER Server
* @ingroup CSOAP */
/**@{*/
typedef struct _SoapRouterNode
{
char *context;
struct SoapRouter *router;
struct _SoapRouterNode *next;
} SoapRouterNode;
#ifdef __cplusplus
extern "C" {
#endif
/** This function initializes the soap server with commandline
* arguments.
*
* @param argc commandline arg count
* @param argv commandline arg vector
*
* @return H_OK on success.
*
* @see httpd_init_args()
* @see udpd_init_args()
*/
herror_t soap_server_init_args(int argc, char **argv);
/** This function registers a router to the SOAP server.
*
@verbatim
scheme://host:port/[context]
@endverbatim
*
* @param router The router to register
* @param context the url context
*
* @return H_OK on success.
*
* @see soap_router_new()
* @see soap_router_register_service()
*/
extern herror_t soap_server_register_router(struct SoapRouter * router, const char *context);
/** This function returns an URI name of the server.
*/
extern const char *soap_server_get_name(void);
/** This function enters the server loop and starts to listen to
* incoming requests.
*
* @see httpd_run()
* @see udpd_run()
* @see smptd_run()
*/
extern herror_t soap_server_run(void);
/** This function frees the SOAP server.
*
* @see httpd_destroy()
* @see udpd_destroy()
* @see smtpd_destroy()
*/
extern void soap_server_destroy(void);
#ifdef __CSOAP_INTERNAL
extern struct SoapRouter *soap_server_find_router(const char *context);
extern SoapRouterNode * soap_server_get_routers(void);
extern herror_t soap_server_process(struct SoapCtx *request, struct SoapCtx **response);
#endif
#ifdef __cplusplus
}
#endif
/**@}*/
#endif
|
