Google Git
Sign in
apache / axis-site / fa0d4e6b47a177bc9bae492f8ae4bef6b6563e1f / . / axis2 / c / sandesha / api / html / group__sandesha2__client.html
blob: bb6f0988c0c7d6d429a4004977170f491052df3b [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html><head><title>Apache Sandesha2/C - Sandesha2/C: Client</title><style type="text/css" media="all">
@import url("../../style/maven-base.css");
@import url("../../style/maven-classic.css");</style><link rel="stylesheet" href="../../style/print.css" type="text/css" media="print"></link><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"></meta></head><body class="composite"><div id="banner"><a href="http://www.apache.org/" id="organizationLogo"><img alt="Apache Software Foundation" src="http://www.apache.org/images/asf-logo.gif"></img></a><a href="http://ws.apache.org/sandesha2/c" id="projectLogo"><img alt="Apache Sandesha2/C" src="http://ws.apache.org/sandesha2/c/images/sandesha2c_logo.jpg"></img></a><div class="clear"><hr></hr></div></div><div id="breadcrumbs"><div class="xleft">
Last published: 05 October 2007
| Doc for 0.91</div><div class="xright"></div><div class="clear"><hr></hr></div></div><div id="leftColumn"><div id="navcolumn"><div id="menuApache_Sandesha2_C"><h5>Apache Sandesha2/C</h5><ul><li class="none"><a href="../../index.html">Apache Sandesha2/C Home</a></li><li class="expanded"><a href="../../download.cgi">Download Sandesha2/C</a><ul><li class="none"><a href="../../download.cgi">Releases</a></li></ul></li><li class="expanded"><a href="../../docs/index.html">Documentation</a><ul><li class="none"><a href="../../docs/installationguide.html">Installation Guide</a></li><li class="none"><a href="../../docs/sandesha2c_manual.html">Sandesha2/C manual</a></li></ul></li><li class="expanded"><a href="../../lists_issues.html">Get Involved</a><ul><li class="none"><a href="../../lists_issues.html">Mailing Lists &amp; Issue Tracking</a></li><li class="none"><a href="../../svn.html">Checkout Source Code</a></li></ul></li><li class="expanded"><a href="../../coding_conventions.html">Developer Guidelines</a><ul><li class="none"><a href="../../coding_conventions.html">Coding Convention</a></li><li class="none"><a href="../../versioning.html">Versionning</a></li></ul></li><li class="expanded"><a href="../../team-list.html">Project Information</a><ul><li class="none"><a href="../../team-list.html">Project Team</a></li><li class="none"><a href="http://svn.apache.org/viewvc/webservices/sandesha/trunk/c/" class="externalLink" title="External Link">Source Code</a></li></ul></li></ul></div><a href="http://maven.apache.org/" title="Built by Maven" id="poweredBy"><img alt="Built by Maven" src="../../images/logos/maven-button-1.png"></img></a></div></div><div id="bodyColumn"><div class="contentBox"><div class="section"><p>
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div></p></div><div class="section"><a name="Client"></a><h2>Client</h2><table class="bodyTable"><tr class="b"><td></td></tr><tr class="a"><td colspan="2"><br></br><h2>Modules</h2></td></tr><tr class="b"><td class="memItemLeft" nowrap="" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sandesha2__client__constants.html">Sandesha2_client_constants</a></td></tr><tr class="a"><td colspan="2"><br></br><h2>Functions</h2></td></tr><tr class="b"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="g474ab63f5082f4b8d1f8f3e09e155a6f"></a>
AXIS2_EXTERN <br></br>
sandesha2_seq_report_t * </td><td class="memItemRight" valign="bottom"><b>sandesha2_client_get_outgoing_seq_report_with_svc_client</b> (const axutil_env_t *env, axis2_svc_client_t *svc_client)</td></tr><tr class="a"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="gb2802036e64d20085e1c623d82b9186b"></a>
AXIS2_EXTERN <br></br>
sandesha2_seq_report_t * </td><td class="memItemRight" valign="bottom"><b>sandesha2_client_get_outgoing_seq_report_with_seq_key</b> (const axutil_env_t *env, axis2_char_t *to, axis2_char_t *seq_key, axis2_conf_ctx_t *conf_ctx)</td></tr><tr class="b"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="gb9489bd0a6f1a4643db8058e4e5a3dad"></a>
AXIS2_EXTERN <br></br>
sandesha2_seq_report_t * </td><td class="memItemRight" valign="bottom"><b>sandesha2_client_get_outgoing_seq_report_with_internal_seq_id</b> (const axutil_env_t *env, axis2_char_t *internal_seq_id, axis2_conf_ctx_t *conf_ctx)</td></tr><tr class="a"><td class="memItemLeft" nowrap="" align="right" valign="top">AXIS2_EXTERN <br></br>
axutil_array_list_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sandesha2__client.html#gcddb126198dd776e6fe3510af05c9c83">sandesha2_client_get_incoming_seq_reports</a> (axutil_env_t *env, axis2_conf_ctx_t *conf_ctx)</td></tr><tr class="b"><td class="memItemLeft" nowrap="" align="right" valign="top">AXIS2_EXTERN <br></br>
sandesha2_report_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sandesha2__client.html#gf3209f1304cac5b886967effdca46d19">sandesha2_client_get_report</a> (const axutil_env_t *env, axis2_conf_ctx_t *conf_ctx)</td></tr><tr class="a"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="ga0fe0c0da8036e75b4e96c6038cdc79e"></a>
AXIS2_EXTERN <br></br>
axis2_status_t </td><td class="memItemRight" valign="bottom"><b>sandesha2_client_create_seq_with_svc_client</b> (const axutil_env_t *env, axis2_svc_client_t *svc_client, axis2_bool_t offer)</td></tr><tr class="b"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="g65ff0e284b714a32a7a119e986549d33"></a>
AXIS2_EXTERN <br></br>
axis2_status_t </td><td class="memItemRight" valign="bottom"><b>sandesha2_client_create_seq_with_svc_client_and_seq_key</b> (const axutil_env_t *env, axis2_svc_client_t *svc_client, axis2_bool_t offer, axis2_char_t *seq_key)</td></tr><tr class="a"><td class="memItemLeft" nowrap="" align="right" valign="top">AXIS2_EXTERN <br></br>
axis2_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sandesha2__client.html#g919ba77611b4567ec4df690c30511346">sandesha2_client_terminate_seq_with_svc_client</a> (const axutil_env_t *env, axis2_svc_client_t *svc_client, axis2_callback_t *callback, axis2_listener_manager_t *listener_manager)</td></tr><tr class="b"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="g5f6b873f3d4f017cee63ae10223a0a87"></a>
AXIS2_EXTERN <br></br>
axis2_status_t </td><td class="memItemRight" valign="bottom"><b>sandesha2_client_terminate_seq_with_svc_client_and_seq_key</b> (const axutil_env_t *env, axis2_svc_client_t *svc_client, axis2_char_t *seq_key)</td></tr><tr class="a"><td class="memItemLeft" nowrap="" align="right" valign="top">AXIS2_EXTERN <br></br>
axis2_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sandesha2__client.html#ga87fe4d4d6acb961ec9e0baa1b922aa3">sandesha2_client_close_seq_with_svc_client</a> (const axutil_env_t *env, axis2_svc_client_t *svc_client)</td></tr><tr class="b"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="g9912cf20022fb29e02be67e0cf7b33ef"></a>
AXIS2_EXTERN <br></br>
axis2_status_t </td><td class="memItemRight" valign="bottom"><b>sandesha2_client_close_seq_with_svc_client_and_seq_key</b> (const axutil_env_t *env, axis2_svc_client_t *svc_client, axis2_char_t *seq_key)</td></tr><tr class="a"><td class="memItemLeft" nowrap="" align="right" valign="top">AXIS2_EXTERN <br></br>
axis2_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sandesha2__client.html#g363cad2a393e6b96eb7d01fe0f1c51a2">sandesha2_client_wait_until_seq_completed_with_svc_client</a> (const axutil_env_t *env, axis2_svc_client_t *svc_client)</td></tr><tr class="b"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="gcf49aed39ca17997566969f5bc6ea899"></a>
AXIS2_EXTERN <br></br>
axis2_status_t </td><td class="memItemRight" valign="bottom"><b>sandesha2_client_wait_until_seq_completed_with_svc_client_and_seq_key</b> (const axutil_env_t *env, axis2_svc_client_t *svc_client, axis2_char_t *seq_key)</td></tr><tr class="a"><td class="memItemLeft" nowrap="" align="right" valign="top">AXIS2_EXTERN <br></br>
axis2_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sandesha2__client.html#g5c16e3e0e3e3ff86244af2f09ddf8ab0">sandesha2_client_wait_until_seq_completed_with_svc_client_and_max_waiting_time</a> (const axutil_env_t *env, axis2_svc_client_t *svc_client, long max_waiting_time)</td></tr><tr class="b"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="g57f0910c7d8fc06340c5bc72a2011e18"></a>
AXIS2_EXTERN <br></br>
axis2_status_t </td><td class="memItemRight" valign="bottom"><b>sandesha2_client_wait_until_seq_completed_with_svc_client_and_max_waiting_time_and_seq_key</b> (const axutil_env_t *env, axis2_svc_client_t *svc_client, long max_waiting_time, axis2_char_t *seq_key)</td></tr><tr class="a"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="g466f28d90cdd9cf54d909ec2b0dfed71"></a>
AXIS2_EXTERN <br></br>
axis2_char_t * </td><td class="memItemRight" valign="bottom"><b>sandesha2_client_get_seq_id</b> (const axutil_env_t *env, axis2_svc_client_t *svc_client)</td></tr><tr class="b"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="g9ff1d7dd18cef6d42a9c9642bd2e6f58"></a>
AXIS2_EXTERN <br></br>
axis2_status_t </td><td class="memItemRight" valign="bottom"><b>sandesha2_client_send_ack_request_with_svc_client</b> (const axutil_env_t *env, axis2_svc_client_t *svc_client)</td></tr><tr class="a"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="g27ec2401c5077eb9aaa0bb39fa1746ac"></a>
AXIS2_EXTERN <br></br>
axis2_status_t </td><td class="memItemRight" valign="bottom"><b>sandesha2_client_send_ack_request_with_svc_client_and_seq_key</b> (const axutil_env_t *env, axis2_svc_client_t *svc_client, axis2_char_t *seq_key)</td></tr><tr class="b"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="g1586c8095a6619306c48a6cbd141ba96"></a>
AXIS2_EXTERN <br></br>
axis2_status_t </td><td class="memItemRight" valign="bottom"><b>sandesha2_client_send_non_blocking</b> (const axutil_env_t *env, axis2_svc_client_t *svc_client, axis2_options_t *options, axutil_qname_t *op_qname, axis2_callback_t *callback, axiom_node_t *payload, axis2_listener_manager_t *listener_manager)</td></tr><tr class="a"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="g780c9976b6467277416b705f851754ae"></a>
AXIS2_EXTERN void </td><td class="memItemRight" valign="bottom"><b>sandesha2_client_fire_and_forget</b> (const axutil_env_t *env, axis2_svc_client_t *svc_client, axis2_options_t *options, axutil_qname_t *op_qname, axis2_callback_t *callback, axiom_node_t *payload, axis2_listener_manager_t *listener_manager)</td></tr><tr class="b"><td class="memItemLeft" nowrap="" align="right" valign="top">axiom_node_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sandesha2__client.html#g4b4b151e4b9ae41ae37b4621210cee55">sandesha2_client_get_response_envelope</a> (const axutil_env_t *env, axis2_conf_ctx_t *conf_ctx, axis2_svc_client_t *svc_client, int msg_no)</td></tr></table></div><div class="section"><div class="subsection"><a name="Function_Documentation"></a><h3>Function Documentation</h3><p><a class="anchor" name="ga87fe4d4d6acb961ec9e0baa1b922aa3"></a>
<div class="memitem">
<div class="memproto">
<table class="bodyTable"><tr class="a"><td class="memname">AXIS2_EXTERN axis2_status_t sandesha2_client_close_seq_with_svc_client </td><td>(</td><td class="paramtype">const axutil_env_t * </td><td class="paramname"> <em>env</em>, </td></tr><tr class="b"><td class="paramkey"></td><td></td><td class="paramtype">axis2_svc_client_t * </td><td class="paramname"> <em>svc_client</em></td><td> </td></tr><tr class="a"><td></td><td>)</td><td></td><td></td><td width="100%"></td></tr></table>
</div>
<div class="memdoc">
<p>
User can close the seq defined by the passed svc_client.</p><p>
<dl compact=""><dt><b>Parameters:</b></dt><dd>
<table class="bodyTable"><tr class="b"><td valign="top"></td><td valign="top"><em>svc_client</em> </td><td></td></tr></table>
</dd></dl>
</p></div>
</div></p><p>
<a class="anchor" name="gcddb126198dd776e6fe3510af05c9c83"></a>
<div class="memitem">
<div class="memproto">
<table class="bodyTable"><tr class="a"><td class="memname">AXIS2_EXTERN axutil_array_list_t* sandesha2_client_get_incoming_seq_reports </td><td>(</td><td class="paramtype">axutil_env_t * </td><td class="paramname"> <em>env</em>, </td></tr><tr class="b"><td class="paramkey"></td><td></td><td class="paramtype">axis2_conf_ctx_t * </td><td class="paramname"> <em>conf_ctx</em></td><td> </td></tr><tr class="a"><td></td><td>)</td><td></td><td></td><td width="100%"></td></tr></table>
</div>
<div class="memdoc">
</div></div></p><p>
Users can get a list of seq_reports each describing a incoming sequence, which are the sequences the client work as a RMD. Caller must free the returned array.</p><p>
<dl compact=""><dt><b>Parameters:</b></dt><dd>
<table class="bodyTable"><tr class="b"><td valign="top"></td><td valign="top"><em>config_ctx</em> </td><td></td></tr></table>
</dd></dl>
<dl class="return" compact=""><dt><b>Returns:</b></dt><dd></dd></dl>
</p><p>
<a class="anchor" name="gf3209f1304cac5b886967effdca46d19"></a>
<div class="memitem">
<div class="memproto">
<table class="bodyTable"><tr class="a"><td class="memname">AXIS2_EXTERN sandesha2_report_t* sandesha2_client_get_report </td><td>(</td><td class="paramtype">const axutil_env_t * </td><td class="paramname"> <em>env</em>, </td></tr><tr class="b"><td class="paramkey"></td><td></td><td class="paramtype">axis2_conf_ctx_t * </td><td class="paramname"> <em>conf_ctx</em></td><td> </td></tr><tr class="a"><td></td><td>)</td><td></td><td></td><td width="100%"></td></tr></table>
</div>
<div class="memdoc">
</div></div></p><p>
sandesha2_report gives the details of all incoming and outgoing sequences. The outgoing sequence have to pass the initial state (CS/CSR exchange) to be included in a sandesha2_report</p><p>
<dl compact=""><dt><b>Parameters:</b></dt><dd>
<table class="bodyTable"><tr class="b"><td valign="top"></td><td valign="top"><em>conf_ctx</em> </td><td></td></tr></table>
</dd></dl>
<dl class="return" compact=""><dt><b>Returns:</b></dt><dd></dd></dl>
</p><p>
<a class="anchor" name="g4b4b151e4b9ae41ae37b4621210cee55"></a>
<div class="memitem">
<div class="memproto">
<table class="bodyTable"><tr class="a"><td class="memname">axiom_node_t* sandesha2_client_get_response_envelope </td><td>(</td><td class="paramtype">const axutil_env_t * </td><td class="paramname"> <em>env</em>, </td></tr><tr class="b"><td class="paramkey"></td><td></td><td class="paramtype">axis2_conf_ctx_t * </td><td class="paramname"> <em>conf_ctx</em>, </td></tr><tr class="a"><td class="paramkey"></td><td></td><td class="paramtype">axis2_svc_client_t * </td><td class="paramname"> <em>svc_client</em>, </td></tr><tr class="b"><td class="paramkey"></td><td></td><td class="paramtype">int </td><td class="paramname"> <em>msg_no</em></td><td> </td></tr><tr class="a"><td></td><td>)</td><td></td><td></td><td width="100%"></td></tr></table>
</div>
<div class="memdoc">
</div></div></p><p>
In RM 1.0 two way single channel messaging user need to call for the response envelope.</p><p>
<dl compact=""><dt><b>Parameters:</b></dt><dd>
<table class="bodyTable"><tr class="b"><td valign="top"></td><td valign="top"><em>conf_ctx</em> </td><td></td></tr><tr class="a"><td valign="top"></td><td valign="top"><em>svc_client</em> </td><td></td></tr><tr class="b"><td valign="top"></td><td valign="top"><em>msg_no</em> </td><td></td></tr></table>
</dd></dl>
<dl class="return" compact=""><dt><b>Returns:</b></dt><dd>response soap envelope </dd></dl>
</p><p>
<a class="anchor" name="g919ba77611b4567ec4df690c30511346"></a>
<div class="memitem">
<div class="memproto">
<table class="bodyTable"><tr class="a"><td class="memname">AXIS2_EXTERN axis2_status_t sandesha2_client_terminate_seq_with_svc_client </td><td>(</td><td class="paramtype">const axutil_env_t * </td><td class="paramname"> <em>env</em>, </td></tr><tr class="b"><td class="paramkey"></td><td></td><td class="paramtype">axis2_svc_client_t * </td><td class="paramname"> <em>svc_client</em>, </td></tr><tr class="a"><td class="paramkey"></td><td></td><td class="paramtype">axis2_callback_t * </td><td class="paramname"> <em>callback</em>, </td></tr><tr class="b"><td class="paramkey"></td><td></td><td class="paramtype">axis2_listener_manager_t * </td><td class="paramname"> <em>listener_manager</em></td><td> </td></tr><tr class="a"><td></td><td>)</td><td></td><td></td><td width="100%"></td></tr></table>
</div>
<div class="memdoc">
</div></div></p><p>
User can terminate the sequence defined by the passed svc_client.</p><p>
<dl compact=""><dt><b>Parameters:</b></dt><dd>
<table class="bodyTable"><tr class="b"><td valign="top"></td><td valign="top"><em>svc_client</em> </td><td></td></tr></table>
</dd></dl>
</p><p>
<a class="anchor" name="g363cad2a393e6b96eb7d01fe0f1c51a2"></a>
<div class="memitem">
<div class="memproto">
<table class="bodyTable"><tr class="a"><td class="memname">AXIS2_EXTERN axis2_status_t sandesha2_client_wait_until_seq_completed_with_svc_client </td><td>(</td><td class="paramtype">const axutil_env_t * </td><td class="paramname"> <em>env</em>, </td></tr><tr class="b"><td class="paramkey"></td><td></td><td class="paramtype">axis2_svc_client_t * </td><td class="paramname"> <em>svc_client</em></td><td> </td></tr><tr class="a"><td></td><td>)</td><td></td><td></td><td width="100%"></td></tr></table>
</div>
<div class="memdoc">
</div></div></p><p>
This blocks the system until the messages sent have been completed.</p><p>
<dl compact=""><dt><b>Parameters:</b></dt><dd>
<table class="bodyTable"><tr class="b"><td valign="top"></td><td valign="top"><em>svc_client</em> </td><td></td></tr></table>
</dd></dl>
</p><p>
<a class="anchor" name="g5c16e3e0e3e3ff86244af2f09ddf8ab0"></a>
<div class="memitem">
<div class="memproto">
<table class="bodyTable"><tr class="a"><td class="memname">AXIS2_EXTERN axis2_status_t sandesha2_client_wait_until_seq_completed_with_svc_client_and_max_waiting_time </td><td>(</td><td class="paramtype">const axutil_env_t * </td><td class="paramname"> <em>env</em>, </td></tr><tr class="b"><td class="paramkey"></td><td></td><td class="paramtype">axis2_svc_client_t * </td><td class="paramname"> <em>svc_client</em>, </td></tr><tr class="a"><td class="paramkey"></td><td></td><td class="paramtype">long </td><td class="paramname"> <em>max_waiting_time</em></td><td> </td></tr><tr class="b"><td></td><td>)</td><td></td><td></td><td width="100%"></td></tr></table>
</div>
<div class="memdoc">
</div></div></p><p>
This blocks the system until the messages sent have been completed or until the given time interval exceeds. (the time is taken in seconds)</p><p>
<dl compact=""><dt><b>Parameters:</b></dt><dd>
<table class="bodyTable"><tr class="a"><td valign="top"></td><td valign="top"><em>svc_client</em> </td><td></td></tr><tr class="b"><td valign="top"></td><td valign="top"><em>max_waiting_time</em> </td><td></td></tr></table>
</dd></dl>
</p><p>
</p></div></div><div class="section"><address style="text-align: right;"><small>Generated on Mon Oct 1 17:19:06 2007 for Sandesha2/C by 
<a href="http://www.doxygen.org/index.html" class="externalLink" title="External Link">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></img></a> 1.5.3 </small></address></div></div></div><div class="clear"><hr></hr></div><div id="footer"><div class="xright">© 2005-2007, Apache Software Foundation</div><div class="clear"><hr></hr></div></div></body></html>