/usr/share/doc/libglobus-gram-client-dev/html/group__globus__gram__client.html is in libglobus-gram-client-doc 12.3-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 | <!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.7.6.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>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
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">
<h2><a name="func-members"></a>
Functions</h2>
<ul>
<li>void <a class="el" href="group__globus__gram__client.html#ga85f4bc896baaec64d00ea1b4c802c6f1">globus_gram_client_debug</a> (void)
<li>int <a class="el" href="group__globus__gram__client.html#gae476c424cb48012558f65fd8b251a881">globus_gram_client_version</a> (void)
<li>int <a class="el" href="group__globus__gram__client.html#ga63b3f3ea108337c80586683de7222695">globus_gram_client_set_credentials</a> (gss_cred_id_t new_credentials)
<li>const char * <a class="el" href="group__globus__gram__client.html#gae9989a6f5bad42ad7dd5c33aea199bb5">globus_gram_client_error_string</a> (int error_code)
<li>int <a class="el" href="group__globus__gram__client.html#ga37748405411fb7d14ca174a5e6316c92">globus_gram_client_job_contact_free</a> (char *job_contact)
<li>void <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)
</ul>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga85f4bc896baaec64d00ea1b4c802c6f1"></a><!-- doxytag: member="globus_gram_client.c::globus_gram_client_debug" ref="ga85f4bc896baaec64d00ea1b4c802c6f1" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="group__globus__gram__client.html#ga85f4bc896baaec64d00ea1b4c802c6f1">globus_gram_client_debug</a> </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="return"><dt><b>Returns:</b></dt><dd>void </dd></dl>
</div>
</div>
<a class="anchor" id="gae476c424cb48012558f65fd8b251a881"></a><!-- doxytag: member="globus_gram_client.c::globus_gram_client_version" ref="gae476c424cb48012558f65fd8b251a881" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__globus__gram__client.html#gae476c424cb48012558f65fd8b251a881">globus_gram_client_version</a> </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="return"><dt><b>Returns:</b></dt><dd>The integer protocol revision. </dd></dl>
</div>
</div>
<a class="anchor" id="ga63b3f3ea108337c80586683de7222695"></a><!-- doxytag: member="globus_gram_client.c::globus_gram_client_set_credentials" ref="ga63b3f3ea108337c80586683de7222695" args="(gss_cred_id_t new_credentials)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__globus__gram__client.html#ga63b3f3ea108337c80586683de7222695">globus_gram_client_set_credentials</a> </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><b>Parameters:</b></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="return"><dt><b>Returns:</b></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><b>Return values:</b></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><!-- doxytag: member="globus_gram_client.c::globus_gram_client_error_string" ref="gae9989a6f5bad42ad7dd5c33aea199bb5" args="(int error_code)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="group__globus__gram__client.html#gae9989a6f5bad42ad7dd5c33aea199bb5">globus_gram_client_error_string</a> </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><b>Parameters:</b></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="return"><dt><b>Returns:</b></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>
</div>
</div>
<a class="anchor" id="ga37748405411fb7d14ca174a5e6316c92"></a><!-- doxytag: member="globus_gram_client.c::globus_gram_client_job_contact_free" ref="ga37748405411fb7d14ca174a5e6316c92" args="(char *job_contact)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__globus__gram__client.html#ga37748405411fb7d14ca174a5e6316c92">globus_gram_client_job_contact_free</a> </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><b>Parameters:</b></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><b>Parameters:</b></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="return"><dt><b>Returns:</b></dt><dd>This function always returns GLOBUS_SUCCESS.</dd></dl>
<dl class="retval"><dt><b>Return values:</b></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><!-- doxytag: member="globus_gram_client.c::globus_gram_client_job_info_destroy" ref="gacdaed37c816578a1d27edf71346d68f1" args="(globus_gram_client_job_info_t *info)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="group__globus__gram__client.html#gacdaed37c816578a1d27edf71346d68f1">globus_gram_client_job_info_destroy</a> </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>
<p>The <a class="el" href="group__globus__gram__client.html#gacdaed37c816578a1d27edf71346d68f1" title="Free memory associated with a globus_gram_client_job_info_t structure.">globus_gram_client_job_info_destroy()</a> function frees data pointed to by the <em>extensions</em> and <em>job_contact</em> fields of the <em>globus_gram_client_job_info_t</em> structure pointed to by the <em>info</em> parameter.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">info</td><td>A structure containing data to free. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div>
<div id="nav-path" class="navpath">
<ul>
<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>
|