PageRenderTime 85ms CodeModel.GetById 30ms RepoModel.GetById 5ms app.codeStats 0ms

/wso2-wsf-cpp-src-2.1.0/docs/api/html/classwso2wsf_1_1Stub.html

#
HTML | 257 lines | 234 code | 22 blank | 1 comment | 0 complexity | ae684ef0c243bf84f0948c6b92b97a3a MD5 | raw file
Possible License(s): Apache-2.0, GPL-3.0, MPL-2.0-no-copyleft-exception, BSD-3-Clause, CPL-1.0 
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    2. 

  2. <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
    3. 

  3. <title>WSF/CPP: wso2wsf::Stub Class Reference</title>
    4. 

  4. <link href="doxygen.css" rel="stylesheet" type="text/css">
    5. 

  5. <link href="tabs.css" rel="stylesheet" type="text/css">
    6. 

  6. </head><body>
    7. 

  7. <!-- Generated by Doxygen 1.5.7.1 -->
    8. 

  8. <div class="navigation" id="top">
    9. 

  9.   <div class="tabs">
    10. 

  10.     <ul>
    11. 

  11.       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    12. 

  12.       <li><a href="modules.html"><span>Modules</span></a></li>
    13. 

  13.       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    14. 

  14.       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
    15. 

  15.       <li><a href="files.html"><span>Files</span></a></li>
    16. 

  16.       <li><a href="dirs.html"><span>Directories</span></a></li>
    17. 

  17.     <li>
    18. 

  18.       <form action="search.php" method="get">
    19. 

  19.         <table cellspacing="0" cellpadding="0" border="0">
    20. 

  20.           <tr>
    21. 

  21.             <td><label>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</label></td>
    22. 

  22.             <td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
    23. 

  23.           </tr>
    24. 

  24.         </table>
    25. 

  25.       </form>
    26. 

  26.     </li>
    27. 

  27.     </ul>
    28. 

  28.   </div>
    29. 

  29.   <div class="tabs">
    30. 

  30.     <ul>
    31. 

  31.       <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    32. 

  32.       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    33. 

  33.       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    34. 

  34.     </ul>
    35. 

  35.   </div>
    36. 

  36.   <div class="navpath"><a class="el" href="namespacewso2wsf.html">wso2wsf</a>::<a class="el" href="classwso2wsf_1_1Stub.html">Stub</a>
    37. 

  37.   </div>
    38. 

  38. </div>
    39. 

  39. <div class="contents">
    40. 

  40. <h1>wso2wsf::Stub Class Reference<br>
    41. 

  41. <small>
    42. 

  42. [<a class="el" href="group__Stub.html">Stub</a>]</small>
    43. 

  43. </h1><!-- doxytag: class="wso2wsf::Stub" -->class <a class="el" href="classwso2wsf_1_1Stub.html" title="class Stub This object serves as the primary client API for consuming SOAP services...">Stub</a> This object serves as the primary client API for consuming SOAP services. This is the base class for the codegenerated client side stub classes.  
    44. 

  44. <a href="#_details">More...</a>
    45. 

  45. <p>
    46. 

  46. <code>#include &lt;<a class="el" href="Stub_8h-source.html">Stub.h</a>&gt;</code>
    47. 

  47. <p>
    48. 

  48. 

  49. <p>
    50. 

  50. <a href="classwso2wsf_1_1Stub-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
    51. 

  51. <tr><td></td></tr>
    52. 

  52. <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
    53. 

  53. <tr><td class="memItemLeft" nowrap align="right" valign="top">WSF_EXTERN void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwso2wsf_1_1Stub.html#994af1d97403672ea9a7c56d8ddd21cb">init</a> (std::string &amp;client_home, std::string &amp;endpointUri)</td></tr>
    54. 

  54. 

  55. <tr><td class="memItemLeft" nowrap align="right" valign="top">WSF_EXTERN <a class="el" href="classwso2wsf_1_1Options.html">Options</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwso2wsf_1_1Stub.html#4a5d3509197b4ad1383513dd23d006dd">getOptions</a> ()</td></tr>
    56. 

  56. 

  57. <tr><td class="memItemLeft" nowrap align="right" valign="top">WSF_EXTERN <a class="el" href="classwso2wsf_1_1ServiceClient.html">ServiceClient</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwso2wsf_1_1Stub.html#b187d8ff3c00542b77a110ca7ea6c540">getServiceClient</a> ()</td></tr>
    58. 

  58. 

  59. <tr><td class="memItemLeft" nowrap align="right" valign="top">WSF_EXTERN bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwso2wsf_1_1Stub.html#1f43c3b14e3a59eff62df7ff90f1c9ff">setServiceClient</a> (<a class="el" href="classwso2wsf_1_1ServiceClient.html">ServiceClient</a> *client)</td></tr>
    60. 

  60. 

  61. <tr><td class="memItemLeft" nowrap align="right" valign="top">WSF_EXTERN bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwso2wsf_1_1Stub.html#e4f517c3210f301638583d1b41a943dd">engageModule</a> (std::string moduleName)</td></tr>
    62. 

  62. 

  63. <tr><td class="memItemLeft" nowrap align="right" valign="top">WSF_EXTERN void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwso2wsf_1_1Stub.html#b3ad78253969a3f21cba574e83b9b28c">addAnonymousOperations</a> ()</td></tr>
    64. 

  64. 

  65. <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
    66. 

  66. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classwso2wsf_1_1ServiceClient.html">ServiceClient</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwso2wsf_1_1Stub.html#c0fee4a021f82b45c4499e6bf6e3575c">serviceClient</a></td></tr>
    67. 

  67. 

  68. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classwso2wsf_1_1Options.html">Options</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwso2wsf_1_1Stub.html#5997e28f8a2ddfaf3bf073a64bb24a78">clientOptions</a></td></tr>
    69. 

  69. 

  70. </table>
    71. 

  71. <hr><a name="_details"></a><h2>Detailed Description</h2>
    72. 

  72. class <a class="el" href="classwso2wsf_1_1Stub.html" title="class Stub This object serves as the primary client API for consuming SOAP services...">Stub</a> This object serves as the primary client API for consuming SOAP services. This is the base class for the codegenerated client side stub classes. <hr><h2>Member Function Documentation</h2>
    73. 

  73. <a class="anchor" name="b3ad78253969a3f21cba574e83b9b28c"></a><!-- doxytag: member="wso2wsf::Stub::addAnonymousOperations" ref="b3ad78253969a3f21cba574e83b9b28c" args="()" -->
    74. 

  74. <div class="memitem">
    75. 

  75. <div class="memproto">
    76. 

  76.       <table class="memname">
    77. 

  77.         <tr>
    78. 

  78.           <td class="memname">WSF_EXTERN void wso2wsf::Stub::addAnonymousOperations           </td>
    79. 

  79.           <td>(</td>
    80. 

  80.           <td class="paramname">          </td>
    81. 

  81.           <td>&nbsp;)&nbsp;</td>
    82. 

  82.           <td></td>
    83. 

  83.         </tr>
    84. 

  84.       </table>
    85. 

  85. </div>
    86. 

  86. <div class="memdoc">
    87. 

  87. 

  88. <p>
    89. 

  89. addAnnonymousOperations 
    90. 

  90. </div>
    91. 

  91. </div><p>
    92. 

  92. <a class="anchor" name="e4f517c3210f301638583d1b41a943dd"></a><!-- doxytag: member="wso2wsf::Stub::engageModule" ref="e4f517c3210f301638583d1b41a943dd" args="(std::string moduleName)" -->
    93. 

  93. <div class="memitem">
    94. 

  94. <div class="memproto">
    95. 

  95.       <table class="memname">
    96. 

  96.         <tr>
    97. 

  97.           <td class="memname">WSF_EXTERN bool wso2wsf::Stub::engageModule           </td>
    98. 

  98.           <td>(</td>
    99. 

  99.           <td class="paramtype">std::string&nbsp;</td>
    100. 

  100.           <td class="paramname"> <em>moduleName</em>          </td>
    101. 

  101.           <td>&nbsp;)&nbsp;</td>
    102. 

  102.           <td></td>
    103. 

  103.         </tr>
    104. 

  104.       </table>
    105. 

  105. </div>
    106. 

  106. <div class="memdoc">
    107. 

  107. 

  108. <p>
    109. 

  109. engageModule Engage an Axis2/C module to this <a class="el" href="classwso2wsf_1_1Stub.html" title="class Stub This object serves as the primary client API for consuming SOAP services...">Stub</a> <dl compact><dt><b>Parameters:</b></dt><dd>
    110. 

  110.   <table border="0" cellspacing="2" cellpadding="0">
    111. 

  111.     <tr><td valign="top"></td><td valign="top"><em>moduleName</em>&nbsp;</td><td>identifying name for the module </td></tr>
    112. 

  112.   </table>
    113. 

  113. </dl>
    114. 

  114. <dl class="return" compact><dt><b>Returns:</b></dt><dd>true on success, false otherwise </dd></dl>
    115. 

  115. 

  116. </div>
    117. 

  117. </div><p>
    118. 

  118. <a class="anchor" name="4a5d3509197b4ad1383513dd23d006dd"></a><!-- doxytag: member="wso2wsf::Stub::getOptions" ref="4a5d3509197b4ad1383513dd23d006dd" args="()" -->
    119. 

  119. <div class="memitem">
    120. 

  120. <div class="memproto">
    121. 

  121.       <table class="memname">
    122. 

  122.         <tr>
    123. 

  123.           <td class="memname">WSF_EXTERN <a class="el" href="classwso2wsf_1_1Options.html">Options</a>* wso2wsf::Stub::getOptions           </td>
    124. 

  124.           <td>(</td>
    125. 

  125.           <td class="paramname">          </td>
    126. 

  126.           <td>&nbsp;)&nbsp;</td>
    127. 

  127.           <td></td>
    128. 

  128.         </tr>
    129. 

  129.       </table>
    130. 

  130. </div>
    131. 

  131. <div class="memdoc">
    132. 

  132. 

  133. <p>
    134. 

  134. getOptions method is used to obtain a pointer to the <a class="el" href="classwso2wsf_1_1Stub.html" title="class Stub This object serves as the primary client API for consuming SOAP services...">Stub</a> Object's underlying options instance. <dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the <a class="el" href="classwso2wsf_1_1Options.html" title="class Options Holder for operation client options. This is used by the other classes...">Options</a> Object instance </dd></dl>
    135. 

    136. 

  136. </div>
    137. 

  137. </div><p>
    138. 

  138. <a class="anchor" name="b187d8ff3c00542b77a110ca7ea6c540"></a><!-- doxytag: member="wso2wsf::Stub::getServiceClient" ref="b187d8ff3c00542b77a110ca7ea6c540" args="()" -->
    139. 

  139. <div class="memitem">
    140. 

  140. <div class="memproto">
    141. 

  141.       <table class="memname">
    142. 

  142.         <tr>
    143. 

  143.           <td class="memname">WSF_EXTERN <a class="el" href="classwso2wsf_1_1ServiceClient.html">ServiceClient</a>* wso2wsf::Stub::getServiceClient           </td>
    144. 

  144.           <td>(</td>
    145. 

  145.           <td class="paramname">          </td>
    146. 

  146.           <td>&nbsp;)&nbsp;</td>
    147. 

  147.           <td></td>
    148. 

  148.         </tr>
    149. 

  149.       </table>
    150. 

  150. </div>
    151. 

  151. <div class="memdoc">
    152. 

  152. 

  153. <p>
    154. 

  154. getServiceClient method is used to obtain a pointer to the <a class="el" href="classwso2wsf_1_1Stub.html" title="class Stub This object serves as the primary client API for consuming SOAP services...">Stub</a> Object's Underlying <a class="el" href="classwso2wsf_1_1ServiceClient.html" title="Class ServiceClient The service client Class serves as the primary client interface...">ServiceClient</a> Object instance. <dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the <a class="el" href="classwso2wsf_1_1ServiceClient.html" title="Class ServiceClient The service client Class serves as the primary client interface...">ServiceClient</a> Object instance </dd></dl>
    155. 

    156. 

  156. </div>
    157. 

  157. </div><p>
    158. 

  158. <a class="anchor" name="994af1d97403672ea9a7c56d8ddd21cb"></a><!-- doxytag: member="wso2wsf::Stub::init" ref="994af1d97403672ea9a7c56d8ddd21cb" args="(std::string &amp;client_home, std::string &amp;endpointUri)" -->
    159. 

  159. <div class="memitem">
    160. 

  160. <div class="memproto">
    161. 

  161.       <table class="memname">
    162. 

  162.         <tr>
    163. 

  163.           <td class="memname">WSF_EXTERN void wso2wsf::Stub::init           </td>
    164. 

  164.           <td>(</td>
    165. 

  165.           <td class="paramtype">std::string &amp;&nbsp;</td>
    166. 

  166.           <td class="paramname"> <em>client_home</em>, </td>
    167. 

  167.         </tr>
    168. 

  168.         <tr>
    169. 

  169.           <td class="paramkey"></td>
    170. 

  170.           <td></td>
    171. 

  171.           <td class="paramtype">std::string &amp;&nbsp;</td>
    172. 

  172.           <td class="paramname"> <em>endpointUri</em></td><td>&nbsp;</td>
    173. 

  173.         </tr>
    174. 

  174.         <tr>
    175. 

  175.           <td></td>
    176. 

  176.           <td>)</td>
    177. 

  177.           <td></td><td></td><td></td>
    178. 

  178.         </tr>
    179. 

  179.       </table>
    180. 

  180. </div>
    181. 

  181. <div class="memdoc">
    182. 

  182. 

  183. <p>
    184. 

  184. Initialize the <a class="el" href="classwso2wsf_1_1Stub.html" title="class Stub This object serves as the primary client API for consuming SOAP services...">Stub</a>. <dl compact><dt><b>Parameters:</b></dt><dd>
    185. 

  185.   <table border="0" cellspacing="2" cellpadding="0">
    186. 

  186.     <tr><td valign="top"></td><td valign="top"><em>client_home</em>&nbsp;</td><td>string referring to the client repository location. </td></tr>
    187. 

  187.     <tr><td valign="top"></td><td valign="top"><em>endpointUri</em>&nbsp;</td><td>The endpoint URI of the service which will be invoked using this stub. </td></tr>
    188. 

  188.   </table>
    189. 

  189. </dl>
    190. 

  190. 

  191. </div>
    192. 

  192. </div><p>
    193. 

  193. <a class="anchor" name="1f43c3b14e3a59eff62df7ff90f1c9ff"></a><!-- doxytag: member="wso2wsf::Stub::setServiceClient" ref="1f43c3b14e3a59eff62df7ff90f1c9ff" args="(ServiceClient *client)" -->
    194. 

  194. <div class="memitem">
    195. 

  195. <div class="memproto">
    196. 

  196.       <table class="memname">
    197. 

  197.         <tr>
    198. 

  198.           <td class="memname">WSF_EXTERN bool wso2wsf::Stub::setServiceClient           </td>
    199. 

  199.           <td>(</td>
    200. 

  200.           <td class="paramtype"><a class="el" href="classwso2wsf_1_1ServiceClient.html">ServiceClient</a> *&nbsp;</td>
    201. 

  201.           <td class="paramname"> <em>client</em>          </td>
    202. 

  202.           <td>&nbsp;)&nbsp;</td>
    203. 

  203.           <td></td>
    204. 

  204.         </tr>
    205. 

  205.       </table>
    206. 

  206. </div>
    207. 

  207. <div class="memdoc">
    208. 

  208. 

  209. <p>
    210. 

  210. <a class="el" href="classwso2wsf_1_1Stub.html#1f43c3b14e3a59eff62df7ff90f1c9ff">setServiceClient()</a> Used to set <a class="el" href="classwso2wsf_1_1ServiceClient.html" title="Class ServiceClient The service client Class serves as the primary client interface...">ServiceClient</a> instance to the stub and configure stub. <dl compact><dt><b>Parameters:</b></dt><dd>
    211. 

  211.   <table border="0" cellspacing="2" cellpadding="0">
    212. 

  212.     <tr><td valign="top"></td><td valign="top"><em>client</em>&nbsp;</td><td>Pointer to a <a class="el" href="classwso2wsf_1_1ServiceClient.html" title="Class ServiceClient The service client Class serves as the primary client interface...">ServiceClient</a> instance </td></tr>
    213. 

  213.   </table>
    214. 

  214. </dl>
    215. 

  215. <dl class="return" compact><dt><b>Returns:</b></dt><dd>true on success, false otherwise. </dd></dl>
    216. 

  216. 

  217. </div>
    218. 

  218. </div><p>
    219. 

  219. <hr><h2>Member Data Documentation</h2>
    220. 

  220. <a class="anchor" name="5997e28f8a2ddfaf3bf073a64bb24a78"></a><!-- doxytag: member="wso2wsf::Stub::clientOptions" ref="5997e28f8a2ddfaf3bf073a64bb24a78" args="" -->
    221. 

  221. <div class="memitem">
    222. 

  222. <div class="memproto">
    223. 

  223.       <table class="memname">
    224. 

  224.         <tr>
    225. 

  225.           <td class="memname"><a class="el" href="classwso2wsf_1_1Options.html">Options</a>* <a class="el" href="classwso2wsf_1_1Stub.html#5997e28f8a2ddfaf3bf073a64bb24a78">wso2wsf::Stub::clientOptions</a><code> [protected]</code>          </td>
    226. 

  226.         </tr>
    227. 

  227.       </table>
    228. 

  228. </div>
    229. 

  229. <div class="memdoc">
    230. 

  230. 

  231. <p>
    232. 

  232. <a class="el" href="classwso2wsf_1_1Options.html" title="class Options Holder for operation client options. This is used by the other classes...">Options</a> object instance associated with the stub 
    233. 

  233. </div>
    234. 

  234. </div><p>
    235. 

  235. <a class="anchor" name="c0fee4a021f82b45c4499e6bf6e3575c"></a><!-- doxytag: member="wso2wsf::Stub::serviceClient" ref="c0fee4a021f82b45c4499e6bf6e3575c" args="" -->
    236. 

  236. <div class="memitem">
    237. 

  237. <div class="memproto">
    238. 

  238.       <table class="memname">
    239. 

  239.         <tr>
    240. 

  240.           <td class="memname"><a class="el" href="classwso2wsf_1_1ServiceClient.html">ServiceClient</a>* <a class="el" href="classwso2wsf_1_1Stub.html#c0fee4a021f82b45c4499e6bf6e3575c">wso2wsf::Stub::serviceClient</a><code> [protected]</code>          </td>
    241. 

  241.         </tr>
    242. 

  242.       </table>
    243. 

  243. </div>
    244. 

  244. <div class="memdoc">
    245. 

  245. 

  246. <p>
    247. 

  247. <a class="el" href="classwso2wsf_1_1ServiceClient.html" title="Class ServiceClient The service client Class serves as the primary client interface...">ServiceClient</a> object instance associated with the stub 
    248. 

  248. </div>
    249. 

  249. </div><p>
    250. 

  250. <hr>The documentation for this class was generated from the following file:<ul>
    251. 

  251. <li><a class="el" href="Stub_8h-source.html">Stub.h</a></ul>
    252. 

  252. </div>
    253. 

  253. <hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 14 00:43:26 2009 for WSF/CPP by&nbsp;
    254. 

  254. <a href="http://www.doxygen.org/index.html">
    255. 

  255. <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address>
    256. 

  256. </body>
    257. 

  257. </html>
    258. 

  258.