You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-dev@axis.apache.org by na...@apache.org on 2006/02/07 07:41:46 UTC
svn commit: r375518 - /webservices/axis2/trunk/c/include/axis2_soap_header.h
Author: nandika
Date: Mon Feb 6 22:41:45 2006
New Revision: 375518
URL: http://svn.apache.org/viewcvs?rev=375518&view=rev
Log:
comments added
Modified:
webservices/axis2/trunk/c/include/axis2_soap_header.h
Modified: webservices/axis2/trunk/c/include/axis2_soap_header.h
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/c/include/axis2_soap_header.h?rev=375518&r1=375517&r2=375518&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_soap_header.h (original)
+++ webservices/axis2/trunk/c/include/axis2_soap_header.h Mon Feb 6 22:41:45 2006
@@ -64,29 +64,28 @@
axis2_status_t (AXIS2_CALL *free_fn)(axis2_soap_header_t *header,
axis2_env_t **env);
- /**
- * Creates a new <CODE>SOAPHeaderBlock</CODE> object initialized with the
- * specified name and adds it to this <CODE>SOAPHeader</CODE> object.
- *
- * @param localName
- * @param ns
- * @return the new <CODE>SOAPHeaderBlock</CODE> object that was inserted
- * into this <CODE>SOAPHeader</CODE> object
+ /**
+ * create a new axis2_soap_header_block_t struct initialized with the
+ * specified name and adds it to passed axis2_soap_header_t struct.
+ * @param env environment must not be null
+ * @param localName
+ * @param ns
+ * @return The newly created axis2_soap_header_block_t struct
*/
struct axis2_soap_header_block* (AXIS2_CALL *add_header_block)
(axis2_soap_header_t* header,
axis2_env_t **env,
axis2_char_t *localname,
axis2_om_namespace_t *ns);
- /**
- * Returns a list of all the <CODE>SOAPHeaderBlock</CODE> objects in this
- * <CODE>SOAPHeader</CODE> object that have the the specified actor. An
- * actor is a global attribute that indicates the intermediate parties to
- * whom the message should be sent. An actor receives the message and then
- * sends it to the next actor. The default actor is the ultimate intended
- * recipient for the message, so if no actor attribute is included in a
- * <CODE>SOAPHeader</CODE> object, the message is sent to its ultimate
- * destination.
+ /**
+ * returns a hash_table of all the soap_header_block_t struct in this
+ * soap_header_t object that have the the specified actor. An
+ * actor is a global attribute that indicates the intermediate parties to
+ * whom the message should be sent. An actor receives the message and then
+ * sends it to the next actor. The default actor is the ultimate intended
+ * recipient for the message, so if no actor attribute is set in a
+ * axis2_soap_header_t struct the message is sent to its ultimate
+ * destination.
*/
axis2_hash_t* (AXIS2_CALL *examine_header_blocks)
(axis2_soap_header_t* header,
@@ -106,13 +105,23 @@
axis2_env_t **env,
axis2_char_t *ns_uri);
/**
- *
+ * returns an iterator to iterate through all soap header block's om nodes
+ * @param header
+ * @param env environment
+ * @returns axis2_om_children_qname_iterator_t or null if no header blocks
+ * present
*/
axis2_om_children_qname_iterator_t* (AXIS2_CALL *examine_all_header_blocks)
(axis2_soap_header_t* header,
axis2_env_t **env);
/**
- *
+ * returns an iterator to iterate through all header blocks om_nodes
+ * with the matching role attribute
+ * @param header soap_header
+ * @param env environment
+ * @param role
+ * @returns iterator or null if no header blocks present with matching
+ * role attribute
*/
axis2_om_children_with_specific_attribute_iterator_t *
(AXIS2_CALL *extract_header_blocks)(axis2_soap_header_t *header,
@@ -122,21 +131,35 @@
/**
- * This is only intended to be used by the builder,
+ * This is intended to be used by the builder,
* do not use this function in other places
*/
axis2_status_t (AXIS2_CALL *set_base_node)
(axis2_soap_header_t *header,
axis2_env_t **env,
axis2_om_node_t *node);
-
+ /**
+ * returns the axis2_om_node_t struct wrapped in soap_header
+ * @param header soap_header_t
+ * @param env environment must not be null
+ * @return axis2_om_node_t
+ */
axis2_om_node_t* (AXIS2_CALL *get_base_node)
(axis2_soap_header_t *header,
axis2_env_t **env);
-
- axis2_status_t (AXIS2_CALL *get_soap_version)
- (axis2_soap_header_t *header,
+
+ /**
+ * return the soap_version of this soap_header
+ * @param header soap_header
+ * @param env environment must not be null
+ * @return AXIS2_SOAP11 or AXIS2_SOAP12
+ */
+ int (AXIS2_CALL *get_soap_version) (axis2_soap_header_t *header,
axis2_env_t **env);
+ /**
+ * sets the soap version for this soap_header
+ * @param soap_version AXIS2_SOAP12 or AXIS2_SOAP11
+ */
axis2_status_t (AXIS2_CALL *set_soap_version)
(axis2_soap_header_t *header,