NAME¶

GRAM Job Functions -

Functions¶

int globus_gram_client_register_ping (const char *resource_manager_contact, globus_gram_client_attr_t attr, globus_gram_client_nonblocking_func_t register_callback, void *register_callback_arg) Send a ping request to a GRAM service. int globus_gram_client_ping (const char *resource_manager_contact) Send a ping request to a GRAM service. int globus_gram_client_get_jobmanager_version (const char *resource_manager_contact, globus_hashtable_t *extensions) Get version information from a job manager. int globus_gram_client_register_get_jobmanager_version (const char *resource_manager_contact, globus_gram_client_attr_t attr, globus_gram_client_info_callback_func_t info_callback, void *callback_arg) Get version information from a job manager without blocking. int globus_gram_client_register_job_request (const char *resource_manager_contact, const char *description, int job_state_mask, const char *callback_contact, globus_gram_client_attr_t attr, globus_gram_client_nonblocking_func_t register_callback, void *register_callback_arg) Send a job request to a GRAM service. int globus_gram_client_job_request (const char *resource_manager_contact, const char *description, int job_state_mask, const char *callback_contact, char **job_contact) Send a job request to a GRAM service. int globus_gram_client_register_job_request_with_info (const char *resource_manager_contact, const char *description, int job_state_mask, const char *callback_contact, globus_gram_client_attr_t attr, globus_gram_client_info_callback_func_t callback, void *callback_arg) Send a job request to a GRAM service with extensions-aware callback. int globus_gram_client_job_request_with_info (const char *resource_manager_contact, const char *description, int job_state_mask, const char *callback_contact, char **job_contact, globus_gram_client_job_info_t *info) Send a job request to a GRAM service and parse extensions in the response. int globus_gram_client_job_cancel (const char *job_contact) Cancel a GRAM job. int globus_gram_client_register_job_cancel (const char *job_contact, globus_gram_client_attr_t attr, globus_gram_client_nonblocking_func_t register_callback, void *register_callback_arg) Cancel a GRAM job. int globus_gram_client_job_signal (const char *job_contact, globus_gram_protocol_job_signal_t signal, const char *signal_arg, int *job_status, int *failure_code) Send a signal a GRAM job. int globus_gram_client_register_job_signal (const char *job_contact, globus_gram_protocol_job_signal_t signal, const char *signal_arg, globus_gram_client_attr_t attr, globus_gram_client_nonblocking_func_t register_callback, void *register_callback_arg) Send a signal a GRAM job. int globus_gram_client_job_status (const char *job_contact, int *job_status, int *failure_code) Send a status query to a GRAM job. int globus_gram_client_register_job_status (const char *job_contact, globus_gram_client_attr_t attr, globus_gram_client_nonblocking_func_t register_callback, void *register_callback_arg) Send a status query to a GRAM job. int globus_gram_client_register_job_status_with_info (const char *job_contact, globus_gram_client_attr_t attr, globus_gram_client_info_callback_func_t info_callback, void *callback_arg) Send a status query to a GRAM job. int globus_gram_client_job_status_with_info (const char *job_contact, globus_gram_client_job_info_t *info) Send a status query to a GRAM job. int globus_gram_client_job_callback_register (const char *job_contact, int job_state_mask, const char *callback_contact, int *job_status, int *failure_code) Register a new callback contact to be notified for job state changes. int globus_gram_client_job_callback_unregister (const char *job_contact, const char *callback_contact, int *job_status, int *failure_code) Unregister a callback contact to stop job state change notifications. int globus_gram_client_job_refresh_credentials (char *job_contact, gss_cred_id_t creds) Delegate a new credential to a job. int globus_gram_client_register_job_refresh_credentials (char *job_contact, gss_cred_id_t creds, globus_gram_client_attr_t attr, globus_gram_client_nonblocking_func_t register_callback, void *register_callback_arg) Delegate a new credential to a job. int globus_gram_client_register_job_callback_registration (const char *job_contact, int job_state_mask, const char *callback_contact, globus_gram_client_attr_t attr, globus_gram_client_nonblocking_func_t register_callback, void *register_callback_arg) Register a new callback contact to be notified for job state changes. int globus_gram_client_register_job_callback_unregistration (const char *job_contact, const char *callback_contact, globus_gram_client_attr_t attr, globus_gram_client_nonblocking_func_t register_callback, void *register_callback_arg) Unregister a callback contact to stop job state change notifications.

