From 504da9682a1e739b41cfdbb25721f518c83ebf83 Mon Sep 17 00:00:00 2001 From: m0gg Date: Mon, 27 Nov 2006 11:15:27 +0000 Subject: Documentation enhancements --- libcsoap/soap-addressing.h | 10 ++++++---- libcsoap/soap-nudp.h | 31 ++++++++++++++++++++++++++++--- libcsoap/soap-wsil.c | 4 +++- libcsoap/soap-xmlsec.h | 27 +++++++++++++++++++++++++-- 4 files changed, 62 insertions(+), 10 deletions(-) (limited to 'libcsoap') diff --git a/libcsoap/soap-addressing.h b/libcsoap/soap-addressing.h index ed2ca86..e6ac288 100644 --- a/libcsoap/soap-addressing.h +++ b/libcsoap/soap-addressing.h @@ -1,5 +1,5 @@ /****************************************************************** - * $Id: soap-addressing.h,v 1.5 2006/11/25 16:35:57 m0gg Exp $ + * $Id: soap-addressing.h,v 1.6 2006/11/27 11:15:27 m0gg Exp $ * * CSOAP Project: A SOAP client/server library in C * Copyright (C) 2006 Heiko Ronsdorf @@ -25,6 +25,8 @@ #define __csoap_addressing_h /** @file + * + * WS-Addressing * * WS-Addressing provides transport-neutral mechanisms to address Web services * and messages. Specifically, this specification defines XML [XML 1.0, XML @@ -35,10 +37,10 @@ * in a transport-neutral manner. * * @author H. Ronsdorf - * @version $Revision: 1.5 $ + * @version $Revision: 1.6 $ * - * @see http://www.w3.org/TR/ws-addr-core/, - * http://www.w3.org/TR/REC-xml-names/ + * @see http://www.w3.org/TR/ws-addr-core/, + * http://www.w3.org/TR/REC-xml-names/ * */ diff --git a/libcsoap/soap-nudp.h b/libcsoap/soap-nudp.h index 8978b70..fe76db7 100644 --- a/libcsoap/soap-nudp.h +++ b/libcsoap/soap-nudp.h @@ -1,8 +1,8 @@ /****************************************************************** -* $Id: soap-nudp.h,v 1.3 2006/11/26 20:13:05 m0gg Exp $ +* $Id: soap-nudp.h,v 1.4 2006/11/27 11:15:27 m0gg Exp $ * * CSOAP Project: A SOAP client/server library in C -* Copyright (C) 2007 Heiko Ronsdorf +* Copyright (C) 2006 Heiko Ronsdorf * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Library General Public @@ -24,12 +24,37 @@ #ifndef __csoap_nudp_h #define __csoap_nudp_h -#ifdef __CSOAP_INTERNAL +/** @file + * + * SOAP-over-UDP server/client module + * + * Many Application protocol patterns match the semantics of the User Datagram + * Protocol (UDP, RFC 768). Some do not require the delivery guarantees of TCP + * while others make use of multicats transmisson. In order to allow Web Services + * to support these pattersn, we need a way to map SOAP envelopes to user + * datagrams. This support is essential for services using WS-Discovery, where + * the use of multicast and need for low connection overhead makes UDP a natural + * choice. It is anticipated that other protocols will have similar requirements. + * + * @author H. Ronsdorf + * @version $Revision: 1.4 $ + * + * @see http://specs.xmlsoap.org/ws/2004/09/soap-over-udp/soap-over-udp.pdf, + * http://www.ietf.org/rfc/rfc768.txt + * + */ +/** + * + * Commandline argument to set the UDP port. + * + */ #define NUDP_ARG_PORT "-NUDPport" #define NUDP_DEFAULT_PORT 10001 +#ifdef __CSOAP_INTERNAL + #ifdef __cplusplus extern "C" { #endif diff --git a/libcsoap/soap-wsil.c b/libcsoap/soap-wsil.c index 3d03b37..7bbc23a 100644 --- a/libcsoap/soap-wsil.c +++ b/libcsoap/soap-wsil.c @@ -1,5 +1,5 @@ /****************************************************************** -* $Id: soap-wsil.c,v 1.5 2006/11/27 10:52:39 m0gg Exp $ +* $Id: soap-wsil.c,v 1.6 2006/11/27 11:15:27 m0gg Exp $ * * CSOAP Project: A SOAP client/server library in C * Copyright (C) 2003 Ferhat Ayaz @@ -37,6 +37,7 @@ #include #include +#include #include #include @@ -44,6 +45,7 @@ #include "soap-service.h" #include "soap-router.h" #include "soap-server.h" +#include "soap-transport.h" #include "soap-wsil.h" static void diff --git a/libcsoap/soap-xmlsec.h b/libcsoap/soap-xmlsec.h index 0f9368c..fc24fc5 100644 --- a/libcsoap/soap-xmlsec.h +++ b/libcsoap/soap-xmlsec.h @@ -1,5 +1,5 @@ /****************************************************************** - * $Id: soap-xmlsec.h,v 1.1 2006/11/24 11:22:55 m0gg Exp $ + * $Id: soap-xmlsec.h,v 1.2 2006/11/27 11:15:27 m0gg Exp $ * * CSOAP Project: A SOAP client/server library in C * Copyright (C) 2006 Heiko Ronsdorf @@ -24,6 +24,25 @@ #ifndef __csoap_xmlsec_h #define __csoap_xmlsec_h +/** @file + * + * Web Services Security + * + * This module is implemented using the xmlsec1 library. + * + * @author H. Ronsdorf + * @version $Revision: 1.2 $ + * + * @see http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=wss + * http://www.aleksey.com/xmlsec/, + * + */ + +/** + * + * Commandline argument to enabled WS-Security. + * + */ #define CSOAP_ENABLE_XMLSEC "-CSOAPxmlsec" #ifdef __cplusplus @@ -32,7 +51,7 @@ extern "C" { /** * - * Initializes the XML security subsystem. + * Initializes the WS-Security subsystem. * * @param argc commandline arg count * @param argv commandline arg vector @@ -46,6 +65,8 @@ extern herror_t soap_xmlsec_init_args(int argc, char **argv); * * Sign a XML document contained in a SOAP Envelope * + * @param envelope The SOAP envelope to be signed. + * */ extern herror_t soap_xmlsec_sign(struct SoapEnv *envelope); @@ -53,6 +74,8 @@ extern herror_t soap_xmlsec_sign(struct SoapEnv *envelope); * * Encrypt a XML document contained in a SOAP envelope. * + * @param envelope The SOAP envelope to be encrypted. + * */ extern herror_t soap_xmlsec_encrypt(struct SoapEnv *envelope); -- cgit v1.1-32-gdbae