axis-java-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dushshan...@apache.org
Subject svn commit: r525136 - /webservices/axis2/trunk/c/xdocs/docs/axis2c_manual.html
Date Tue, 03 Apr 2007 11:19:14 GMT
Author: dushshantha
Date: Tue Apr  3 04:19:13 2007
New Revision: 525136

URL: http://svn.apache.org/viewvc?view=rev&rev=525136
Log:
updated axis2c manual.

Modified:
    webservices/axis2/trunk/c/xdocs/docs/axis2c_manual.html

Modified: webservices/axis2/trunk/c/xdocs/docs/axis2c_manual.html
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/xdocs/docs/axis2c_manual.html?view=diff&rev=525136&r1=525135&r2=525136
==============================================================================
--- webservices/axis2/trunk/c/xdocs/docs/axis2c_manual.html (original)
+++ webservices/axis2/trunk/c/xdocs/docs/axis2c_manual.html Tue Apr  3 04:19:13 2007
@@ -36,7 +36,7 @@
 <p>This sections is aimed to help you to get a Web service up in quick time
 using Axis2/C and consume that service using an Axis2/C client.</p>
 
-<p>First download the latest binary release form Apache Axis2/C
+<p>First download the latest binary release form Apache Axis2/C</p>
 <a href="http://ws.apache.org/axis2/c/download.cgi">download page</a>. Once
 you download the correct binary that suits your platform, all that you
 require to get it running is to extract the package to a folder of your
@@ -52,6 +52,10 @@
 href="http://ws.apache.org/axis2/c/docs/installationguide.html">installation
 guide</a> for more details. 
 
+<p><br>
+<br>
+</p>
+
 <p>Once you have Axis2/C up and running successfully, you can start writing
 your own services and clients. The following sections detail how to write
 your first service and client with Axis2/C.</p>
