Author: damitha
Date: Thu Feb  8 20:16:41 2007
New Revision: 505170

URL: http://svn.apache.org/viewvc?view=rev&rev=505170
Log:
added documentation

Modified:
    webservices/sandesha/trunk/c/include/sandesha2_permanent_bean_mgr.h
    webservices/sandesha/trunk/c/include/sandesha2_storage_mgr.h

Modified: webservices/sandesha/trunk/c/include/sandesha2_permanent_bean_mgr.h
URL: 
http://svn.apache.org/viewvc/webservices/sandesha/trunk/c/include/sandesha2_permanent_bean_mgr.h?view=diff&rev=505170&r1=505169&r2=505170
==============================================================================
--- webservices/sandesha/trunk/c/include/sandesha2_permanent_bean_mgr.h 
(original)
+++ webservices/sandesha/trunk/c/include/sandesha2_permanent_bean_mgr.h Thu Feb 
 8 20:16:41 2007
@@ -76,6 +76,17 @@
     sandesha2_permanent_bean_mgr_t *bean_mgr,
     const axis2_env_t *env);
 
+/**
+ * Database insert method. Storage managers use this function
+ * to store data to the database
+ * @param bean_mgr
+ * @param env
+ * @param bean
+ * @param retrieve_func retrieve callback function
+ * @param sql_stmt_retrieve
+ * @param sql_stmt_update
+ * @param sql_stmt_insert
+ */
 axis2_bool_t AXIS2_CALL
 sandesha2_permanent_bean_mgr_insert(
     sandesha2_permanent_bean_mgr_t *bean_mgr,

Modified: webservices/sandesha/trunk/c/include/sandesha2_storage_mgr.h
URL: 
http://svn.apache.org/viewvc/webservices/sandesha/trunk/c/include/sandesha2_storage_mgr.h?view=diff&rev=505170&r1=505169&r2=505170
==============================================================================
--- webservices/sandesha/trunk/c/include/sandesha2_storage_mgr.h (original)
+++ webservices/sandesha/trunk/c/include/sandesha2_storage_mgr.h Thu Feb  8 
20:16:41 2007
@@ -192,6 +192,12 @@
     sandesha2_storage_mgr_t *storage_mgr,
     const axis2_env_t *envv);
 
+/**
+ * get a new transaction for use
+ * @param storage_mgr
+ * @param env environment object
+ * @return newly created sandesha2_transaction object
+ */
 struct sandesha2_transaction *AXIS2_CALL
 sandesha2_storage_mgr_get_transaction(
     sandesha2_storage_mgr_t *storage_mgr,
@@ -244,14 +250,32 @@
     sandesha2_storage_mgr_t *storage_mgr,
     const axis2_env_t *env,
     axis2_conf_ctx_t *conf_ctx);
-       
+
+/**
+ * Retrieve the stored message context.
+ * @param storage_mgr
+ * @param env environment object
+ * @param key message storage key
+ * @param conf_ctx configuration context
+ * @return newly created axis2_msg_ctx object.
+ */
 axis2_msg_ctx_t *AXIS2_CALL
 sandesha2_storage_mgr_retrieve_msg_ctx(
     sandesha2_storage_mgr_t *storage_mgr,
     const axis2_env_t *env,
     axis2_char_t *key,
     axis2_conf_ctx_t *conf_ctx);
-               
+
+/**
+ * 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
+ * @param storage_mgr
+ * @param env environment object
+ * @param key message storage key.
+ * @param msg_ctx message context
+ * @return status of the operation
+ */
 axis2_status_t AXIS2_CALL
 sandesha2_storage_mgr_store_msg_ctx(
     sandesha2_storage_mgr_t *storage_mgr,



---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to