axiom_soap_envelope_ops Struct Reference
[soap envelope]

soap_envelope operations struct ops Encapsulator struct of axiom_soap body More...

#include <axiom_soap_envelope.h>

List of all members.

Public Attributes

axiom_soap_header *(* get_header )(axiom_soap_envelope_t *envelope, const axis2_env_t *env)
axiom_soap_body *(* get_body )(axiom_soap_envelope_t *envelope, const axis2_env_t *env)
axis2_status_t(* serialize )(axiom_soap_envelope_t *envelope, const axis2_env_t *env, axiom_output_t *om_output, axis2_bool_t cache)
axis2_status_t(* free_fn )(axiom_soap_envelope_t *envelope, const axis2_env_t *env)
axiom_node_t *(* get_base_node )(axiom_soap_envelope_t *envelope, const axis2_env_t *env)
int(* get_soap_version )(axiom_soap_envelope_t *envelope, const axis2_env_t *env)
axiom_namespace_t *(* get_namespace )(axiom_soap_envelope_t *envelope, const axis2_env_t *env)
axis2_status_t(* set_soap_version )(axiom_soap_envelope_t *envelope, const axis2_env_t *env, int soap_version)


Detailed Description

soap_envelope operations struct ops Encapsulator struct of axiom_soap body


Member Data Documentation

axis2_status_t( * axiom_soap_envelope_ops::free_fn)(axiom_soap_envelope_t *envelope, const axis2_env_t *env)

Free function, This function deallocate all the resources associated with the soap_envelope IT frees it's soap body and soap headers as well as the underlying om node tree by calling AXIOM_NODE_FREE_TREE function

Parameters:
envelope soap_envelope
env environment
Returns:
status code AXIS2_SUCCESS on success , AXIS2_FAILURE otherwise

axiom_node_t*( * axiom_soap_envelope_ops::get_base_node)(axiom_soap_envelope_t *envelope, const axis2_env_t *env)

returns the om_node associated with this soap envelope

Parameters:
envelope soap_envelope
env environment
Returns:
axiom_node_t pointer

struct axiom_soap_body*( * axiom_soap_envelope_ops::get_body)(axiom_soap_envelope_t *envelope, const axis2_env_t *env)

Returns the soap body associated with this soap envelope

Parameters:
envelope soap_envelope
env environment
Returns:
soap_body

struct axiom_soap_header*( * axiom_soap_envelope_ops::get_header)(axiom_soap_envelope_t *envelope, const axis2_env_t *env)

gets the soap header of this soap envelope

Parameters:
envelope soap envelope
env environment must not be null
Returns:
soap header null it no header is present

axiom_namespace_t*( * axiom_soap_envelope_ops::get_namespace)(axiom_soap_envelope_t *envelope, const axis2_env_t *env)

return the soap envelope namespace

Parameters:
envelope 
env 
Returns:
axiom_namespace_t

int( * axiom_soap_envelope_ops::get_soap_version)(axiom_soap_envelope_t *envelope, const axis2_env_t *env)

returns the soap version of this soap envelope

Parameters:
envelope soap_envelope
env environment must not be null
Returns:
soap_version AXIOM_SOAP12 or AXIOM_SOAP11

axis2_status_t( * axiom_soap_envelope_ops::serialize)(axiom_soap_envelope_t *envelope, const axis2_env_t *env, axiom_output_t *om_output, axis2_bool_t cache)

serialize function , serialize the soap envelope IF the soap version it set to soap11 the soap fault part is converted to soap11 fault even is the underlying soap fault is of soap12 type

Parameters:
envelope soap envelope
env environment must not be null
om_output 
cache whether caching is enabled or not
Returns:
status code , AXIS2_SUCCESS if success , AXIS2_FAILURE otherwise


The documentation for this struct was generated from the following file:
Generated on Tue Oct 3 18:21:18 2006 for Axis2/C by  doxygen 1.4.7