Detailed Description¶

Function Documentation¶

int globus_gram_client_get_jobmanager_version (const char *resource_manager_contact, globus_hashtable_t *extensions)¶

Get version information from a job manager. The globus_gram_client_get_jobmanager_version() function sends a message to a GRAM service which returns information about the job manager version in the value pointed to by the extensions parameter. Note that job managers prior to GT5 do not support the version request and so will return a GLOBUS_GRAM_PROTOCOL_ERROR_HTTP_UNPACK_FAILED error. This function blocks while processing this request. Parameters: Returns: Return values:

int globus_gram_client_job_callback_register (const char *job_contact, intjob_state_mask, const char *callback_contact, int *job_status, int *failure_code)¶

Register a new callback contact to be notified for job state changes. The globus_gram_client_job_callback_register() function contacts a GRAM service managing a job and instructs it to send subsequent job state callbacks to the client listening for callbacks at the contact url named by the callback_contact parameter. This function blocks until the registration operation either completes or exits. Parameters: Returns: Return values:

int globus_gram_client_job_callback_unregister (const char *job_contact, const char *callback_contact, int *job_status, int *failure_code)¶

Unregister a callback contact to stop job state change notifications. The globus_gram_client_job_callback_unregister() function contacts a GRAM service managing a job and instructs it to stop sending job state callbacks to the client listening for callbacks at the contact url named by the callback_contact parameter. This function blocks until the unregistration operation either completes or exits. It is possible that callbacks related to the job arrive at the contact after this function returns depending on network delays. Parameters: Returns: Return values:

int globus_gram_client_job_cancel (const char *job_contact)¶

Cancel a GRAM job. The globus_gram_client_job_cancel() function cancels a GRAM job. Depending on the job's current state, this cancellation may be immediate or require a delay for interacting with the LRM servicing the job. Notification when the job has been successfully canceled will be sent to all client contacts registered for notifications after the cancellation has been completely processed. Unlike, globus_gram_client_register_job_cancel(), globus_gram_client_job_cancel() blocks until the job cancel request has been processed by the service. Parameters: Returns: See Also:

int globus_gram_client_job_refresh_credentials (char *job_contact, gss_cred_id_tcreds)¶

Delegate a new credential to a job. The globus_gram_client_job_refresh_credentials() function sends a 'renew' signal to a GRAM service and then initiates the delegation of a new credential to the job manager and job. This prevents errors that can occur when a credential expires. This function blocks until the delegation has completed or failed. Parameters: Returns: Return values:

int globus_gram_client_job_request (const char *resource_manager_contact, const char *description, intjob_state_mask, const char *callback_contact, char **job_contact)¶

Send a job request to a GRAM service. The globus_gram_client_job_request() function sends a GRAM protocol message to a service to request that it start a job on behalf of the client. Unlike, globus_gram_client_register_job_request(), globus_gram_client_job_request() blocks until the job request has been processed by the service. Parameters: Returns: Return values:

int globus_gram_client_job_request_with_info (const char *resource_manager_contact, const char *description, intjob_state_mask, const char *callback_contact, char **job_contact, globus_gram_client_job_info_t *info)¶

Send a job request to a GRAM service and parse extensions in the response. The globus_gram_client_job_request_with_info() function sends a GRAM protocol message to a service to request that it start a job on behalf of the client. Unlike, globus_gram_client_register_job_request_with_info(), globus_gram_client_job_request_with_info() blocks until the job request has been processed by the service. Parameters: Returns: Return values:

int globus_gram_client_job_signal (const char *job_contact, globus_gram_protocol_job_signal_tsignal, const char *signal_arg, int *job_status, int *failure_code)¶

Send a signal a GRAM job. The globus_gram_client_job_signal() function sends a signal message to a job managed by the GRAM service. Signals consist of a signal number and an optional string argument. The meanings of the signals supported by the GRAM job manager are defined in the GRAM Protocol documentation. Unlike globus_gram_client_register_job_signal(), this function blocks until the signal has been delivered and acknowledged by the GRAM service. Parameters: Returns: Return values: See Also:

