SOAP Message Fault handling

SOAP messages may contain fault information indicating that an error occurred, either processing a message or handling an operation. More...

Functions

• globus_result_t globus_soap_message_fault_init (globus_soap_message_fault_t *fault)
• void globus_soap_message_fault_destroy (void *f)
• globus_soap_message_fault_t globus_soap_message_fault_get (globus_object_t *obj)

---

Detailed Description

SOAP messages may contain fault information indicating that an error occurred, either processing a message or handling an operation.

These may be converted to and from globus_object_t-style errors.

---

Function Documentation

globus_result_t globus_soap_message_fault_init

(

globus_soap_message_fault_t *

fault

)

Initialize a new fault

Allocates a new fault structure and sets its initial value.

Parameters:

fault

Fault to initialize. After returning, this will be set to point to a new fault structure. The caller is responsible for destroying this fault.

Return values:

	GLOBUS_SUCCESS	Fault initialized successfully.
	GLOBUS_SOAP_MESSAGE_ERROR_TYPE_NULL_PARAM	The fault parameter is NULL.
	GLOBUS_SOAP_MESSAGE_ERROR_TYPE_OUT_OF_MEMORY	Insufficient memory to allocate the new fault structure.

void globus_soap_message_fault_destroy

(

void *

f

)

Destroy a fault.

Parameters:

f

Pointer to the fault to destroy, cast to a void *.

globus_soap_message_fault_t globus_soap_message_fault_get

(

globus_object_t *

obj

)

Extracts a SOAP from a globus_object_t

Removes the first globus_soap_message_fault_t instance data it finds in the causality chain of obj and returns it.

The obj is modified to no longer refer to the returned value. The caller is responsible for destroying the returned globus_soap_message_fault_t.

Parameters:

obj

Object to search for a SOAP fault.

Returns:

If obj is a GLOBUS_SOAP_FAULT_TYPE object or caused by one, then the first globus_soap_message_fault_t instace found in the causality chain is returned. Otherwise, NULL is returned.