summaryrefslogtreecommitdiffstats
path: root/libcsoap/soap-router.h
blob: 69f0e86a0eaa233a7a8a3d0c76b2ee27d93d551f (plain)
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
/******************************************************************
 *  $Id: soap-router.h,v 1.11 2006/11/23 15:27:33 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: ayaz@jprogrammer.net
 ******************************************************************/
#ifndef __csoap_router_h
#define __csoap_router_h

/**
 *
 * Authentication callback function for a cSOAP service.
 *
 */
typedef int (*soap_auth) (struct SoapEnv *request, const char *user, const char *pass);

/**
 *
 * The router object. A router can store a set of 
 * services. A service is a C function. 
 *
 */
struct SoapRouter
{
  SoapServiceNode *service_head;
  SoapServiceNode *service_tail;
  SoapService *default_service;
  soap_auth auth;
  xmlDocPtr description;
};

#ifdef __cplusplus
extern "C" {
#endif

/**
 *
 * Creates a new router object. Create a router if
 * you are implementing a soap server. Then register
 * the services to this router. 
 * <P>A router points also to http url context.
 *
 * @returns Soap router 
 *
 * @see soap_router_free
 *
 */
extern struct SoapRouter *soap_router_new(void);

/**
 *
 * Registers a SOAP service (in this case a C function)
 * to the router.
 * 
 * @param router The router object
 * @param func Function to register as a soap service
 * @param method Method name to call the function from 
 *  the client side.
 * @param urn The urn for this service
 *
 */
extern herror_t soap_router_register_service(struct SoapRouter *router, SoapServiceFunc func, const char *method, const char *urn);

/**
 *
 * Register a default service for the router.
 *
 */
extern herror_t soap_router_register_default_service(struct SoapRouter * router, SoapServiceFunc func, const char *method, const char *urn);

/**
 *
 * Register a service description for the router.
 *
 */
extern void soap_router_register_description(struct SoapRouter *router, xmlDocPtr doc);

/**
 *
 * Register a security provider for the router.
 *
 */
extern void soap_router_register_security(struct SoapRouter *router, soap_auth auth);

/**
 *
 * Searches for a registered soap service.
 *
 * @param router The router object
 * @param urn URN of the service
 * @param method The name under which the service was registered.
 *
 * @return The service if found, NULL otherwise.
 *
 */
extern SoapService *soap_router_find_service(struct SoapRouter *router, const char *urn, const char *method);

/**
 *
 * Frees the router object.
 *
 * @param router The router object to free
 *
 * @see soap_router_new
 *
 */
extern void soap_router_free(struct SoapRouter * router);

#ifdef __cplusplus
}
#endif

#endif