int globus_gram_client_job_status (const char *job_contact, int *job_status, int *failure_code)¶

Send a status query to a GRAM job. The globus_gram_client_status() function queries the current status of the job associated with the job contact, returning its current status, as well as the job's failure reason if it has failed in this function's return parameters. This function blocks until the service has responded to the status query. Parameters: Returns: Return values:

int globus_gram_client_job_status_with_info (const char *job_contact, globus_gram_client_job_info_t *info)¶

Send a status query to a GRAM job. The globus_gram_client_status_with_info() function queries the current status of the job associated with the job contact, returning its current status, as well as the job's failure reason if it has failed in this function's return parameters. This function blocks until the service has responded to the status query. Parameters: Returns: Return values:

int globus_gram_client_ping (const char *resource_manager_contact)¶

Send a ping request to a GRAM service. The globus_gram_client_ping() function sends a specially-formatted GRAM protocol message which checks to see if a Gatekeeper is running on a given PORT, and whether that Gatekeeper is configured to support the desired job manager service. This is used for diagnostic purposes. Parameters: Returns: Return values:

int globus_gram_client_register_get_jobmanager_version (const char *resource_manager_contact, globus_gram_client_attr_tattr, globus_gram_client_info_callback_func_tinfo_callback, void *callback_arg)¶

Get version information from a job manager without blocking. The globus_gram_client_register_get_jobmanager_version() function sends a message to a GRAM service which returns information about the job manager version to the function pointed to by the info_callback function. Note that job managers prior to GT5 do not support the version request and so will return a GLOBUS_GRAM_PROTOCOL_ERROR_HTTP_UNPACK_FAILED error. This function blocks while processing this request. Parameters: Returns: Return values:

int globus_gram_client_register_job_callback_registration (const char *job_contact, intjob_state_mask, const char *callback_contact, globus_gram_client_attr_tattr, globus_gram_client_nonblocking_func_tregister_callback, void *register_callback_arg)¶

Register a new callback contact to be notified for job state changes. The globus_gram_client_register_job_callback_registration() function initiates the protocol to contact a GRAM service and request that it send subsequent job state callbacks to the client listening for callbacks at the contact url named by the callback_contact parameter. This function returns as soon as it has validated its parameters and begun sending the GRAM message. When the registration is complete, the function pointed to by register_callback is called. Parameters: Returns: Return values: See Also:

int globus_gram_client_register_job_callback_unregistration (const char *job_contact, const char *callback_contact, globus_gram_client_attr_tattr, globus_gram_client_nonblocking_func_tregister_callback, void *register_callback_arg)¶

Unregister a callback contact to stop job state change notifications. The globus_gram_client_register_job_callback_unregistration() function initiates the protocol to contact a GRAM service and request that it stop sending job state callbacks to the client listening at the contact url named by the callback_contact parameter. This function returns as soon as it has validated its parameters and begun sending the GRAM message. When the unregistration is complete, the function pointed to by register_callback is called. Parameters: Returns: Return values: See Also:

int globus_gram_client_register_job_cancel (const char *job_contact, globus_gram_client_attr_tattr, globus_gram_client_nonblocking_func_tregister_callback, void *register_callback_arg)¶

Cancel a GRAM job. The globus_gram_client_register_job_cancel() function sends a message to a GRAM service to cancel a GRAM job. Depending on the job's current state, this cancellation may be immediate or require a delay for interacting with the LRM servicing the job. In either case, this function returns as soon as it is able to start sending the message. Notification when the job has been successfully canceled will be sent to all client contacts registered for notifications after the cancellation has been completely processed. Parameters: Returns: Return values: See Also:

int globus_gram_client_register_job_refresh_credentials (char *job_contact, gss_cred_id_tcreds, globus_gram_client_attr_tattr, globus_gram_client_nonblocking_func_tregister_callback, void *register_callback_arg)¶

Delegate a new credential to a job. The globus_gram_client_register_job_refresh_credentials() function sends a 'renew' signal to a GRAM service and then initiates the delegation of a new credential to the job manager and job. This prevents errors that can occur when a credential expires. This function returns as soon as it has determined that its parameters are valid and it has begun to send the message to the GRAM service. Parameters: Returns: Return values:

