.TH "globus_gram_client" 3 "Version 14.6" "globus_gram_client" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_gram_client \- GRAM Client API
.PP
 \- GRAM Client API\&.  

.SH SYNOPSIS
.br
.PP
.SS "Modules"

.in +1c
.ti -1c
.RI "\fBJob state callbacks\fP"
.br
.RI "Job state callbacks\&. "
.ti -1c
.RI "\fBGRAM Job Functions\fP"
.br
.RI "GRAM Job Functions\&. "
.ti -1c
.RI "\fBGRAM Client Attribute Functions\fP"
.br
.RI "GRAM Client Attribute Functions\&. "
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "void \fBglobus_gram_client_debug\fP (void)"
.br
.RI "Enable GRAM debugging\&. "
.ti -1c
.RI "int \fBglobus_gram_client_version\fP (void)"
.br
.RI "Return GRAM protocol version\&. "
.ti -1c
.RI "int \fBglobus_gram_client_set_credentials\fP (gss_cred_id_t new_credentials)"
.br
.RI "Set the default GRAM credential\&. "
.ti -1c
.RI "const char * \fBglobus_gram_client_error_string\fP (int error_code)"
.br
.RI "Get a description of a a GRAM error code\&. "
.ti -1c
.RI "int \fBglobus_gram_client_job_contact_free\fP (char *job_contact)"
.br
.RI "Free a job contact string\&. "
.ti -1c
.RI "void \fBglobus_gram_client_job_info_destroy\fP (\fBglobus_gram_client_job_info_t\fP *info)"
.br
.RI "Free memory associated with a globus_gram_client_job_info_t structure\&. "
.in -1c
.SH "Detailed Description"
.PP 
GRAM Client API\&. 

The resource management API provides function for requesting that a job be started or terminated, as well as for requesting information about the status of a job\&. 
.SH "Function Documentation"
.PP 
.SS "void globus_gram_client_debug (void)"

.PP
Enable GRAM debugging\&. The \fBglobus_gram_client_debug()\fP function enables the displaying of internal GRAM debug messages to standard output\&. Most of the information printed by this debugging system is related to errors that occur during GRAM Client API functions\&. The messages printed to standard output are not structured in any way\&. 
.SS "const char * globus_gram_client_error_string (int error_code)"

.PP
Get a description of a a GRAM error code\&. The \fBglobus_gram_client_error_string()\fP function takes a GRAM error code value and returns the associated error code string\&. The string is statically allocated by the Globus GRAM Client library and should not be modified or freed\&. The string is intended to complete a sentence of the form '[operation] failed because \&.\&.\&.'
.PP
\fBParameters\fP
.RS 4
\fIerror_code\fP The error code to translate into a string\&.
.RE
.PP
\fBReturns\fP
.RS 4
The \fBglobus_gram_client_error_string()\fP function returns a static string containing an explanation of the error\&. 
.RE
.PP

.SS "int globus_gram_client_job_contact_free (char * job_contact)"

.PP
Free a job contact string\&. The \fBglobus_gram_client_job_contact_free()\fP function frees a job contact string that was allocated by a call to one of the functions in the \fBglobus_gram_client_job_request()\fP family\&. The free() function can be used in place of this function\&. After this function returns, the string pointed to by the \fIjob_contact\fP parameter has an undefined value\&.
.PP
\fBParameters\fP
.RS 4
\fIjob_contact\fP Pointer to a job contact string returned by a GRAM client API function\&.
.RE
.PP
\fBReturns\fP
.RS 4
This function always returns GLOBUS_SUCCESS\&.
.RE
.PP
\fBReturn values\fP
.RS 4
\fIGLOBUS_SUCCESS\fP Success 
.RE
.PP

.SS "void globus_gram_client_job_info_destroy (\fBglobus_gram_client_job_info_t\fP * info)"

.PP
Free memory associated with a globus_gram_client_job_info_t structure\&. The \fBglobus_gram_client_job_info_destroy()\fP function frees data pointed to by the \fIextensions\fP and \fIjob_contact\fP fields of the \fIglobus_gram_client_job_info_t\fP structure pointed to by the \fIinfo\fP parameter\&.
.PP
\fBParameters\fP
.RS 4
\fIinfo\fP A structure containing data to free\&. 
.RE
.PP

.SS "int globus_gram_client_set_credentials (gss_cred_id_t new_credentials)"

.PP
Set the default GRAM credential\&. The \fBglobus_gram_client_set_credentials()\fP function causes subsequent GRAM operations to use the GSSAPI credential \fInew_credentials\fP\&. These operations include job requests, job signals, callback registration, and job state callbacks\&. After this function returns, the caller must not use the credential, as it may be freed by GRAM when it is no longer needed\&.
.PP
\fBParameters\fP
.RS 4
\fInew_credentials\fP New GSSAPI credential to use\&.
.RE
.PP
\fBReturns\fP
.RS 4
Upon success, \fBglobus_gram_client_set_credentials()\fP returns GLOBUS_SUCCESS\&. There are no error values returned by this fucntion\&.
.RE
.PP
\fBReturn values\fP
.RS 4
\fIGLOBUS_SUCCESS\fP Success 
.RE
.PP

.SS "int globus_gram_client_version (void)"

.PP
Return GRAM protocol version\&. The \fBglobus_gram_client_version()\fP function returns the version of the GRAM protocol understood by this implementation\&.
.PP
\fBReturns\fP
.RS 4
The integer protocol revision\&. 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for globus_gram_client from the source code\&.