gSoap下Server端接口函数的数据传出

gSoap下Server端接口函数的数据传出

一、引言
    gSOAP是一个OpenSource的web服务开发工具，包括server/client通信和wsdl自动生成功能,能依据wsdl文件生成server和client代码，产生的代码小巧简洁不依赖其他xml解析库，很容易移植，大大减轻webservice程序员的工作量。它提供一种独特的SOAP/XML到C/C++ 语言绑定，以简化C或C++中SOAP/XML Web服务和客户机的开发。gSOAP工具包括一个WSDL生成器，用于为您的 Web 服务生成 Web 服务描述。WSDL importer 工具使SOAP客户机应用程序开发完全自动化。
    gSoap大大简化了使用C/C++开发WEB Service流程，是C/C++开发人员开发WEB服务一种较佳选择。gSoap的安装以及开发文档请参见参考文献[1]、[2]和[3]，下面我们主要关注gSoap下Server端接口函数的数据传出。

二、单个传出参数
    gSoap接口函数的返回值只能是int，是soap调用的结果，一般通过soap.error来判断soap的连接情况。接口函数的最后一个参数为传出参数，必须为引用或指针类型(注:传入参数为能为引用类型)。如下所示：
    
    int ns__add(struct soap *add_soap, int num1, int num2, int *sum)；

三、多个传出参数
    如果需要传出多个参数，需要自己定义一个结构将返回项封装，然后以此结构体作为单个参数传出即可。如下所示：

   struct type_return{
     int id;
     char *name;
     int age;
   }

   int ns__getInfo(struct soap *soap, int id, struct type_result *ret);
    
四、二进制数据传出
    无论是axis c++还是gsoap，对复杂数据类型的支持都不是太好，再加上gsoap的.h文件中不能包含(#include)别的.h文件，可能不能生效，所以需要使用void数据类型，不指明数据类型，返回后再作处理。然而，gsoap不能对void数据类型进行串化(serialize)操作，除非使用union或struct分配实时类型信息。因此，当传出二进行数据时，需要使用xsd__base64Binary结构类型来操作。如下所示：
    
    struct xsd__base64Binary{
       unsigned char *__ptr;
       int __size;
    };
    
    在使用上述结构时，可能需要使用soap_malloc()来进行内存分配，并分配__size值。

    int ns__demoFunction(struct soap *soap,..., struct xsd__base64Binary *ret)
    {
      ...
      ret->__ptr = (unsigned char *)soap(soap, size); /*size为内存大小*/
      ret->__size = size;
      memset(ret->__ptr, 0, size);
      memcpy(ret->__ptr, src_ptr, size); /*src_ptr为源数据块指针*/
      ...    
      return SOAP_OK;
    }

五、文件数据传出
    Soap协议支持附件(Attachment)，gSoap支持MIME/DIME附件，我们可以使用这个特性来进行整个文件或大量的数据传出。gSoap附件操作与(四)中的二进制数据传出非常相近，同样使用struct xsd__base64Binary类型。这时不再重复，详细可参考文献[2]中的#13 MIME Attachments。

六、参考文献
1.官方网站 http://gsoap2.sourceforge.net
2.gSoap User Guide http://genivia.com/Products/gsoap/documentation.html
3.构建WEB服务C/C++客户机 http://www-128.ibm.com/developerworks/cn/websphere/library/techarticles/0301_lin/lin.html
4.用C实现WebService http://fanqiang.chinaunix.net/program/c++/2005-10-20/3730.shtml