Client Handle Functions and Types
[RendezvousFactoryService Client Bindings]

Collaboration diagram for Client Handle Functions and Types:

Typedefs

• typedef globus_soap_client_handle_t RendezvousFactoryService_client_handle_t

Functions

• globus_result_t RendezvousFactoryService_client_init (RendezvousFactoryService_client_handle_t *handle, globus_soap_message_attr_t attrs, globus_handler_chain_t chain)
• void RendezvousFactoryService_client_destroy (RendezvousFactoryService_client_handle_t handle)
• globus_result_t RendezvousFactoryService_client_operation_cancel (RendezvousFactoryService_client_handle_t handle)
• globus_result_t RendezvousFactoryService_client_get_handler_chain (RendezvousFactoryService_client_handle_t handle, globus_handler_chain_t *handlers)
• globus_result_t RendezvousFactoryService_client_attr_set (RendezvousFactoryService_client_handle_t handle, const char *prop_name, globus_soap_message_attr_copy_func_t copy, globus_soap_message_attr_destroy_func_t destroy, void *value)
• void * RendezvousFactoryService_client_attr_remove (RendezvousFactoryService_client_handle_t handle, const char *prop_name)
• void * RendezvousFactoryService_client_attr_get (RendezvousFactoryService_client_handle_t handle, const char *prop_name)

---

Typedef Documentation

typedef globus_soap_client_handle_t RendezvousFactoryService_client_handle_t

Handle for the RendezvousFactoryService client.

A handle must be created by the client application before calling any SOAP operation. Only one operation may be in progress per handle at any given time.

See also:

RendezvousFactoryService_client_init(), RendezvousFactoryService_client_destroy()

---

Function Documentation

globus_result_t RendezvousFactoryService_client_init	(	RendezvousFactoryService_client_handle_t *	handle,
		globus_soap_message_attr_t	attrs,
		globus_handler_chain_t	chain
	)

Initialize a client handle

Initialize new client handle state for use with operation-related functions.

Parameters:

	handle	Pointer to the handle to initialize.
	attrs	Default attributes to use with this handle. This parameter may be NULL. Certain atttributes may cause different handlers to be pushed onto the default handler chain for this client.
	handlers	Handle chain to use with this handle. This parameter may be NULL. Typically the default handler chain used by this function is sufficient.

void RendezvousFactoryService_client_destroy

(

RendezvousFactoryService_client_handle_t

handle

)

Destroy a client handle

Destroys the state associated with this client handle.

Parameters:

handle

Handle to destroy.

globus_result_t RendezvousFactoryService_client_operation_cancel

(

RendezvousFactoryService_client_handle_t

handle

)

Cancel the current operation associated with this handle.

Parameters:

handle

Handle which has the operation to cancel.

globus_result_t RendezvousFactoryService_client_get_handler_chain	(	RendezvousFactoryService_client_handle_t	handle,
		globus_handler_chain_t *	handlers
	)

Get handle's handler chain

The handler chain contains information about which handlers (typically SOAP header processors) will be invoked when a request is sent or a response is received.

Applications which want to add custom handlers at run time may wish to push additional handlers onto this chain.

Parameters:

	handle	The handle to query.
	handlers	A pointer to a handler chain which will be set to the handle's chain.

globus_result_t RendezvousFactoryService_client_attr_set	(	RendezvousFactoryService_client_handle_t	handle,
		const char *	prop_name,
		globus_soap_message_attr_copy_func_t	copy,
		globus_soap_message_attr_destroy_func_t	destroy,
		void *	value
	)

Set a SOAP attribute on a handle

Set a SOAP attribute on a handle.

This can be used to change how the SOAP engine will process operations sent via this handle.

Parameters:

	handle	The handle to modify.
	prop_name	The attribute name. This should be one of the GLOBUS_SOAP_MESSAGE_*_KEY values.
	copy	A function to copy the value. This is required if value will go out of scope.
	destroy	A function to destroy a copy of the value. Required if copy is set.
	value	The new value of the attribute.

void* RendezvousFactoryService_client_attr_remove	(	RendezvousFactoryService_client_handle_t	handle,
		const char *	prop_name
	)

Remove a SOAP attribute from a handle

Remove a SOAP attribute on a handle.

This can be used to change how the SOAP engine will process operations sent via this handle.

Parameters:

	handle	The handle to modify.
	prop_name	The attribute name. This should be one of the GLOBUS_SOAP_MESSAGE_*_KEY values.

Returns:

This function returns the current value of the attribute.

void* RendezvousFactoryService_client_attr_get	(	RendezvousFactoryService_client_handle_t	handle,
		const char *	prop_name
	)

Get a SOAP attribute from a handle

Get the current value of a SOAP attribute set on a handle.

Parameters:

	handle	The handle to query.
	prop_name	The attribute name. This should be one of the GLOBUS_SOAP_MESSAGE_*_KEY values.

Returns:

This function returns the current value of the attribute.