.TH "globus_gram_client.h" 3 "Mon Oct 5 2015" "Version 13.10" "globus_gram_client" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_gram_client.h \- 
.PP
GRAM Client API\&.  

.SH SYNOPSIS
.br
.PP
\fC#include 'globus_common\&.h'\fP
.br
\fC#include 'globus_io\&.h'\fP
.br
\fC#include 'globus_gram_protocol_constants\&.h'\fP
.br

.SS "Data Structures"

.in +1c
.ti -1c
.RI "struct \fBglobus_gram_client_job_info_s\fP"
.br
.RI "\fIExtensible job information structure\&. \fP"
.in -1c
.SS "Macros"

.in +1c
.ti -1c
.RI "#define \fBGLOBUS_GRAM_CLIENT_NO_ATTR\fP"
.br
.RI "\fIDefault GRAM client operation attribute\&. \fP"
.in -1c
.SS "Typedefs"

.in +1c
.ti -1c
.RI "typedef void(* \fBglobus_gram_client_callback_func_t\fP )(void *user_callback_arg, char *job_contact, int state, int errorcode)"
.br
.RI "\fISignature for GRAM state notification callback functions\&. \fP"
.ti -1c
.RI "typedef struct 
.br
\fBglobus_gram_client_job_info_s\fP \fBglobus_gram_client_job_info_t\fP"
.br
.RI "\fIExtensible job information structure\&. \fP"
.ti -1c
.RI "typedef void(* \fBglobus_gram_client_info_callback_func_t\fP )(void *user_callback_arg, const char *job_contact, \fBglobus_gram_client_job_info_t\fP *job_info)"
.br
.RI "\fISignature for GRAM state notification callback functions with extension support\&. \fP"
.ti -1c
.RI "typedef void * \fBglobus_gram_client_attr_t\fP"
.br
.RI "\fIGRAM client operation attribute\&. \fP"
.ti -1c
.RI "typedef void(* \fBglobus_gram_client_nonblocking_func_t\fP )(void *user_callback_arg, globus_gram_protocol_error_t operation_failure_code, const char *job_contact, globus_gram_protocol_job_state_t job_state, globus_gram_protocol_error_t job_failure_code)"
.br
.RI "\fISignature for callbacks signalling completion of non-blocking GRAM requests\&. \fP"
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "int \fBglobus_gram_client_callback_allow\fP (\fBglobus_gram_client_callback_func_t\fP callback_func, void *user_callback_arg, char **callback_contact)"
.br
.RI "\fIBegin listening for job state change callbacks\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_info_callback_allow\fP (\fBglobus_gram_client_info_callback_func_t\fP callback_func, void *user_callback_arg, char **callback_contact)"
.br
.RI "\fIBegin listening for job state change callbacks\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_register_job_request\fP (const char *resource_manager_contact, const char *description, int job_state_mask, const char *callback_contact, \fBglobus_gram_client_attr_t\fP attr, \fBglobus_gram_client_nonblocking_func_t\fP register_callback, void *register_callback_arg)"
.br
.RI "\fISend a job request to a GRAM service\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_job_request\fP (const char *resource_manager_contact, const char *description, int job_state_mask, const char *callback_contact, char **job_contact)"
.br
.RI "\fISend a job request to a GRAM service\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_register_job_request_with_info\fP (const char *resource_manager_contact, const char *description, int job_state_mask, const char *callback_contact, \fBglobus_gram_client_attr_t\fP attr, \fBglobus_gram_client_info_callback_func_t\fP callback, void *callback_arg)"
.br
.RI "\fISend a job request to a GRAM service with extensions-aware callback\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_job_request_with_info\fP (const char *resource_manager_contact, const char *description, int job_state_mask, const char *callback_contact, char **job_contact, \fBglobus_gram_client_job_info_t\fP *info)"
.br
.RI "\fISend a job request to a GRAM service and parse extensions in the response\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_register_job_cancel\fP (const char *job_contact, \fBglobus_gram_client_attr_t\fP attr, \fBglobus_gram_client_nonblocking_func_t\fP register_callback, void *register_callback_arg)"
.br
.RI "\fICancel a GRAM job\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_job_cancel\fP (const char *job_contact)"
.br
.RI "\fICancel a GRAM job\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_register_job_status\fP (const char *job_contact, \fBglobus_gram_client_attr_t\fP attr, \fBglobus_gram_client_nonblocking_func_t\fP register_callback, void *register_callback_arg)"
.br
.RI "\fISend a status query to a GRAM job\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_register_job_status_with_info\fP (const char *job_contact, \fBglobus_gram_client_attr_t\fP attr, \fBglobus_gram_client_info_callback_func_t\fP info_callback, void *callback_arg)"
.br
.RI "\fISend a status query to a GRAM job\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_job_refresh_credentials\fP (char *job_contact, gss_cred_id_t creds)"
.br
.RI "\fIDelegate a new credential to a job\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_register_job_refresh_credentials\fP (char *job_contact, gss_cred_id_t creds, \fBglobus_gram_client_attr_t\fP attr, \fBglobus_gram_client_nonblocking_func_t\fP register_callback, void *register_callback_arg)"
.br
.RI "\fIDelegate a new credential to a job\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_job_status\fP (const char *job_contact, int *job_status, int *failure_code)"
.br
.RI "\fISend a status query to a GRAM job\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_job_status_with_info\fP (const char *job_contact, \fBglobus_gram_client_job_info_t\fP *job_info)"
.br
.RI "\fISend a status query to a GRAM job\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_register_job_signal\fP (const char *job_contact, globus_gram_protocol_job_signal_t signal, const char *signal_arg, \fBglobus_gram_client_attr_t\fP attr, \fBglobus_gram_client_nonblocking_func_t\fP register_callback, void *register_callback_arg)"
.br
.RI "\fISend a signal a GRAM job\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_job_signal\fP (const char *job_contact, globus_gram_protocol_job_signal_t signal, const char *signal_arg, int *job_status, int *failure_code)"
.br
.RI "\fISend a signal a GRAM job\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_register_job_callback_registration\fP (const char *job_contact, int job_state_mask, const char *callback_contact, \fBglobus_gram_client_attr_t\fP attr, \fBglobus_gram_client_nonblocking_func_t\fP register_callback, void *register_callback_arg)"
.br
.RI "\fIRegister a new callback contact to be notified for job state changes\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_job_callback_register\fP (const char *job_contact, int job_state_mask, const char *callback_contact, int *job_status, int *failure_code)"
.br
.RI "\fIRegister a new callback contact to be notified for job state changes\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_register_job_callback_unregistration\fP (const char *job_contact, const char *callback_contact, \fBglobus_gram_client_attr_t\fP attr, \fBglobus_gram_client_nonblocking_func_t\fP register_callback, void *register_callback_arg)"
.br
.RI "\fIUnregister a callback contact to stop job state change notifications\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_job_callback_unregister\fP (const char *job_contact, const char *callback_contact, int *job_status, int *failure_code)"
.br
.RI "\fIUnregister a callback contact to stop job state change notifications\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_callback_disallow\fP (char *callback_contact)"
.br
.RI "\fIStop listening for job state change callbacks\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_job_contact_free\fP (char *job_contact)"
.br
.RI "\fIFree a job contact string\&. \fP"
.ti -1c
.RI "const char * \fBglobus_gram_client_error_string\fP (int error_code)"
.br
.RI "\fIGet a description of a a GRAM error code\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_version\fP (void)"
.br
.RI "\fIReturn GRAM protocol version\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_set_credentials\fP (gss_cred_id_t new_credentials)"
.br
.RI "\fISet the default GRAM credential\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_ping\fP (const char *resource_manager_contact)"
.br
.RI "\fISend a ping request to a GRAM service\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_register_ping\fP (const char *resource_manager_contact, \fBglobus_gram_client_attr_t\fP attr, \fBglobus_gram_client_nonblocking_func_t\fP register_callback, void *register_callback_arg)"
.br
.RI "\fISend a ping request to a GRAM service\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_get_jobmanager_version\fP (const char *resource_manager_contact, globus_hashtable_t *extensions)"
.br
.RI "\fIGet version information from a job manager\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_register_get_jobmanager_version\fP (const char *resource_manager_contact, \fBglobus_gram_client_attr_t\fP attr, \fBglobus_gram_client_info_callback_func_t\fP info_callback, void *callback_arg)"
.br
.RI "\fIGet version information from a job manager without blocking\&. \fP"
.ti -1c
.RI "void \fBglobus_gram_client_debug\fP (void)"
.br
.RI "\fIEnable GRAM debugging\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_attr_init\fP (\fBglobus_gram_client_attr_t\fP *attr)"
.br
.RI "\fIInitialize a GRAM client attribute\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_attr_destroy\fP (\fBglobus_gram_client_attr_t\fP *attr)"
.br
.RI "\fIDestroy a GRAM client attribute\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_attr_set_credential\fP (\fBglobus_gram_client_attr_t\fP attr, gss_cred_id_t credential)"
.br
.RI "\fISet a GRAM client attribute's security credential\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_attr_get_credential\fP (\fBglobus_gram_client_attr_t\fP attr, gss_cred_id_t *credential)"
.br
.RI "\fIGet a GRAM client attribute's security credential\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_attr_set_delegation_mode\fP (\fBglobus_gram_client_attr_t\fP attr, globus_io_secure_delegation_mode_t mode)"
.br
.RI "\fISet a GRAM client attribute's delegation mode\&. \fP"
.ti -1c
.RI "int \fBglobus_gram_client_attr_get_delegation_mode\fP (\fBglobus_gram_client_attr_t\fP attr, globus_io_secure_delegation_mode_t *mode)"
.br
.RI "\fIGet a GRAM client attribute's security credential\&. \fP"
.ti -1c
.RI "void \fBglobus_gram_client_job_info_destroy\fP (\fBglobus_gram_client_job_info_t\fP *info)"
.br
.RI "\fIFree memory associated with a globus_gram_client_job_info_t structure\&. \fP"
.in -1c
.SH "Detailed Description"
.PP 
GRAM Client API\&. 

This header file contains the exported client interface of the Resource Allocation Management System\&. 
.SH "Author"
.PP 
Generated automatically by Doxygen for globus_gram_client from the source code\&.