<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta name="robots" content="noindex">
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<!-- THIS FILE IS AUTOMATICALLY GENERATED FROM THE GLOBUS SOURCE CODE
DO NOT MODIFY.
-->
<title>Globus Reference Manual</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<body>
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__globus__gram__client.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Other GRAM Client Functions</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga85f4bc896baaec64d00ea1b4c802c6f1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gram__client.html#ga85f4bc896baaec64d00ea1b4c802c6f1">globus_gram_client_debug</a> (void)</td></tr>
<tr class="separator:ga85f4bc896baaec64d00ea1b4c802c6f1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae476c424cb48012558f65fd8b251a881"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gram__client.html#gae476c424cb48012558f65fd8b251a881">globus_gram_client_version</a> (void)</td></tr>
<tr class="separator:gae476c424cb48012558f65fd8b251a881"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga63b3f3ea108337c80586683de7222695"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gram__client.html#ga63b3f3ea108337c80586683de7222695">globus_gram_client_set_credentials</a> (gss_cred_id_t new_credentials)</td></tr>
<tr class="separator:ga63b3f3ea108337c80586683de7222695"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae9989a6f5bad42ad7dd5c33aea199bb5"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gram__client.html#gae9989a6f5bad42ad7dd5c33aea199bb5">globus_gram_client_error_string</a> (int error_code)</td></tr>
<tr class="separator:gae9989a6f5bad42ad7dd5c33aea199bb5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga37748405411fb7d14ca174a5e6316c92"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gram__client.html#ga37748405411fb7d14ca174a5e6316c92">globus_gram_client_job_contact_free</a> (char *job_contact)</td></tr>
<tr class="separator:ga37748405411fb7d14ca174a5e6316c92"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacdaed37c816578a1d27edf71346d68f1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gram__client.html#gacdaed37c816578a1d27edf71346d68f1">globus_gram_client_job_info_destroy</a> (<a class="el" href="group__globus__gram__client__callback.html#ga0db31ad82a8adcce58d6dcdec15385a7">globus_gram_client_job_info_t</a> *info)</td></tr>
<tr class="separator:gacdaed37c816578a1d27edf71346d68f1"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga85f4bc896baaec64d00ea1b4c802c6f1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void globus_gram_client_debug </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable GRAM debugging. </p>
<p>The <a class="el" href="group__globus__gram__client.html#ga85f4bc896baaec64d00ea1b4c802c6f1" title="Enable GRAM debugging.">globus_gram_client_debug()</a> 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.</p>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
</div>
</div>
<a class="anchor" id="gae476c424cb48012558f65fd8b251a881"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gram_client_version </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return GRAM protocol version. </p>
<p>The <a class="el" href="group__globus__gram__client.html#gae476c424cb48012558f65fd8b251a881" title="Return GRAM protocol version.">globus_gram_client_version()</a> function returns the version of the GRAM protocol understood by this implementation.</p>
<dl class="section return"><dt>Returns</dt><dd>The integer protocol revision. </dd></dl>
</div>
</div>
<a class="anchor" id="ga63b3f3ea108337c80586683de7222695"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gram_client_set_credentials </td>
<td>(</td>
<td class="paramtype">gss_cred_id_t </td>
<td class="paramname"><em>new_credentials</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the default GRAM credential. </p>
<p>The <a class="el" href="group__globus__gram__client.html#ga63b3f3ea108337c80586683de7222695" title="Set the default GRAM credential.">globus_gram_client_set_credentials()</a> function causes subsequent GRAM operations to use the GSSAPI credential <em>new_credentials</em>. 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.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">new_credentials</td><td>New GSSAPI credential to use.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Upon success, <a class="el" href="group__globus__gram__client.html#ga63b3f3ea108337c80586683de7222695" title="Set the default GRAM credential.">globus_gram_client_set_credentials()</a> returns GLOBUS_SUCCESS. There are no error values returned by this fucntion.</dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">GLOBUS_SUCCESS</td><td>Success </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gae9989a6f5bad42ad7dd5c33aea199bb5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* globus_gram_client_error_string </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>error_code</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a description of a a GRAM error code. </p>
<p>The <a class="el" href="group__globus__gram__client.html#gae9989a6f5bad42ad7dd5c33aea199bb5" title="Get a description of a a GRAM error code.">globus_gram_client_error_string()</a> 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 ..."</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">error_code</td><td>The error code to translate into a string.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="group__globus__gram__client.html#gae9989a6f5bad42ad7dd5c33aea199bb5" title="Get a description of a a GRAM error code.">globus_gram_client_error_string()</a> function returns a static string containing an explanation of the error. </dd></dl>
<p>References <a class="elRef" href="group__globus__gram__protocol__error__messages.html#ga3a34390199dff664dd92a1647465dfd9">globus_gram_protocol_error_string()</a>.</p>
</div>
</div>
<a class="anchor" id="ga37748405411fb7d14ca174a5e6316c92"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gram_client_job_contact_free </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>job_contact</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Releases the resources storing a job contact string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">job_contact</td><td>A job contact string returned in a successful call to <a class="el" href="group__globus__gram__client__job__functions.html#gaa314342a1c6627039c269bc4574ad371" title="Send a job request to a GRAM service.">globus_gram_client_job_request()</a> Free a job contact string</td></tr>
</table>
</dd>
</dl>
<p>The <a class="el" href="group__globus__gram__client.html#ga37748405411fb7d14ca174a5e6316c92" title="Releases the resources storing a job contact string.">globus_gram_client_job_contact_free()</a> function frees a job contact string that was allocated by a call to one of the functions in the <a class="el" href="group__globus__gram__client__job__functions.html#gaa314342a1c6627039c269bc4574ad371" title="Send a job request to a GRAM service.">globus_gram_client_job_request()</a> family. The free() function can be used in place of this function. After this function returns, the string pointed to by the <em>job_contact</em> parameter has an undefined value.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">job_contact</td><td>Pointer to a job contact string returned by a GRAM client API function.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function always returns GLOBUS_SUCCESS.</dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">GLOBUS_SUCCESS</td><td>Success </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gacdaed37c816578a1d27edf71346d68f1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void globus_gram_client_job_info_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__gram__client__callback.html#ga0db31ad82a8adcce58d6dcdec15385a7">globus_gram_client_job_info_t</a> * </td>
<td class="paramname"><em>info</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free memory associated with a globus_gram_client_job_info_t structure. </p>
<pre class="fragment">The globus_gram_client_job_info_destroy() function frees data pointed
to by the @a extensions and @a job_contact fields of the
@a globus_gram_client_job_info_t structure pointed to by the
@a info parameter.
</pre><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">info</td><td>A structure containing data to free. </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="structglobus__gram__client__job__info__s.html#a47ce826c556a33fe98b69f7dc70ebf92">globus_gram_client_job_info_s::extensions</a>, <a class="elRef" href="group__globus__gram__protocol__unpack.html#ga4870cad9c52d744ae5348f5bb4bde643">globus_gram_protocol_hash_destroy()</a>, and <a class="el" href="structglobus__gram__client__job__info__s.html#a376beb71ba0fd7c1a2cd113204de7bb3">globus_gram_client_job_info_s::job_contact</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<hr>
<p align="center">
<a href="http://www.globus.org/toolkit/about.html" target="_top">about globus</a> |
<a href="http://www.globus.org/toolkit/" target="_top">globus toolkit</a> |
<a href="https://dev.globus.org/wiki/Welcome/" target="_top">dev.globus</a>
<br>
<br>
Comments? <a href="mailto:webmaster@globus.org">webmaster@globus.org</a>
</body>
</html>
