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 ka...@apache.org on 2008/03/27 10:37:19 UTC
svn commit: r641753 - in /webservices/axis2/trunk/c/axiom/include:
axiom_element.h axiom_mime_parser.h
Author: kaushalye
Date: Thu Mar 27 02:37:12 2008
New Revision: 641753
URL: http://svn.apache.org/viewvc?rev=641753&view=rev
Log:
Axis2c hackathon : Mime parser and axiom element headers
Modified:
webservices/axis2/trunk/c/axiom/include/axiom_element.h
webservices/axis2/trunk/c/axiom/include/axiom_mime_parser.h
Modified: webservices/axis2/trunk/c/axiom/include/axiom_element.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/axiom/include/axiom_element.h?rev=641753&r1=641752&r2=641753&view=diff
==============================================================================
--- webservices/axis2/trunk/c/axiom/include/axiom_element.h (original)
+++ webservices/axis2/trunk/c/axiom/include/axiom_element.h Thu Mar 27 02:37:12 2008
@@ -577,7 +577,6 @@
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @param om_node pointer to this element node
- *
* @param om_ns pointer to namespace to be set
* @returns
*/
@@ -601,13 +600,29 @@
const axutil_env_t * env,
axiom_node_t * ele_node);
+ /**
+ * Returns the attribute value as a string for the given element
+ * @param om_element pointer to om_element
+ * @param env environment MUST not be NULL
+ * @param attr_name the attribute name
+ *
+ * @return the attribute value as a string
+ */
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
-
axiom_element_get_attribute_value_by_name(
axiom_element_t * om_ele,
const axutil_env_t * env,
axis2_char_t * attr_name);
+ /**
+ * Create an OM Element and an OM node from given string params
+ * @param env environment MUST not be NULL
+ * @param parent pointer to this parent element node
+ * @param localname the locanmae of the element
+ * @param ns the namespace of the element
+ * @param node the reference ot the created node
+ * @return
+ */
AXIS2_EXTERN axiom_element_t *AXIS2_CALL
axiom_element_create_str(
const axutil_env_t * env,
@@ -616,22 +631,53 @@
axiom_namespace_t * ns,
axiom_node_t ** node);
+ /**
+ * Returns the Local name of the element
+ * @param om_element pointer to om_element
+ * @param env environment MUST not be NULL
+ * @param om_node pointer to this element node
+ *
+ * @return the Local name of the element
+ */
AXIS2_EXTERN axutil_string_t *AXIS2_CALL
axiom_element_get_localname_str(
axiom_element_t * om_element,
const axutil_env_t * env);
+ /**
+ * Set the Local name of the element
+ * @param om_element pointer to om_element
+ * @param env environment MUST not be NULL
+ * @param localname the Local name of the element
+ *
+ * @return
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_element_set_localname_str(
axiom_element_t * om_element,
const axutil_env_t * env,
axutil_string_t * localname);
+ /**
+ * Return whether the element is empty or not
+ * @param om_element pointer to om_element
+ * @param env environment MUST not be NULL
+ *
+ * @return AXIS2_TRUE if empty AXIS2_FALSE if not empty
+ */
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axiom_element_get_is_empty(
axiom_element_t * om_element,
const axutil_env_t * env);
+ /**
+ * Set whether the element is empty or not
+ * @param om_element pointer to om_element
+ * @param env environment MUST not be NULL
+ * @param is_empty AXIS2_TRUE if empty AXIS2_FALSE if not empty
+ *
+ * @return VOID
+ */
AXIS2_EXTERN void AXIS2_CALL
axiom_element_set_is_empty(
axiom_element_t * om_element,
Modified: webservices/axis2/trunk/c/axiom/include/axiom_mime_parser.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/axiom/include/axiom_mime_parser.h?rev=641753&r1=641752&r2=641753&view=diff
==============================================================================
--- webservices/axis2/trunk/c/axiom/include/axiom_mime_parser.h (original)
+++ webservices/axis2/trunk/c/axiom/include/axiom_mime_parser.h Thu Mar 27 02:37:12 2008
@@ -51,6 +51,14 @@
* @{
*/
+ /**
+ * Parse and returns mime parts as a hash map
+ * @param mime_parser the pointer for the mime parser struct
+ * @param env Environment. MUST NOT be NULL.
+ * @param callback_ctx the callback context
+ * @param mime_boundary the MIME boundary
+ * @return mime parts as a hash map
+ */
AXIS2_EXTERN axutil_hash_t *AXIS2_CALL
axiom_mime_parser_parse(
axiom_mime_parser_t * mime_parser,
@@ -59,45 +67,79 @@
void *callback_ctx,
axis2_char_t * mime_boundary);
+ /**
+ * Returns mime parts as a hash map
+ * @param mime_parser the pointer for the mime parser struct
+ * @param env Environment. MUST NOT be NULL.
+ * @return mime parts as a hash map
+ */
AXIS2_EXTERN axutil_hash_t *AXIS2_CALL
-
axiom_mime_parser_get_mime_parts_map(
axiom_mime_parser_t * mime_parser,
const axutil_env_t * env);
- /** Deallocate memory
- * @return status code
+ /**
+ * Deallocate memory. Free the mime parser struct
+ * @param mime_parser the pointer for the mime parser struct
+ * @param env Environment. MUST NOT be NULL.
+ * @return VOID
*/
AXIS2_EXTERN void AXIS2_CALL
axiom_mime_parser_free(
axiom_mime_parser_t * mime_parser,
const axutil_env_t * env);
+ /**
+ * Returns the length of the SOAP Body
+ * @param mime_parser the pointer for the mime parser struct
+ * @param env Environment. MUST NOT be NULL.
+ * @return the length of the SOAP Body
+ */
AXIS2_EXTERN int AXIS2_CALL
axiom_mime_parser_get_soap_body_len(
axiom_mime_parser_t * mime_parser,
const axutil_env_t * env);
+ /**
+ * Get the SOAP Body as a string
+ * @param mime_parser the pointer for the mime parser struct
+ * @param env Environment. MUST NOT be NULL.
+ * @return the SOAP Body as a string
+ */
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
-
axiom_mime_parser_get_soap_body_str(
axiom_mime_parser_t * mime_parser,
const axutil_env_t * env);
/**
- * Creates mime_parser struct
- * @return pointer to newly created mime_parser
- */
+ * Create a mime parser struct
+ * @param env Environment. MUST NOT be NULL.
+ * @return created mime parser
+ */
AXIS2_EXTERN axiom_mime_parser_t *AXIS2_CALL
axiom_mime_parser_create(
const axutil_env_t * env);
+ /**
+ * Set the size of the chink buffer
+ * @param mime_parser the pointer for the mime parser struct
+ * @param env Environment. MUST NOT be NULL.
+ * @param size the size of the chink buffer
+ * @return mime parts as a hash map
+ */
AXIS2_EXTERN void AXIS2_CALL
axiom_mime_parser_set_chunk_buffer_size(
axiom_mime_parser_t * mime_parser,
const axutil_env_t * env,
int size);
+ /**
+ * Set maximum number of chunk buffers
+ * @param mime_parser the pointer for the mime parser struct
+ * @param env Environment. MUST NOT be NULL.
+ * @param num maximum number of chunk buffers
+ * @return VOID
+ */
AXIS2_EXTERN void AXIS2_CALL
axiom_mime_parser_set_max_chunk_buffers(
axiom_mime_parser_t * mime_parser,
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org