SOAP Transport

Functions used to read, write, open, and close XIO handles used internally by the SOAP engine. More...

Functions

Detailed Description

Functions used to read, write, open, and close XIO handles used internally by the SOAP engine.

Function Documentation

globus_result_t globus_soap_message_setup_writer ( globus_soap_message_handle_t  message  ) 

Reset the I/O handle associate with a SOAP handle to prepare for writing

Used by the SOAP processor to prepare for writing a SOAP request or response.

Clears the buffers used by the transport layer and sets the buffering driver to be ready for handling writes.

Parameters:
message SOAP message handle to prepare.
Return values:
GLOBUS_SUCCESS SOAP message handle setup successfully.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_NULL_PARAM The message parameter is NULL.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_FAILED_TRANSPORT Unable to set up the handle to write.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_INIT_FAILED Unable to set up the handle to write.

globus_result_t globus_soap_message_register_open ( globus_soap_message_handle_t  handle,
char *  endpoint,
globus_soap_message_callback_func_t  callback,
void *  args 
)

Open a connect to a SOAP service

Connect to the service hosted at endpoint so that a SOAP request message can be sent to it.

When the connection is established, the function pointed to by callback will be called.

Parameters:
handle SOAP message handle to open the connection on .
endpoint Endpoint describing where the service is located.
callback Pointer to function to call after the open has completed.
args Parameter to the callback function.
Return values:
GLOBUS_SUCCESS Handle open begun successfully.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_NULL_PARAM One of handle, endpoint, or callback is NULL.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_OUT_OF_MEMORY Insufficient memory to open the SOAP connection.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_FAILED_TRANSPORT SOAP message handle already opened or error opening the handle.

globus_bool_t globus_soap_message_is_cancelled ( globus_soap_message_handle_t  handle  ) 

Predicate to determine if the operation on this handle has been cancelled.

Parameters:
handle SOAP message handle to query.
Return values:
GLOBUS_TRUE The current I/O operation has been cancelled.
GLOBUS_FALSE The current I/O operation has not been cancelled.

globus_result_t globus_soap_message_cancel_message ( globus_soap_message_handle_t  handle  ) 

Cancel the current I/O operation on the SOAP message handle.

Parameters:
handle SOAP message handle to cancel the operation on.
Return values:
GLOBUS_SUCCESS Handle operations cancelled successfully.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_NULL_PARAM The handle parameter is NULL.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_FAILED_TRANSPORT Unable to cancel the operation.

globus_result_t globus_soap_message_register_write_request ( globus_soap_message_handle_t  handle,
globus_soap_message_callback_func_t  callback,
void *  args,
globus_bool_t  response 
)

Write the operation request to the service endpoint

Writes the serialized SOAP message associated with a SOAP handle to the service endpoint that the handle is connected to.

This flushes all buffers that the handle is holding. When the message has been sent, the function pointed to by callback will be invoked.

Parameters:
handle SOAP message handle to write the request on.
callback Pointer to a function to be called when the write has completed.
args Parameter to the callback function.
response Flag indicating whether the caller expects a SOAP response.
Return values:
GLOBUS_SUCCESS Write begun successfully.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_NULL_PARAM One of handle or callback is NULL.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_OUT_OF_MEMORY Insufficient memory to handle the write operation.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_FAILED_TRANSPORT Unable to flush the buffers or write the message.

globus_result_t globus_soap_message_register_write_response ( globus_soap_message_handle_t  handle,
globus_soap_message_callback_func_t  callback,
void *  args 
)

Write an operation response

Writes the serialized SOAP message associated with a SOAP handle to respond to an operation request.

This flushes all buffers that the handle is holding. When the response has been sent, the function pointed to by callback will be invoked.

Parameters:
handle SOAP message handle to write the request on.
callback Pointer to a function to be called when the write has completed.
args Parameter to the callback function.
Return values:
GLOBUS_SUCCESS Write begun successfully.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_NULL_PARAM One of handle or callback is NULL.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_OUT_OF_MEMORY Insufficient memory to handle the write operation.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_FAILED_TRANSPORT Unable to flush the buffers or write the message.

globus_result_t globus_soap_message_register_read_response ( globus_soap_message_handle_t  handle,
globus_soap_message_callback_func_t  callback,
void *  args 
)

Register a read of an operation response

Registers a new read with the I/O system to receive a SOAP response message.

The callback function will be invoked when the message is ready.

Parameters:
handle SOAP message handle to read the response from.
callback Pointer to a function to be called when the write has completed.
args Parameter to the callback function.
Return values:
GLOBUS_SUCCESS Read begun successfully.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_NULL_PARAM One of handle or callback is NULL.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_OUT_OF_MEMORY Insufficient memory to handle the read operation.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_FAILED_TRANSPORT Unable to register the read operation.

globus_result_t globus_soap_message_register_read_request ( globus_soap_message_handle_t  handle,
globus_soap_message_callback_func_t  callback,
void *  args 
)

Register a read of an operation response

Registers a new read with the I/O system to receive a SOAP request message.

The callback function will be invoked when the message is ready.

Parameters:
handle SOAP message handle to read the request from.
callback Pointer to a function to be called when the write has completed.
args Parameter to the callback function.
Return values:
GLOBUS_SUCCESS Read begun successfully.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_NULL_PARAM One of handle or callback is NULL.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_OUT_OF_MEMORY Insufficient memory to handle the read operation.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_FAILED_TRANSPORT Unable to register the read operation.

globus_result_t globus_soap_message_register_close ( globus_soap_message_handle_t  handle,
globus_soap_message_callback_func_t  callback,
void *  args 
)

Close the I/O handle associated with a SOAP operation

Registers a close of the I/O handle which has been used to process a SOAP request or response.

The callback function will be invoked when the handle is closed.

Parameters:
handle SOAP message handle to read the request from.
callback Pointer to a function to be called when the write has completed.
args Parameter to the callback function.
Return values:
GLOBUS_SUCCESS Read begun successfully.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_NULL_PARAM One of handle or callback is NULL.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_OUT_OF_MEMORY Insufficient memory to handle the read operation.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_FAILED_TRANSPORT Unable to register the read operation.

about globus | grid research | globus toolkit | software development

Comments? webmaster@globus.org