int globus_gram_client_register_job_request (const char *resource_manager_contact, const char *description, intjob_state_mask, const char *callback_contact, globus_gram_client_attr_tattr, globus_gram_client_nonblocking_func_tregister_callback, void *register_callback_arg)¶

Send a job request to a GRAM service. The globus_gram_client_register_job_request() function sends a GRAM protocol message to a service to request that it start a job on behalf of the client. If globus_gram_client_register_job_request() determines that this request could not be processed before contacting the gatekeeper (for example, a malformed resource_manager_contact), it will return an error, and the regiser_callback function will not be called. Otherwise, the success or failure an be determined by the operation_failure_code parameter to the function pointed to by the register_callback parameter. Parameters: Returns: Return values:

int globus_gram_client_register_job_request_with_info (const char *resource_manager_contact, const char *description, intjob_state_mask, const char *callback_contact, globus_gram_client_attr_tattr, globus_gram_client_info_callback_func_tcallback, void *callback_arg)¶

Send a job request to a GRAM service with extensions-aware callback. The globus_gram_client_register_job_request_with_info() function sends a GRAM protocol message to a service to request that it start a job on behalf of the client. If globus_gram_client_register_job_request_with_info() determines that this request could not be processed before contacting the gatekeeper (for example, a malformed resource_manager_contact), it will return an error, and the callback function will not be called. Otherwise, the success or failure an be determined by the operation_failure_code parameter to the function pointed to by the callback parameter. The difference between this function and globus_gram_client_register_job_request() is the function signature of the callback function. Parameters: Returns: Return values:

int globus_gram_client_register_job_signal (const char *job_contact, globus_gram_protocol_job_signal_tsignal, const char *signal_arg, globus_gram_client_attr_tattr, globus_gram_client_nonblocking_func_tregister_callback, void *register_callback_arg)¶

Send a signal a GRAM job. The globus_gram_client_register_job_signal() function sends a signal message to a job managed by the GRAM service. Signals consist of a signal number and an optional string argument. The meanings of the signals supported by the GRAM job manager are defined in the GRAM Protocol documentation. This function returns as soon as it has determined that its parameters are valid and it has begun to send the message to the GRAM service. Parameters: Returns: Return values: See Also:

int globus_gram_client_register_job_status (const char *job_contact, globus_gram_client_attr_tattr, globus_gram_client_nonblocking_func_tregister_callback, void *register_callback_arg)¶

Send a status query to a GRAM job. The globus_gram_client_register_job_status() function initiates a query of the current status of the job associated with the job contact parameter. The job's status and failure code are passed to the function pointed to by the register_callback parameter. This function returns as soon as it has begun requesting the job status. Parameters: Returns: Return values:

int globus_gram_client_register_job_status_with_info (const char *job_contact, globus_gram_client_attr_tattr, globus_gram_client_info_callback_func_tinfo_callback, void *callback_arg)¶

Send a status query to a GRAM job. The globus_gram_client_register_job_status_with_info() function initiates a query of the current status of the job associated with the job contact parameter. Job information is returned via the job_info parameter passed to the function pointed to by the info_callback parameter. This function returns as soon as it has begun requesting the job status. Parameters: Returns: Return values:

int globus_gram_client_register_ping (const char *resource_manager_contact, globus_gram_client_attr_tattr, globus_gram_client_nonblocking_func_tregister_callback, void *register_callback_arg)¶

Send a ping request to a GRAM service. The globus_gram_client_register_ping() function sends a specially-formatted GRAM protocol message which checks to see if a Gatekeeper is running on a given PORT, and whether that Gatekeeper is configured to support the desired job manager service. This is used for diagnostic purposes. If globus_gram_client_register_ping() determines that this request could not be processed before contacting the gatekeeper (for example, a malformed resource_manager_contact), it will return an error, and the regiser_callback function will not be called. Otherwise, the success or failure an be determined by the operation_failure_code parameter to the function pointed to by the register_callback parameter. Parameters: Returns: Return values:

Author¶

Generated automatically by Doxygen for globus_gram_client from the source code.