summaryrefslogtreecommitdiffstats
path: root/libcsoap/soap-server.h
diff options
context:
space:
mode:
authorGravatar m0gg2007-11-03 22:40:09 +0000
committerGravatar m0gg2007-11-03 22:40:09 +0000
commit8a6946b18003fae6400a137389f0cb13d0ac4bd6 (patch)
tree1fb0e6f58de5596f8dae00998da18472fb4952a1 /libcsoap/soap-server.h
parentc1a7b2dabdc691139b744f0d4750f3b797b69073 (diff)
downloadcsoap-8a6946b18003fae6400a137389f0cb13d0ac4bd6.tar.gz
csoap-8a6946b18003fae6400a137389f0cb13d0ac4bd6.tar.bz2
Split nanoHTTP and cSOAP logging
Diffstat (limited to 'libcsoap/soap-server.h')
-rw-r--r--libcsoap/soap-server.h83
1 files changed, 42 insertions, 41 deletions
diff --git a/libcsoap/soap-server.h b/libcsoap/soap-server.h
index a97da1c..f2cebe5 100644
--- a/libcsoap/soap-server.h
+++ b/libcsoap/soap-server.h
@@ -1,5 +1,5 @@
/******************************************************************
- * $Id: soap-server.h,v 1.27 2007/01/25 10:28:30 m0gg Exp $
+ * $Id: soap-server.h,v 1.28 2007/11/03 22:40:09 m0gg Exp $
*
* CSOAP Project: A SOAP client/server library in C
* Copyright (C) 2003 Ferhat Ayaz
@@ -279,80 +279,79 @@
*
*/
+/** @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
-/**
- *
- * Initializes the soap server with commandline arguments.
+/** This function initializes the soap server with commandline
+ * arguments.
*
* @param argc commandline arg count
* @param argv commandline arg vector
*
- * @returns H_OK on success
- *
- * @see httpd_init_args
- * @see udpd_init_args
+ * @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.
*
- * Register a router to the SOAP server.
- *
- * <p><i>scheme</i>://<i>host</i>:<i>port</i>/<b>[context]</b>
+ @verbatim
+ scheme://host:port/[context]
+ @endverbatim
*
* @param router The router to register
* @param context the url context
*
- * @returns H_OK on success
+ * @return H_OK on success.
*
- * @see soap_router_new
- * @see soap_router_register_service
- *
+ * @see soap_router_new()
+ * @see soap_router_register_service()
*/
extern herror_t soap_server_register_router(struct SoapRouter * router, const char *context);
-/**
- *
- * Returns an URI name of the server.
- *
+/** This function returns an URI name of the server.
*/
extern const char *soap_server_get_name(void);
-/**
- *
- * Enters the server loop and starts to listen to incoming requests.
- *
- * @see httpd_run
- * @see udpd_run
- * @see smptd_run
+/** 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);
-/**
- *
- * Frees the SOAP server.
- *
- * @see httpd_destroy
- * @see udpd_destroy
+/** This function frees the SOAP server.
*
+ * @see httpd_destroy()
+ * @see udpd_destroy()
+ * @see smtpd_destroy()
*/
extern void soap_server_destroy(void);
#ifdef __CSOAP_INTERNAL
-typedef struct _SoapRouterNode
-{
- char *context;
- struct SoapRouter *router;
- struct _SoapRouterNode *next;
-
-} SoapRouterNode;
-
extern struct SoapRouter *soap_server_find_router(const char *context);
extern SoapRouterNode * soap_server_get_routers(void);
@@ -365,4 +364,6 @@ extern herror_t soap_server_process(struct SoapCtx *request, struct SoapCtx **re
}
#endif
+/**@}*/
+
#endif