blob: e118328b94cd2148b8e5f4f094bb1a5e55c7a559 [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: sandesha2_storage_mgr.h File Reference</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 class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div><div class="nav">
<a class="el" href="dir_16487952adfeac4b2b9df719b49efdb6.html">include</a></div></p></div><div class="section"><a name="sandesha2_storage_mgr_h_File_Reference"></a><h2>sandesha2_storage_mgr.h File Reference</h2><code>#include &lt;platforms/axutil_platform_auto_sense.h&gt;</code><br></br><code>#include &lt;axutil_utils_defines.h&gt;</code><br></br><code>#include &lt;axutil_env.h&gt;</code><br></br><code>#include &lt;axiom_soap_envelope.h&gt;</code><br></br><code>#include &lt;axis2_conf_ctx.h&gt;</code><br></br><code>#include &lt;axis2_module_desc.h&gt;</code><br></br><code>#include &lt;<a class="el" href="sandesha2__transaction_8h-source.html">sandesha2_transaction.h</a>&gt;</code><br></br><p>
<a href="sandesha2__storage__mgr_8h-source.html">Go to the source code of this file.</a><table class="bodyTable"><tr class="b"><td></td></tr><tr class="a"><td colspan="2"><br></br><h2>Classes</h2></td></tr><tr class="b"><td class="memItemLeft" nowrap="" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsandesha2__storage__mgr__ops.html">sandesha2_storage_mgr_ops</a></td></tr><tr class="a"><td class="mdescLeft"> </td><td class="mdescRight">Storage Manager ops struct Encapsulator struct for ops of sandesha2_storage_mgr. <a href="structsandesha2__storage__mgr__ops.html#_details">More...</a><br></br></td></tr><tr class="b"><td class="memItemLeft" nowrap="" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><b>sandesha2_storage_mgr</b></td></tr><tr class="a"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="e4e20f10e0036564e1c0a19f3f2f3d34"></a>
typedef struct <br></br>
sandesha2_storage_mgr </td><td class="memItemRight" valign="bottom"><b>sandesha2_storage_mgr_t</b></td></tr><tr class="b"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="0e2f07984b54191ade24911f5afd6b57"></a>
typedef struct <br></br>
<a class="el" href="structsandesha2__storage__mgr__ops.html">sandesha2_storage_mgr_ops</a> </td><td class="memItemRight" valign="bottom"><b>sandesha2_storage_mgr_ops_t</b></td></tr><tr class="a"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="83aae4e36dab0562b0b1776ac1b45c0f"></a>
AXIS2_EXTERN <br></br>
sandesha2_storage_mgr_t * </td><td class="memItemRight" valign="bottom"><b>sandesha2_storage_mgr_create</b> (const 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>
axis2_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="sandesha2__storage__mgr_8h.html#aefde483dc9cb3d4c1cda32dba57cfb4">sandesha2_storage_mgr_free_void_arg</a> (void *storage_mgr, const axutil_env_t *env)</td></tr><tr class="a"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="094030f44ff67b600bb4f6e762c83b0d"></a>
axis2_status_t </td><td class="memItemRight" valign="bottom"><b>sandesha2_storage_mgr_free</b> (sandesha2_storage_mgr_t *storage_mgr, const axutil_env_t *envv)</td></tr><tr class="b"><td class="memItemLeft" nowrap="" align="right" valign="top">struct <br></br>
sandesha2_transaction * </td><td class="memItemRight" valign="bottom"><a class="el" href="sandesha2__storage__mgr_8h.html#24cbaf1ba5419f1466158e168325e3e2">sandesha2_storage_mgr_get_transaction</a> (sandesha2_storage_mgr_t *storage_mgr, const axutil_env_t *env)</td></tr><tr class="a"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="79d4318031cafc57b7e1cb647407e583"></a>
void </td><td class="memItemRight" valign="bottom"><b>sandesha2_storage_mgr_enlist_bean</b> (sandesha2_storage_mgr_t *storage_mgr, const axutil_env_t *env, struct sandesha2_rm_bean *rm_bean)</td></tr><tr class="b"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="b2d4baa1317524ba81e695b43cf44781"></a>
struct <br></br>
sandesha2_create_seq_mgr * </td><td class="memItemRight" valign="bottom"><b>sandesha2_storage_mgr_get_create_seq_mgr</b> (sandesha2_storage_mgr_t *storage_mgr, const axutil_env_t *env)</td></tr><tr class="a"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="42df0ce7472839cefc2f8c1ba70cefc4"></a>
struct <br></br>
sandesha2_next_msg_mgr * </td><td class="memItemRight" valign="bottom"><b>sandesha2_storage_mgr_get_next_msg_mgr</b> (sandesha2_storage_mgr_t *storage_mgr, const axutil_env_t *env)</td></tr><tr class="b"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="d21b477d49708886f54ce14f2c8c4db0"></a>
struct <br></br>
sandesha2_sender_mgr * </td><td class="memItemRight" valign="bottom"><b>sandesha2_storage_mgr_get_retrans_mgr</b> (sandesha2_storage_mgr_t *storage_mgr, const axutil_env_t *env)</td></tr><tr class="a"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="a8bba6a6a0583256cb6652ee824581d3"></a>
struct <br></br>
sandesha2_seq_property_mgr * </td><td class="memItemRight" valign="bottom"><b>sandesha2_storage_mgr_get_seq_property_mgr</b> (sandesha2_storage_mgr_t *storage_mgr, const axutil_env_t *env)</td></tr><tr class="b"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="be8bcd8f7e369d25d8805eb9e50f4d96"></a>
struct <br></br>
sandesha2_invoker_mgr * </td><td class="memItemRight" valign="bottom"><b>sandesha2_storage_mgr_get_storage_map_mgr</b> (sandesha2_storage_mgr_t *storage_mgr, const axutil_env_t *env)</td></tr><tr class="a"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="b2467f8bdcd86237e951aa866c803d09"></a>
axis2_status_t </td><td class="memItemRight" valign="bottom"><b>sandesha2_storage_mgr_set_ctx</b> (sandesha2_storage_mgr_t *storage_mgr, const axutil_env_t *env, axis2_conf_ctx_t *conf_ctx)</td></tr><tr class="b"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="aed1a714e235135884ba404f6d605981"></a>
axis2_conf_ctx_t * </td><td class="memItemRight" valign="bottom"><b>sandesha2_storage_mgr_get_ctx</b> (sandesha2_storage_mgr_t *storage_mgr, const axutil_env_t *env)</td></tr><tr class="a"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="58f6c2796b721e982828eb735becb673"></a>
axis2_status_t </td><td class="memItemRight" valign="bottom"><b>sandesha2_storage_mgr_init</b> (sandesha2_storage_mgr_t *storage_mgr, const axutil_env_t *env, axis2_conf_ctx_t *conf_ctx)</td></tr><tr class="b"><td class="memItemLeft" nowrap="" align="right" valign="top">axis2_msg_ctx_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="sandesha2__storage__mgr_8h.html#30805f5855b3951a199843e279f8be91">sandesha2_storage_mgr_retrieve_msg_ctx</a> (sandesha2_storage_mgr_t *storage_mgr, const axutil_env_t *env, axis2_char_t *key, axis2_conf_ctx_t *conf_ctx, const axis2_bool_t persistent)</td></tr><tr class="a"><td class="memItemLeft" nowrap="" align="right" valign="top">axis2_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="sandesha2__storage__mgr_8h.html#469f2a6cfd6d8571c2622861c4e59374">sandesha2_storage_mgr_store_msg_ctx</a> (sandesha2_storage_mgr_t *storage_mgr, const axutil_env_t *env, axis2_char_t *key, axis2_msg_ctx_t *msg_ctx)</td></tr><tr class="b"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="8e700fed2ee82dd66ed81b41b0695bb0"></a>
axis2_status_t </td><td class="memItemRight" valign="bottom"><b>sandesha2_storage_mgr_update_msg_ctx</b> (sandesha2_storage_mgr_t *storage_mgr, const axutil_env_t *env, axis2_char_t *key, axis2_msg_ctx_t *msg_ctx)</td></tr><tr class="a"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="d0360bfe1245bb535716ec722f62a570"></a>
axis2_status_t </td><td class="memItemRight" valign="bottom"><b>sandesha2_storage_mgr_remove_msg_ctx</b> (sandesha2_storage_mgr_t *storage_mgr, const axutil_env_t *env, axis2_char_t *key)</td></tr><tr class="b"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="6f2660a136704977c9cbc51856c77eaf"></a>
axis2_status_t </td><td class="memItemRight" valign="bottom"><b>sandesha2_storage_mgr_init_storage</b> (sandesha2_storage_mgr_t *storage_mgr, const axutil_env_t *env, axis2_module_desc_t *module_desc)</td></tr><tr class="a"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="91b0e044d13c98e7d69eb3f9dfac7e9b"></a>
axiom_soap_envelope_t * </td><td class="memItemRight" valign="bottom"><b>sandesha2_storage_mgr_retrieve_soap_envelope</b> (sandesha2_storage_mgr_t *storage_mgr, const axutil_env_t *env, axis2_char_t *key)</td></tr><tr class="b"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="3009838d9b8e85a655cbb821cd5031ac"></a>
axis2_status_t </td><td class="memItemRight" valign="bottom"><b>sandesha2_storage_mgr_store_soap_envelope</b> (sandesha2_storage_mgr_t *storage_mgr, const axutil_env_t *env, axiom_soap_envelope_t *soap_env, axis2_char_t *key)</td></tr><tr class="a"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="61862448049f405f7ee2562d442f8e88"></a>
axis2_status_t </td><td class="memItemRight" valign="bottom"><b>sandesha2_storage_mgr_store_response</b> (sandesha2_storage_mgr_t *storage_mgr, const axutil_env_t *env, axis2_char_t *seq_id, axiom_soap_envelope_t *response, int msg_no, int soap_version)</td></tr><tr class="b"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="8b8184b14eed941e03027be466d4e5f8"></a>
axiom_soap_envelope_t * </td><td class="memItemRight" valign="bottom"><b>sandesha2_storage_mgr_retrieve_response</b> (sandesha2_storage_mgr_t *storage_mgr, const axutil_env_t *env, axis2_char_t *seq_id, int msg_no)</td></tr><tr class="a"><td class="memItemLeft" nowrap="" align="right" valign="top"><a class="anchor" name="f81b9fca8171f4b67aa23c343ac86047"></a>
axis2_status_t </td><td class="memItemRight" valign="bottom"><b>sandesha2_storage_mgr_remove_response</b> (sandesha2_storage_mgr_t *storage_mgr, const axutil_env_t *env, axis2_char_t *seq_id, int msg_no)</td></tr></table>
</p></div><div class="section"><p><a name="_details"></a></p><div class="subsection"><a name="Detailed_Description"></a><h3>Detailed Description</h3></div></div><div class="section"><div class="subsection"><a name="Function_Documentation"></a><h3>Function Documentation</h3><p><a class="anchor" name="aefde483dc9cb3d4c1cda32dba57cfb4"></a>
<div class="memitem">
<div class="memproto">
<table class="bodyTable"><tr class="b"><td class="memname">AXIS2_EXTERN axis2_status_t sandesha2_storage_mgr_free_void_arg </td><td>(</td><td class="paramtype">void * </td><td class="paramname"> <em>storage_mgr</em>, </td></tr><tr class="a"><td class="paramkey"></td><td></td><td class="paramtype">const axutil_env_t * </td><td class="paramname"> <em>env</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">
<p>
Frees the storage_mgr given as a void pointer. This method would cast the void parameter to an storage_mgr pointer and then call free method. <dl compact=""><dt><b>Parameters:</b></dt><dd>
<table class="bodyTable"><tr class="a"><td valign="top"></td><td valign="top"><em>storage_mgr</em> </td><td>pointer to storage_mgr as a void pointer </td></tr><tr class="b"><td valign="top"></td><td valign="top"><em>env</em> </td><td>pointer to environment struct </td></tr></table>
</dd></dl>
<dl class="return" compact=""><dt><b>Returns:</b></dt><dd>AXIS2_SUCCESS on success, else AXIS2_FAILURE </dd></dl>
</p></div>
</div></p><p>
<a class="anchor" name="24cbaf1ba5419f1466158e168325e3e2"></a>
<div class="memitem">
<div class="memproto">
<table class="bodyTable"><tr class="a"><td class="memname">struct sandesha2_transaction* sandesha2_storage_mgr_get_transaction </td><td>(</td><td class="paramtype">sandesha2_storage_mgr_t * </td><td class="paramname"> <em>storage_mgr</em>, </td></tr><tr class="b"><td class="paramkey"></td><td></td><td class="paramtype">const axutil_env_t * </td><td class="paramname"> <em>env</em></td><td> </td></tr><tr class="a"><td></td><td>)</td><td></td><td></td><td width="100%"><code> [read]</code></td></tr></table>
</div>
<div class="memdoc">
</div></div></p><p>
get a new transaction for use <dl compact=""><dt><b>Parameters:</b></dt><dd>
<table class="bodyTable"><tr class="b"><td valign="top"></td><td valign="top"><em>storage_mgr</em> </td><td></td></tr><tr class="a"><td valign="top"></td><td valign="top"><em>env</em> </td><td>environment object </td></tr></table>
</dd></dl>
<dl class="return" compact=""><dt><b>Returns:</b></dt><dd>newly created sandesha2_transaction object </dd></dl>
</p><p>
<a class="anchor" name="30805f5855b3951a199843e279f8be91"></a>
<div class="memitem">
<div class="memproto">
<table class="bodyTable"><tr class="b"><td class="memname">axis2_msg_ctx_t* sandesha2_storage_mgr_retrieve_msg_ctx </td><td>(</td><td class="paramtype">sandesha2_storage_mgr_t * </td><td class="paramname"> <em>storage_mgr</em>, </td></tr><tr class="a"><td class="paramkey"></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_char_t * </td><td class="paramname"> <em>key</em>, </td></tr><tr class="a"><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="b"><td class="paramkey"></td><td></td><td class="paramtype">const axis2_bool_t </td><td class="paramname"> <em>persistent</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>
Retrieve the stored message context. <dl compact=""><dt><b>Parameters:</b></dt><dd>
<table class="bodyTable"><tr class="b"><td valign="top"></td><td valign="top"><em>storage_mgr</em> </td><td></td></tr><tr class="a"><td valign="top"></td><td valign="top"><em>env</em> </td><td>environment object </td></tr><tr class="b"><td valign="top"></td><td valign="top"><em>key</em> </td><td>message storage key </td></tr><tr class="a"><td valign="top"></td><td valign="top"><em>conf_ctx</em> </td><td>configuration context </td></tr></table>
</dd></dl>
<dl class="return" compact=""><dt><b>Returns:</b></dt><dd>newly created axis2_msg_ctx object. </dd></dl>
</p><p>
<a class="anchor" name="469f2a6cfd6d8571c2622861c4e59374"></a>
<div class="memitem">
<div class="memproto">
<table class="bodyTable"><tr class="b"><td class="memname">axis2_status_t sandesha2_storage_mgr_store_msg_ctx </td><td>(</td><td class="paramtype">sandesha2_storage_mgr_t * </td><td class="paramname"> <em>storage_mgr</em>, </td></tr><tr class="a"><td class="paramkey"></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_char_t * </td><td class="paramname"> <em>key</em>, </td></tr><tr class="a"><td class="paramkey"></td><td></td><td class="paramtype">axis2_msg_ctx_t * </td><td class="paramname"> <em>msg_ctx</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>
Store the application message context. When Sandesha2 handlers receive application messages it will be first stored in inmemory/persistent storage until it is later qualified for sending to the destination <dl compact=""><dt><b>Parameters:</b></dt><dd>
<table class="bodyTable"><tr class="a"><td valign="top"></td><td valign="top"><em>storage_mgr</em> </td><td></td></tr><tr class="b"><td valign="top"></td><td valign="top"><em>env</em> </td><td>environment object </td></tr><tr class="a"><td valign="top"></td><td valign="top"><em>key</em> </td><td>message storage key. </td></tr><tr class="b"><td valign="top"></td><td valign="top"><em>msg_ctx</em> </td><td>message context </td></tr></table>
</dd></dl>
<dl class="return" compact=""><dt><b>Returns:</b></dt><dd>status of the operation </dd></dl>
</p><p>
</p></div></div><div class="section"><address style="text-align: right;"><small>Generated on Mon Oct 1 17:19:05 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>