Main Page | Modules

Transaction Handle
[NEES NTCP Types]

Functions

Detailed Description

This section describes the functions which may be executed to access the values of a transaction handle and to indicate completion of a transaction.

Function Documentation

int nees_ntcp_transaction_handle_get_name (  const nees_ntcp_transaction_handle_t  handle,
char **  result_name
) 
 

Get the name of a transaction.

Parameters:
handle A transaction handle which the plugin is interested in the name of. This handle must be one obtained by the plugin as passed to its propose or execute functions, subject to the scoping rules described in those function pointer descriptions.
result_name A pointer to a char *. This function will modify the value pointed to by this to be a copy of the transaction's name. The plugin instance must free this copy of the name using free().
Returns:
If the plugin is valid and the name pointer is valid, then this function returns zero; otherwise, a non-zero error code is returned and result_name will be unmodified.
Return values:
NEES_NTCP_CONTROL_PLUGIN_OK The name was copied successfully.
NEES_NTCP_CONTROL_PLUGIN_INVALID_PARAMETER One of the parameters to this function was null.
NEES_NTCP_CONTROL_PLUGIN_OUT_OF_MEMORY There is not enough free memory to copy the transaction's name into result_name

int nees_ntcp_transaction_handle_get_requested_control_points (  const nees_ntcp_transaction_handle_t  handle,
nees_ntcp_control_point_t **  result_points,
size_t *  result_number_of_points
) 
 

Get the value of the transaction's control points.

Parameters:
handle A transaction handle which the plugin is interested in the name of. This handle must be one obtained by the plugin as passed to its propose or execute functions, subject to the scoping rules described in those function pointer descriptions.
result_points A pointer to a nees_ntcp_control_point_t array. This function will modify the value pointed to by this to point to a copy of the transaction's control points. The plugin must free this array by calling nees_ntcp_control_point_array_free()
result_number_of_points A pointer to a size_t. This function will modify the value pointed to by this to be the number of elements in the new points array.
Returns:
If the parameters to this function are valid and it is able to copy the control points, then this function returns zero; otherwise, it returns a non-zero error code.
Return values:
NEES_NTCP_CONTROL_PLUGIN_OK The control points were copied successfully.
NEES_NTCP_CONTROL_PLUGIN_INVALID_PARAMETER One of the parameters to this function was null.
NEES_NTCP_CONTROL_PLUGIN_OUT_OF_MEMORY There is not enough free memory to copy the transaction's control points into result_points.

int nees_ntcp_transaction_handle_mark_terminated (  nees_ntcp_transaction_handle_t  handle  ) 
 

Indicate that transaction execution finished unsuccessfully.

Parameters:
handle A transaction handle which the plugin is terminating. This handle must be one obtained by the plugin as passed to its execute function. After this function returns, the plugin must not access the handle.
Returns:
If the handle is valid and the transaction state was set as terminated, then this function returns zero; otherwise a non-zero error code is returned.
Return values:
NEES_NTCP_CONTROL_PLUGIN_OK The transaction termination was completed.
NEES_NTCP_CONTROL_PLUGIN_INVALID_PARAMETER One of the parameters to this function was null.
NEES_NTCP_CONTROL_PLUGIN_OUT_OF_MEMORY There is not enough free memory to copy the transaction's control points into result_points.
NEES_NTCP_CONTROL_PLUGIN_JVM_ERROR Internal error accessing the Java Virtual Machine.
NEES_NTCP_CONTROL_PLUGIN_CLASS_FORMAT_ERROR,Internal error loading a Java class. Java class file corrupted.
NEES_NTCP_CONTROL_PLUGIN_CLASS_CIRCULARITY_ERROR Internal error loading a Java class. A Java class file contains a broken object implementation.
NEES_NTCP_CONTROL_PLUGIN_CLASS_NOT_FOUND Internal error loading a Java class. Java CLASSPATH not set properly.
NEES_NTCP_CONTROL_PLUGIN_EXCEPTION_IN_INITIALIZER Internal erorr loading a Java class.
NEES_NTCP_CONTROL_PLUGIN_NO_SUCH_METHOD Internal error locating a Java method. Likely caused by a Java interface change.
NEES_NTCP_CONTROL_PLUGIN_NO_SUCH_FIELD Internal error locating a Java field. Likely caused by a Java interface change.
NEES_NTCP_CONTROL_PLUGIN_JAVA_EXCEPTION A Java method called while handling this threw some other exception.

int nees_ntcp_transaction_handle_set_resulting_control_points (  nees_ntcp_transaction_handle_t  handle,
nees_ntcp_control_point_t *  control_points,
size_t  control_points_length
) 
 

Indicate that transaction execution finished successfully, setting the resulting value of control points of the transaction.

Parameters:
handle A transaction handle which the plugin is terminating. This handle must be one obtained by the plugin as passed to its execute function. After this function returns, the plugin must not access the handle.
control_points An array of control points which the plugin has allocated by calling nees_ntcp_control_point_array_alloc(). The values of the control points are the results of the transaction. The individual points in the array should represent measured or computed values of the control points at the time that execution completed. The plugin is responsible for freeing this array.
control_points_length The number of control points in the control_points array.
Returns:
If the parameters to this function are valid and the transaction state was set as terminated, then this function returns zero; otherwise a non-zero error code is returned.
Return values:
NEES_NTCP_CONTROL_PLUGIN_OK The transaction termination was completed.
NEES_NTCP_CONTROL_PLUGIN_INVALID_PARAMETER One of the parameters to this function was null.
NEES_NTCP_CONTROL_PLUGIN_OUT_OF_MEMORY There is not enough free memory to copy the transaction's control points into result_points.
NEES_NTCP_CONTROL_PLUGIN_JVM_ERROR Internal error accessing the Java Virtual Machine.
NEES_NTCP_CONTROL_PLUGIN_CLASS_FORMAT_ERROR,Internal error loading a Java class. Java class file corrupted.
NEES_NTCP_CONTROL_PLUGIN_CLASS_CIRCULARITY_ERROR Internal error loading a Java class. A Java class file contains a broken object implementation.
NEES_NTCP_CONTROL_PLUGIN_CLASS_NOT_FOUND Internal error loading a Java class. Java CLASSPATH not set properly.
NEES_NTCP_CONTROL_PLUGIN_EXCEPTION_IN_INITIALIZER Internal erorr loading a Java class.
NEES_NTCP_CONTROL_PLUGIN_NO_SUCH_METHOD Internal error locating a Java method. Likely caused by a Java interface change.
NEES_NTCP_CONTROL_PLUGIN_NO_SUCH_FIELD Internal error locating a Java field. Likely caused by a Java interface change.
NEES_NTCP_CONTROL_PLUGIN_JAVA_EXCEPTION A Java method called while handling this threw some other exception.

about globus | grid research | globus toolkit | software development

Comments? webmaster@globus.org