@@ -129,15 +133,15 @@
 
     if (node)
     {
-        client_greeting_node = AXIOM_NODE_GET_FIRST_CHILD(node, env);
+        client_greeting_node = axiom_node_get_first_child(node, env);
         if (client_greeting_node &amp;&amp; 
-        AXIOM_NODE_GET_NODE_TYPE(client_greeting_node, env) == AXIOM_TEXT)
+        axiom_node_get_node_type(client_greeting_node, env) == AXIOM_TEXT)
         {
             axiom_text_t *greeting = 
-            (axiom_text_t *)AXIOM_NODE_GET_DATA_ELEMENT(client_greeting_node, env);
-            if (greeting &amp;&amp; AXIOM_TEXT_GET_VALUE(greeting , env))
+            (axiom_text_t *)axiom_node_get_data_element(client_greeting_node, env);
+            if (greeting &amp;&amp; axiom_text_get_value(greeting , env))
             {
-                axis2_char_t *greeting_str = AXIOM_TEXT_GET_VALUE(greeting, env);
+                axis2_char_t *greeting_str = axiom_text_get_value(greeting, env);
                 printf("Client greeted saying \"%s\" \n", greeting_str);
                 return_node = build_greeting_response(env, "Hello Client!");
             }
@@ -258,21 +262,19 @@
 <p>On Linux:</p>
 <pre>gcc -shared -olibhello.so -I$AXIS2C_HOME/include -L$AXIS2C_HOME/lib -laxis2 hello.c</pre>
 
-<p>On Windows:</p>
-<p> Make sure you have run 'vcvars32.bat' to set the environment variables and path
-retuired to run the compiler and linker on command line</p>
-<p>to compile - </p>
-<pre>cl.exe /D "WIN32" /D "_WINDOWS" /D "_MBCS"/D"AXIS2_DECLARE_EXPORT" 
-/D "AXIS2_SVR_MULTI_THREADED" /w /nologo /I $(AXIS2_INCLUDE_PATH)
-/I $(APACHE_INCLUDE_PATH) hello.c</pre>
+<p>On Windows</p>
 
-<p>to link - </p>
-<pre>link.exe /nologo /LIBPATH:$(AXIS2_LIBS) /LIBPATH:$(LIBXSLT_BIN_DIR)\lib 
-         /LIBPATH:$(LIBXML2_BIN_DIR)\lib  /LIBPATH:$(APACHE_BIN_DIR)\lib 
-         /LIBPATH:$(ZLIB_BIN_DIR)\lib *.obj axis2_util.lib axiom.lib 
-         axis2_parser.lib axis2_engine.lib Rpcrt4.lib Ws2_32.lib 
-         /DLL /OUT:hello.dll</pre>
+<p>to compile,</p>
+<pre>cl.exe /D "WIN32" /D "_WINDOWS" /D "_MBCS"/D"AXIS2_DECLARE_EXPORT" 
+/D "AXIS2_SVR_MULTI_THREADED" /w /nologo $(AXIS2_INCLUDE_PATH)
+$(APACHE_INCLUDE_PATH) /I hello.c</pre>
 
+<p>to link,</p>
+<pre>link.exe /nologo /LIBPATH:$(AXIS2_LIBS)
+/LIBPATH:$(LIBXML2_INSTALL_DIR)\lib
+/LIBPATH:$(APACHE_INSTALL_DIR)\lib 
+/LIBPATH:$(ZLIB_INSTALL_DIR)\lib *.obj $(AXIS2_UTIL).lib $(AXIOM).lib
+$(AXIS2_PARSER).lib $(LIBS) $(AXIS2_ENGINE).lib /DLL /OUT:hello.dll</pre>
 
 <h3>1.1.7 Deploying the Service</h3>
 
@@ -355,9 +357,9 @@
 
 <h3>1.2.2 Using Service Client</h3>
 <pre>    svc_client = axis2_svc_client_create(env, client_home);
-    AXIS2_SVC_CLIENT_SET_OPTIONS(svc_client, env, options);
+    axis2_svc_client_set_options(svc_client, env, options);
     payload = build_om_request(env);
-    ret_node = AXIS2_SVC_CLIENT_SEND_RECEIVE(svc_client, env, payload);</pre>
+    ret_node = axis2_svc_client_send_receive(svc_client, env, payload);</pre>
 
 <p>After creating and preparing the options, the next step is to create a
 service client instance and use it to send the request and receive the
@@ -609,13 +611,13 @@
 {
     if(node)
     {
-        if(AXIOM_NODE_GET_NODE_TYPE(node, env) == AXIOM_ELEMENT)
+        if(axiom_node_get_node_type(node, env) == AXIOM_ELEMENT)
         {
             axiom_element_t *element = NULL;
-            element = (axiom_element_t *)AXIOM_NODE_GET_DATA_ELEMENT(node, env);
+            element = (axiom_element_t *)axiom_node_get_data_element(node, env);
             if(element)
             {
-                axis2_char_t *op_name = AXIOM_ELEMENT_GET_LOCALNAME(element, env);
+                axis2_char_t *op_name = axiom_element_get_localname(element, env);
                 if(op_name)
                 {
                     if(AXIS2_STRCMP(op_name, "add") == 0)
@@ -658,7 +660,7 @@
     axis2_status_t status = AXIS2_FAILURE;
     if (inst)
     {
-        status = AXIS2_SVC_SKELETON_FREE(inst, env);
+        status = axis2_svc_skeleton_free(inst, env);
     }
     return status;
 }</pre>
@@ -876,8 +878,8 @@
 <p>This will determine whether the client would block (Sysnchronous) or
 return immediately (Asynchronous) for the response in a in-out MEP
 scenario.<br>
-<em>AXIS2_SVC_CLIENT_SEND_RECEIVE</em> or
-<em>AXIS2_SVC_CLIENT_SEND_RECEIVE_NON_BLOCKING</em> methods.<br>
+<em>axis2_svc_client_send_receive</em> or
+<em>axis2_svc_client_send_receive_non_blocking</em> methods.<br>
 </p>
 
 <p></p>
@@ -901,13 +903,13 @@
 
 <p>The following example code fragments shows how to enable a REST style
 invocation using different HTTP methods.</p>
-<pre>AXIS2_OPTIONS_SET_PROPERTY(options, env, AXIS2_ENABLE_REST, AXIS2_VALUE_TRUE);</pre>
+<pre>axis2_options_set_property(options, env, AXIS2_ENABLE_REST, AXIS2_VALUE_TRUE);</pre>
 
 <p>Default HTTP method used with REST is HTTP POST Method. If someone need
 tochange it to HTTP GET method following needs to be done.</p>
 
 <p>REST with HTTP GET</p>
-<pre>AXIS2_OPTIONS_SET_PROPERTY(options, env, AXIS2_HTTP_METHOD, AXIS2_HTTP_HEADER_GET);<br></pre>
+<pre>axis2_options_set_property(options, env, AXIS2_HTTP_METHOD, AXIS2_HTTP_HEADER_GET);<br></pre>
 
 <p>Apart from setting the above options one do not have to do anything
 special to get REST to work You can use the same code that you would use with
@@ -941,7 +943,7 @@
 <p>When sending attachments, you can configure the client either to send the
 attachment in the optimised format or in non optimised format. By setting an
 option</p>
-<pre>AXIS2_OPTIONS_SET_ENABLE_MTOM(options,env,AXIS2_TRUE);</pre>
+<pre>axis2_options_set_enable_mtom(options,env,AXIS2_TRUE);</pre>
 or setting<br>
 
 <pre>&lt;enableMtom&gt;true&lt;/enableMtom&gt;</pre>
@@ -1120,9 +1122,9 @@
 done by adding the following line in the client code after setting the
 options.</p>
 
-<p>AXIS2_SVC_CLIENT_SET_OPTIONS(svc_client, env, options);</p>
+<p>axis2_svc_client_set_options(svc_client, env, options);</p>
 
-<p><em>AXIS2_SVC_CLIENT_ENGAGE_MODULE(svc_client, env, "module
+<p><em>axis2_svc_client_engage_module(svc_client, env, "module
 name");</em></p>
 
 <p>Remember to replace "module-name" with the name of the module you want to
@@ -1147,34 +1149,34 @@
   <li>If we need to add addressing for a specific client , we should do it
     programmetically by adding the following function call in the client
     implementation file. 
-    <pre>AXIS2_SVC_CLIENT_ENGAGE_MODULE(svc_client, env, AXIS2_MODULE_ADDRESSING);</pre>
+    <pre>axis2_svc_client_engage_module(svc_client, env, AXIS2_MODULE_ADDRESSING);</pre>
   </li>
 </ul>
 
 <p>There is a mandatory requirement for using WS-Addressing on client side
 with Axis2/C. That is to set a WS-Addressing action that represents the
 operation to be invoked.</p>
-<pre>AXIS2_OPTIONS_SET_ACTION(options,env,"http://ws.apache.org/axis2/c/samples/echoString")</pre>
+<pre>axis2_options_set_action(options,env,"http://ws.apache.org/axis2/c/samples/echoString")</pre>
 
 <p>In addition to the action which is mandatory,there are other WS-Addressing
 related headers that could be sent in a message. Axis2/C has support to set
 those headers as options at client level. The following functions are used to
 set them.</p>
-<pre>AXIS2_OPTIONS_SET_REPLY_TO(options, env, reply_to)</pre>
+<pre>axis2_options_set_reply_to(options, env, reply_to)</pre>
 
 <p>Sets the wsa:Replyto header. The "ReplyTo" header contains the endpoint to
 send reply messages The Replyto header is required when the response comes in
 a seperate channel. (when using dual chanel)</p>
-<pre>AXIS2_OPTIONS_SET_FAULT_TO(options, env, fault_to)</pre>
+<pre>axis2_options_set_fault_to(options, env, fault_to)</pre>
 
 <p>Sets the wsa:FaultTo header.This contains the endpoint to direct fault
 messages.</p>
-<pre>AXIS2_OPTIONS_SET_FROM(options, env, from)</pre>
+<pre>axis2_options_set_from(options, env, from)</pre>
 
 <p>Sometimes receiving endpoint requires to know the original sender of the
 message.wsa:From header is used in those cases the above function sets the
 wsa:From header.</p>
-<pre>AXIS2_OPTIONS_SET_RELATES_TO(options, env, relates_to)</pre>
+<pre>axis2_options_set_relates_to(options, env, relates_to)</pre>
 
 <p>Sets the wsa:RelatesTo header.This header contains a unique ID that must
 be a message ID of a previously exchanged message.It helps to identify a
@@ -1326,18 +1328,18 @@
     AXIS2_LOG_INFO(env-&gt;log, "Starting logging in handler .........");
     printf("\n\nStarting logging in handler .........\n\n");
     
-    soap_envelope = AXIS2_MSG_CTX_GET_SOAP_ENVELOPE(msg_ctx, env);
+    soap_envelope = axis2_msg_ctx_get_soap_envelope(msg_ctx, env);
     
     if(soap_envelope)
     {
-        AXIOM_SOAP_ENVELOPE_GET_BODY(soap_envelope, env);
+        axiom_soap_envelope_get_body(soap_envelope, env);
 
-        ret_node = AXIOM_SOAP_ENVELOPE_GET_BASE_NODE(soap_envelope, env);
+        ret_node = axiom_soap_envelope_get_base_node(soap_envelope, env);
 
         if(ret_node)
         {
             axis2_char_t *om_str = NULL;
-            om_str = AXIOM_NODE_TO_STRING(ret_node, env);
+            om_str = axiom_node_to_string(ret_node, env);
             if (om_str)
             {
                 AXIS2_LOG_INFO(env-&gt;log, "Input msg: %s", om_str);
@@ -2526,7 +2528,7 @@
 axis2_options.h. These options are used by the service client before sending
 messages.</p>
 
-<p><strong>AXIS2_OPTIONS_SET_ACTION(options, env, action)</strong></p>
+<p><strong>axis2_options_set_action(options, env, action)</strong></p>
 
 <p>Set the ws-addressing action in the addressing header.</p>
 
@@ -2554,7 +2556,7 @@
 
 <p></p>
 
-<p><strong>AXIS2_OPTIONS_SET_FAULT_TO(options, env, fault_to)</strong></p>
+<p><strong>axis2_options_set_fault_to(options, env, fault_to)</strong></p>
 
 <p>Set the end point reference which may recieve the message in a case of
 fault.</p>
@@ -2584,7 +2586,7 @@
 
 <p></p>
 
-<p><strong>AXIS2_OPTIONS_SET_FROM(options, env, from)</strong></p>
+<p><strong>axis2_options_set_from(options, env, from)</strong></p>
 
 <p>Some services need to know the source from which the messgae comes. This
 option set the from enfdpoint</p>
@@ -2612,7 +2614,7 @@
   </tbody>
 </table>
 
-<p><strong>AXIS2_OPTIONS_SET_TO(options, env, to)</strong></p>
+<p><strong>axis2_options_set_to(options, env, to)</strong></p>
 
 <p>Sets the endpoint reference the message is destined to.</p>
 
@@ -2638,7 +2640,7 @@
   </tbody>
 </table>
 
-<p><strong>AXIS2_OPTIONS_SET_TRANSPORT_RECEIVER(options, env,
+<p><strong>axis2_options_set_transport_receiver(options, env,
 receiver)</strong></p>
 
 <p>Set the transport reciever in a IN-OUT message exchange scenario.</p>
@@ -2665,7 +2667,7 @@
   </tbody>
 </table>
 
-<p><strong>AXIS2_OPTIONS_SET_TRANSPORT_IN(options, env,
+<p><strong>axis2_options_set_transport_in(options, env,
 transport_in)</strong></p>
 
 <p>Set transport in description</p>
@@ -2694,7 +2696,7 @@
 
 <p></p>
 
-<p><strong>AXIS2_OPTIONS_SET_TRANSPORT_IN_PROTOCOL(options, env,
+<p><strong>axis2_options_set_transport_in_protocol(options, env,
 transport_in_protocol)</strong></p>
 
 <p>Set transport in protocol</p>
@@ -2715,7 +2717,7 @@
       <td>env pointer to environment struct</td>
     </tr>
     <tr>
-      <td>const axis2_char_t *transport_in_protocol</td>
+      <td>const AXIS2_TRANSPORT_ENUMS transport_in_protocol</td>
       <td>in_protocol pointer to in_protocol struct</td>
     </tr>
   </tbody>
@@ -2723,7 +2725,7 @@
 
 <p></p>
 
-<p><strong>AXIS2_OPTIONS_SET_MESSAGE_ID(options, env, message_id)</strong></p>
+<p><strong>axis2_options_set_message_id(options, env, message_id)</strong></p>
 
 <p>Set the soap message Id</p>
 
@@ -2751,7 +2753,7 @@
 
 <p></p>
 
-<p><strong>AXIS2_OPTIONS_SET_PROPERTIES(options, env, properties)</strong></p>
+<p><strong>axis2_options_set_properties(options, env, properties)</strong></p>
 
 <p>Set the properties hash map.</p>
 
@@ -2779,7 +2781,7 @@
 
 <p></p>
 
-<p><strong>AXIS2_OPTIONS_SET_PROPERTY(options, env, key,
+<p><strong>axis2_options_set_property(options, env, key,
 property)</strong></p>
 
 <p>Set a property with a given key value.</p>
@@ -2812,7 +2814,7 @@
 
 <p></p>
 
-<p><strong>AXIS2_OPTIONS_SET_RELATES_TO(options, env, relates_to)</strong></p>
+<p><strong>axis2_options_set_relates_to(options, env, relates_to)</strong></p>
 
 <p>Some times messages may have relations.eg:- echo. This will set for
 related messages</p>
@@ -2841,7 +2843,7 @@
 
 <p></p>
 
-<p><strong>AXIS2_OPTIONS_SET_REPLY_TO(options, env, reply_to)</strong></p>
+<p><strong>axis2_options_set_reply_to(options, env, reply_to)</strong></p>
 
 <p>Sets the reply to address. when the client wants a reply. It may be the
 sending end point or another different end point.</p>
@@ -2871,7 +2873,7 @@
 
 <p></p>
 
-<p><strong>AXIS2_OPTIONS_SET_TRANSPORT_OUT(options, env,
+<p><strong>axis2_options_set_transport_out(options, env,
 transport_out)</strong></p>
 
 <p>Set the transport out description.</p>
@@ -2900,7 +2902,7 @@
 
 <p></p>
 
-<p><strong>AXIS2_OPTIONS_SET_SENDER_TRANSPORT(options, env, sender_transport,
+<p><strong>axis2_options_set_sender_transport(options, env, sender_transport,
 conf)</strong></p>
 
 <p>Sets the sender transport</p>
@@ -2921,7 +2923,7 @@
       <td>env pointer to environment struct</td>
     </tr>
     <tr>
-      <td>const axis2_char_t *sender_transport</td>
+      <td>const AXIS2_TRANSPORT_ENUMS sender_transport</td>
       <td>sender_transport name of the sender transport to be set</td>
     </tr>
     <tr>
@@ -2934,7 +2936,7 @@
 
 <p></p>
 
-<p><strong>AXIS2_OPTIONS_SET_SOAP_VERSION_URI(options, env,
+<p><strong>axis2_options_set_soap_version_uri(options, env,
 soap_version_uri)</strong></p>
 
 <p>Sets the soap version URI. SOAP 1.1 URI OR SOAP 1.2 URI</p>
@@ -2963,7 +2965,7 @@
 
 <p></p>
 
-<p><strong>AXIS2_OPTIONS_SET_TIMEOUT_IN_MILLI_SECONDS(options, env,
+<p><strong>axis2_options_set_timeout_in_milli_seconds(options, env,
 timeout_in_milli_seconds)</strong></p>
 
 <p>Set the time out in mili seconds. This is used in asyncronous message
@@ -2993,7 +2995,7 @@
 
 <p></p>
 
-<p><strong>AXIS2_OPTIONS_SET_TRANSPORT_INFO(options, env, sender_transport,
+<p><strong>axis2_options_set_transport_info(options, env, sender_transport,
 receiver_transport, user_separate_listener)</strong></p>
 
 <p>Sets transport information. Transport information includes the name of the
@@ -3016,11 +3018,11 @@
       <td>env pointer to environment struct</td>
     </tr>
     <tr>
-      <td>const axis2_char_t *sender_transport</td>
+      <td>const AXIS2_TRANSPORT_ENUMS sender_transport</td>
       <td>sender_transport name of sender transport to be used</td>
     </tr>
     <tr>
-      <td>const axis2_char_t *receiver_transport</td>
+      <td>const AXIS2_TRANSPORT_ENUMS receiver_transport</td>
       <td>receiver_transport name of receiver transport to be used</td>
     </tr>
     <tr>
@@ -3033,7 +3035,7 @@
 
 <p></p>
 
-<p><strong>AXIS2_OPTIONS_SET_USE_SEPARATE_LISTENER(options, env,
+<p><strong>axis2_options_set_use_separate_listener(options, env,
 use_separate_listener)</strong></p>
 
 <p>Sets the bool value indicating whether to use a separate listener or not.
@@ -3064,7 +3066,7 @@
 
 <p></p>
 
-<p><strong>AXIS2_OPTIONS_SET_SOAP_VERSION(options, env,
+<p><strong>axis2_options_set_soap_version(options, env,
 soap_version)</strong></p>
 
 <p>Set the SOAP version. Either AXIOM_SOAP_11 or AXIOM_SOAP_12.</p>
@@ -3093,7 +3095,7 @@
 
 <p></p>
 
-<p><strong>AXIS2_OPTIONS_SET_ENABLE_MTOM(options, env,
+<p><strong>axis2_options_set_enable_mtom(options, env,
 enable_mtom)</strong></p>
 
 <p>Enable/disable MTOM handling when sending binary attachments.</p>
@@ -3127,599 +3129,4 @@
 messages.</p>
 
 <p></p>
-
-<p><strong>AXIS2_OPTIONS_SET_ACTION(options, env, action)</strong></p>
-
-<p>Set the ws-addressing action in the addressing header.</p>
-
-<table border="1">
-  <caption></caption>
-  <tbody>
-    <tr>
-      <th>Parameter</th>
-      <th>Description</th>
-    </tr>
-    <tr>
-      <td>axis2_options_t *options</td>
-      <td>options pointer to options struct</td>
-    </tr>
-    <tr>
-      <td>const axis2_env_t *env</td>
-      <td>env pointer to environment struct</td>
-    </tr>
-    <tr>
-      <td>const axis2_char_t *action</td>
-      <td>action pointer to action string</td>
-    </tr>
-  </tbody>
-</table>
-
-<p></p>
-
-<p><strong>AXIS2_OPTIONS_SET_FAULT_TO(options, env, fault_to)</strong></p>
-
-<p>Set the end point reference which may recieve the message in a case of
-fault.</p>
-
-<table border="1">
-  <caption></caption>
-  <tbody>
-    <tr>
-      <th>Parameter</th>
-      <th>Description</th>
-    </tr>
-    <tr>
-      <td>axis2_options_t *options</td>
-      <td>options pointer to options struct</td>
-    </tr>
-    <tr>
-      <td>const axis2_env_t *env</td>
-      <td>env pointer to environment struct</td>
-    </tr>
-    <tr>
-      <td>axis2_endpoint_ref_t *fault_to</td>
-      <td>fault_to pointer to endpoint reference struct representing fault to
-        address.</td>
-    </tr>
-  </tbody>
-</table>
-
-<p></p>
-
-<p><strong>AXIS2_OPTIONS_SET_FROM(options, env, from)</strong></p>
-
-<p>Some services need to know the source from which the messgae comes. This
-option set the from enfdpoint</p>
-
-<table border="1">
-  <caption></caption>
-  <tbody>
-    <tr>
-      <th>Parameter</th>
-      <th>Description</th>
-    </tr>
-    <tr>
-      <td>axis2_options_t *options</td>
-      <td>options pointer to options struct</td>
-    </tr>
-    <tr>
-      <td>const axis2_env_t *env</td>
-      <td>env pointer to environment struct</td>
-    </tr>
-    <tr>
-      <td>axis2_endpoint_ref_t *from</td>
-      <td>from pointer to endpoint reference struct representing from to
-        address</td>
-    </tr>
-  </tbody>
-</table>
-
-<p><strong>AXIS2_OPTIONS_SET_TO(options, env, to)</strong></p>
-
-<p>Sets the endpoint reference the message is destined to.</p>
-
-<table border="1">
-  <caption></caption>
-  <tbody>
-    <tr>
-      <th>Parameter</th>
-      <th>Description</th>
-    </tr>
-    <tr>
-      <td>axis2_options_t *options</td>
-      <td>options pointer to options struct</td>
-    </tr>
-    <tr>
-      <td>const axis2_env_t *env</td>
-      <td>env pointer to environment struct</td>
-    </tr>
-    <tr>
-      <td>axis2_endpoint_ref_t *to</td>
-      <td>to pointer to endpoint reference struct representing to address</td>
-    </tr>
-  </tbody>
-</table>
-
-<p><strong>AXIS2_OPTIONS_SET_TRANSPORT_RECEIVER(options, env,
-receiver)</strong></p>
-
-<p>Set the transport reciever in a IN-OUT message exchange scenario.</p>
-
-<table border="1">
-  <caption></caption>
-  <tbody>
-    <tr>
-      <th>Parameter</th>
-      <th>Description</th>
-    </tr>
-    <tr>
-      <td>axis2_options_t *options</td>
-      <td>options pointer to options struct</td>
-    </tr>
-    <tr>
-      <td>const axis2_env_t *env</td>
-      <td>env pointer to environment struct</td>
-    </tr>
-    <tr>
-      <td>axis2_transport_receiver_t *receiver</td>
-      <td>receiver pointer to transport receiver struct</td>
-    </tr>
-  </tbody>
-</table>
-
-<p><strong>AXIS2_OPTIONS_SET_TRANSPORT_IN(options, env,
-transport_in)</strong></p>
-
-<p>Set transport in description</p>
-
-<table border="1">
-  <caption></caption>
-  <tbody>
-    <tr>
-      <th>Parameter</th>
-      <th>Description</th>
-    </tr>
-    <tr>
-      <td>axis2_options_t *options</td>
-      <td>options pointer to options struct</td>
-    </tr>
-    <tr>
-      <td>const axis2_env_t *env</td>
-      <td>env pointer to environment struct</td>
-    </tr>
-    <tr>
-      <td>axis2_transport_in_desc_t *transport_in</td>
-      <td>transport_in pointer to transport_in struct</td>
-    </tr>
-  </tbody>
-</table>
-
-<p></p>
-
-<p><strong>AXIS2_OPTIONS_SET_TRANSPORT_IN_PROTOCOL(options, env,
-transport_in_protocol)</strong></p>
-
-<p>Set transport in protocol</p>
-
-<table border="1">
-  <caption></caption>
-  <tbody>
-    <tr>
-      <th>Parameter</th>
-      <th>Description</th>
-    </tr>
-    <tr>
-      <td>axis2_options_t *options</td>
-      <td>options pointer to options struct</td>
-    </tr>
-    <tr>
-      <td>const axis2_env_t *env</td>
-      <td>env pointer to environment struct</td>
-    </tr>
-    <tr>
-      <td>const axis2_char_t *transport_in_protocol</td>
-      <td>in_protocol pointer to in_protocol struct</td>
-    </tr>
-  </tbody>
-</table>
-
-<p></p>
-
-<p><strong>AXIS2_OPTIONS_SET_MESSAGE_ID(options, env, message_id)</strong></p>
-
-<p>Set the soap message Id</p>
-
-<table border="1">
-  <caption></caption>
-  <tbody>
-    <tr>
-      <th>Parameter</th>
-      <th>Description</th>
-    </tr>
-    <tr>
-      <td>axis2_options_t *options</td>
-      <td>options pointer to options struct</td>
-    </tr>
-    <tr>
-      <td>const axis2_env_t *env</td>
-      <td>env pointer to environment struct</td>
-    </tr>
-    <tr>
-      <td>const axis2_char_t *message_id</td>
-      <td>message_id pointer to message_id struct</td>
-    </tr>
-  </tbody>
-</table>
-
-<p></p>
-
-<p><strong>AXIS2_OPTIONS_SET_PROPERTIES(options, env, properties)</strong></p>
-
-<p>Set the properties hash map.</p>
-
-<table border="1">
-  <caption></caption>
-  <tbody>
-    <tr>
-      <th>Parameter</th>
-      <th>Description</th>
-    </tr>
-    <tr>
-      <td>axis2_options_t *options</td>
-      <td>options pointer to options struct</td>
-    </tr>
-    <tr>
-      <td>const axis2_env_t *env</td>
-      <td>env pointer to environment struct</td>
-    </tr>
-    <tr>
-      <td>axis2_hash_t *properties</td>
-      <td>properties pointer to properties hash map</td>
-    </tr>
-  </tbody>
-</table>
-
-<p></p>
-
-<p><strong>AXIS2_OPTIONS_SET_PROPERTY(options, env, key,
-property)</strong></p>
-
-<p>Set a property with a given key value.</p>
-
-<table border="1">
-  <caption></caption>
-  <tbody>
-    <tr>
-      <th>Parameter</th>
-      <th>Description</th>
-    </tr>
-    <tr>
-      <td>axis2_options_t *options</td>
-      <td>options pointer to options struct</td>
-    </tr>
-    <tr>
-      <td>const axis2_env_t *env</td>
-      <td>env pointer to environment struct</td>
-    </tr>
-    <tr>
-      <td>const axis2_char_t *property_key</td>
-      <td>property_key property key string</td>
-    </tr>
-    <tr>
-      <td>const void *property</td>
-      <td>property pointer to property to be set</td>
-    </tr>
-  </tbody>
-</table>
-
-<p></p>
-
-<p><strong>AXIS2_OPTIONS_SET_RELATES_TO(options, env, relates_to)</strong></p>
-
-<p>Some times messages may have relations.eg:- echo. This will set for
-related messages</p>
-
-<table border="1">
-  <caption></caption>
-  <tbody>
-    <tr>
-      <th>Parameter</th>
-      <th>Description</th>
-    </tr>
-    <tr>
-      <td>axis2_options_t *options</td>
-      <td>options pointer to options struct</td>
-    </tr>
-    <tr>
-      <td>const axis2_env_t *env</td>
-      <td>env pointer to environment struct</td>
-    </tr>
-    <tr>
-      <td>axis2_relates_to_t *relates_to</td>
-      <td>relates_to pointer to relates_to struct</td>
-    </tr>
-  </tbody>
-</table>
-
-<p></p>
-
-<p><strong>AXIS2_OPTIONS_SET_REPLY_TO(options, env, reply_to)</strong></p>
-
-<p>Sets the reply to address. when the client wants a reply. It may be the
-sending end point or another different end point.</p>
-
-<table border="1">
-  <caption></caption>
-  <tbody>
-    <tr>
-      <th>Parameter</th>
-      <th>Description</th>
-    </tr>
-    <tr>
-      <td>axis2_options_t *options</td>
-      <td>options pointer to options struct</td>
-    </tr>
-    <tr>
-      <td>const axis2_env_t *env</td>
-      <td>env pointer to environment struct</td>
-    </tr>
-    <tr>
-      <td>axis2_endpoint_ref_t *reply_to</td>
-      <td>reply_to pointer to endpoint reference struct representing reply to
-        address</td>
-    </tr>
-  </tbody>
-</table>
-
-<p></p>
-
-<p><strong>AXIS2_OPTIONS_SET_TRANSPORT_OUT(options, env,
-transport_out)</strong></p>
-
-<p>Set the transport out description.</p>
-
-<table border="1">
-  <caption></caption>
-  <tbody>
-    <tr>
-      <th>Parameter</th>
-      <th>Description</th>
-    </tr>
-    <tr>
-      <td>axis2_options_t *options</td>
-      <td>options pointer to options struct</td>
-    </tr>
-    <tr>
-      <td>const axis2_env_t *env</td>
-      <td>env pointer to environment struct</td>
-    </tr>
-    <tr>
-      <td>axis2_transport_out_desc_t *transport_out</td>
-      <td>transport_out pointer to transport out description struct</td>
-    </tr>
-  </tbody>
-</table>
-
-<p></p>
-
-<p><strong>AXIS2_OPTIONS_SET_SENDER_TRANSPORT(options, env, sender_transport,
-conf)</strong></p>
-
-<p>Sets the sender transport</p>
-
-<table border="1">
-  <caption></caption>
-  <tbody>
-    <tr>
-      <th>Parameter</th>
-      <th>Description</th>
-    </tr>
-    <tr>
-      <td>axis2_options_t *options</td>
-      <td>options pointer to options struct</td>
-    </tr>
-    <tr>
-      <td>const axis2_env_t *env</td>
-      <td>env pointer to environment struct</td>
-    </tr>
-    <tr>
-      <td>const axis2_char_t *sender_transport</td>
-      <td>sender_transport name of the sender transport to be set</td>
-    </tr>
-    <tr>
-      <td>axis2_conf_t *conf</td>
-      <td>conf pointer to conf struct, it is from the conf that the transport
-        is picked with the given name</td>
-    </tr>
-  </tbody>
-</table>
-
-<p></p>
-
-<p><strong>AXIS2_OPTIONS_SET_SOAP_VERSION_URI(options, env,
-soap_version_uri)</strong></p>
-
-<p>Sets the soap version URI. SOAP 1.1 URI OR SOAP 1.2 URI</p>
-
-<table border="1">
-  <caption></caption>
-  <tbody>
-    <tr>
-      <th>Parameter</th>
-      <th>Description</th>
-    </tr>
-    <tr>
-      <td>axis2_options_t *options</td>
-      <td>options pointer to options struct</td>
-    </tr>
-    <tr>
-      <td>const axis2_env_t *env</td>
-      <td>env pointer to environment struct</td>
-    </tr>
-    <tr>
-      <td>const axis2_char_t *soap_version_uri</td>
-      <td>soap_version_uri URI of the SOAP version to be set</td>
-    </tr>
-  </tbody>
-</table>
-
-<p></p>
-
-<p><strong>AXIS2_OPTIONS_SET_TIMEOUT_IN_MILLI_SECONDS(options, env,
-timeout_in_milli_seconds)</strong></p>
-
-<p>Set the time out in mili seconds. This is used in asyncronous message
-exchnge scebarios for the call back object to wait for the response.</p>
-
-<table border="1">
-  <caption></caption>
-  <tbody>
-    <tr>
-      <th>Parameter</th>
-      <th>Description</th>
-    </tr>
-    <tr>
-      <td>axis2_options_t *options</td>
-      <td>options pointer to options struct</td>
-    </tr>
-    <tr>
-      <td>const axis2_env_t *env</td>
-      <td>env pointer to environment struct</td>
-    </tr>
-    <tr>
-      <td>const long timeout_in_milli_seconds</td>
-      <td>timeout_in_milli_seconds timeout in milli seconds</td>
-    </tr>
-  </tbody>
-</table>
-
-<p></p>
-
-<p><strong>AXIS2_OPTIONS_SET_TRANSPORT_INFO(options, env, sender_transport,
-receiver_transport, user_separate_listener)</strong></p>
-
-<p>Sets transport information. Transport information includes the name of the
-sender transport, name of the receiver transport and if a separate listener
-to be used to receive response.</p>
-
-<table border="1">
-  <caption></caption>
-  <tbody>
-    <tr>
-      <th>Parameter</th>
-      <th>Description</th>
-    </tr>
-    <tr>
-      <td>axis2_options_t *options</td>
-      <td>options pointer to options struct</td>
-    </tr>
-    <tr>
-      <td>const axis2_env_t *env</td>
-      <td>env pointer to environment struct</td>
-    </tr>
-    <tr>
-      <td>const axis2_char_t *sender_transport</td>
-      <td>sender_transport name of sender transport to be used</td>
-    </tr>
-    <tr>
-      <td>const axis2_char_t *receiver_transport</td>
-      <td>receiver_transport name of receiver transport to be used</td>
-    </tr>
-    <tr>
-      <td>const axis2_bool_t use_separate_listener</td>
-      <td>use_separate_listener bool value indicating whether to use a
-        seperate listner or not</td>
-    </tr>
-  </tbody>
-</table>
-
-<p></p>
-
-<p><strong>AXIS2_OPTIONS_SET_USE_SEPARATE_LISTENER(options, env,
-use_separate_listener)</strong></p>
-
-<p>Sets the bool value indicating whether to use a separate listener or not.
-Seperate listener is used when the transport is one way transport.</p>
-
-<table border="1">
-  <caption></caption>
-  <tbody>
-    <tr>
-      <th>Parameter</th>
-      <th>Description</th>
-    </tr>
-    <tr>
-      <td>axis2_options_t *options</td>
-      <td>options pointer to options struct</td>
-    </tr>
-    <tr>
-      <td>const axis2_env_t *env</td>
-      <td>env pointer to environment struct</td>
-    </tr>
-    <tr>
-      <td>const axis2_bool_t use_separate_listener</td>
-      <td>use_separate_listener bool value indicating whether to use a
-        seperate listener or not</td>
-    </tr>
-  </tbody>
-</table>
-
-<p></p>
-
-<p><strong>AXIS2_OPTIONS_SET_SOAP_VERSION(options, env,
-soap_version)</strong></p>
-
-<p>Set the SOAP version. Either AXIOM_SOAP_11 or AXIOM_SOAP_12.</p>
-
-<table border="1">
-  <caption></caption>
-  <tbody>
-    <tr>
-      <th>Parameter</th>
-      <th>description</th>
-    </tr>
-    <tr>
-      <td>axis2_options_t *options</td>
-      <td>options pointer to options struct</td>
-    </tr>
-    <tr>
-      <td>const axis2_env_t *env</td>
-      <td>env pointer to environment struct</td>
-    </tr>
-    <tr>
-      <td>const int soap_version</td>
-      <td>soap_version soap version</td>
-    </tr>
-  </tbody>
-</table>
-
-<p></p>
-
-<p><strong>AXIS2_OPTIONS_SET_ENABLE_MTOM(options, env,
-enable_mtom)</strong></p>
-
-<p>Enable/disable MTOM handling when sending binary attachments.</p>
-
-<table border="1">
-  <caption></caption>
-  <tbody>
-    <tr>
-      <th>Parameter</th>
-      <th>Description</th>
-    </tr>
-    <tr>
-      <td>axis2_options_t *options</td>
-      <td>options pointer to options struct</td>
-    </tr>
-    <tr>
-      <td>const axis2_env_t *env</td>
-      <td>env pointer to environment struct</td>
-    </tr>
-    <tr>
-      <td>axis2_bool_t enable_mtom</td>
-      <td>enable_mtom Aȱ </td>
-    </tr>
-  </tbody>
-</table>
-</body>
 </html>



---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org


Mime
View raw message