<!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.4 -->
<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>
</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__protocol__error__messages.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">Error Messages</div> </div>
<div class="ingroups"><a class="el" href="group__globus__gram__protocol__functions.html">Functions</a></div></div>
<div class="contents">
<p>Functions in this section handle converting GRAM error codes to strings which can help the user diagnose GRAM problems.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Error Messages:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group__globus__gram__protocol__error__messages.png" border="0" alt="" usemap="#group____globus____gram____protocol____error____messages"/>
<map name="group____globus____gram____protocol____error____messages" id="group____globus____gram____protocol____error____messages">
<area shape="rect" id="node2" href="group__globus__gram__protocol__functions.html" title="Functions" alt="" coords="7,5,84,35"/></map>
</td></tr></table></center>
</div>
<h2><a name="func-members"></a>
Functions</h2>
<ul>
<li>const char * <a class="el" href="group__globus__gram__protocol__error__messages.html#ga3a34390199dff664dd92a1647465dfd9">globus_gram_protocol_error_string</a> (int error_code)
<li>void <a class="el" href="group__globus__gram__protocol__error__messages.html#gaa78493f676d09e91b77eb51b2ba8a21f">globus_gram_protocol_error_7_hack_replace_message</a> (const char *message)
<li>void <a class="el" href="group__globus__gram__protocol__error__messages.html#ga1727057d911624fca9f8599aa1063377">globus_gram_protocol_error_10_hack_replace_message</a> (const char *message)
</ul>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Functions in this section handle converting GRAM error codes to strings which can help the user diagnose GRAM problems. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga3a34390199dff664dd92a1647465dfd9"></a><!-- doxytag: member="globus_gram_protocol_error.c::globus_gram_protocol_error_string" ref="ga3a34390199dff664dd92a1647465dfd9" args="(int error_code)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* globus_gram_protocol_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__protocol__error__messages.html#ga3a34390199dff664dd92a1647465dfd9" title="Get a description of a a GRAM error code.">globus_gram_protocol_error_string()</a> function takes a GRAM error code value and returns the associated error code string for the message. The string is statically allocated by the GRAM Protocol library and should not be modified or freed by the caller. The string is intended to complete a sentence of the form "[operation] failed because ..."</p>
<dl><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__protocol__error__messages.html#ga3a34390199dff664dd92a1647465dfd9" title="Get a description of a a GRAM error code.">globus_gram_protocol_error_string()</a> function returns a static string containing an explanation of the error. </dd></dl>
</div>
</div>
<a class="anchor" id="gaa78493f676d09e91b77eb51b2ba8a21f"></a><!-- doxytag: member="globus_gram_protocol_error.c::globus_gram_protocol_error_7_hack_replace_message" ref="gaa78493f676d09e91b77eb51b2ba8a21f" args="(const char *message)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void globus_gram_protocol_error_7_hack_replace_message </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>message</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Replace the error message associated with error 7 with a custom message. </p>
<p>The <a class="el" href="group__globus__gram__protocol__error__messages.html#gaa78493f676d09e91b77eb51b2ba8a21f" title="Replace the error message associated with error 7 with a custom message.">globus_gram_protocol_error_7_hack_replace_message()</a> function creates a custom version of the error message for the error <em>GLOBUS_GRAM_PROTOCOL_ERROR_AUTHORIZATION</em>. The string pointed to by the <em>message</em> parameter is copied to thread-local storage, and subsequent calls to <a class="el" href="group__globus__gram__protocol__error__messages.html#ga3a34390199dff664dd92a1647465dfd9" title="Get a description of a a GRAM error code.">globus_gram_protocol_error_string()</a> with this error number will return this copy of the string. Each time <a class="el" href="group__globus__gram__protocol__error__messages.html#gaa78493f676d09e91b77eb51b2ba8a21f" title="Replace the error message associated with error 7 with a custom message.">globus_gram_protocol_error_7_hack_replace_message()</a> is called for a particular thread, the previous message is freed.</p>
<p>The purpose of this function is to allow more meaningful error messages to be generated when authentication failures occur. In particular, the specific GSSAPI error reason can be used in place of a generic authorization failure message.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">message</td><td>The new message to be associated with the GLOBUS_GRAM_PROTOCOL_ERROR_AUTHORIZATION error code.</td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Since Globus 5.0.0, this function uses thread-specific storage, so that the value returned by <a class="el" href="group__globus__gram__protocol__error__messages.html#ga3a34390199dff664dd92a1647465dfd9" title="Get a description of a a GRAM error code.">globus_gram_protocol_error_string()</a> for GLOBUS_GRAM_PROTOCOL_ERROR_AUTHORIZATION is that for the last authorization error where <a class="el" href="group__globus__gram__protocol__error__messages.html#gaa78493f676d09e91b77eb51b2ba8a21f" title="Replace the error message associated with error 7 with a custom message.">globus_gram_protocol_error_7_hack_replace_message()</a> was called from this thread. </dd></dl>
</div>
</div>
<a class="anchor" id="ga1727057d911624fca9f8599aa1063377"></a><!-- doxytag: member="globus_gram_protocol_error.c::globus_gram_protocol_error_10_hack_replace_message" ref="ga1727057d911624fca9f8599aa1063377" args="(const char *message)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void globus_gram_protocol_error_10_hack_replace_message </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>message</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Replace the error message associated with error 10 with a custom message. </p>
<p>The <a class="el" href="group__globus__gram__protocol__error__messages.html#ga1727057d911624fca9f8599aa1063377" title="Replace the error message associated with error 10 with a custom message.">globus_gram_protocol_error_10_hack_replace_message()</a> function creates a custom version of the error message for the error <em>GLOBUS_GRAM_PROTOCOL_ERROR_PROTOCOL_FAILED</em>. The string pointed to by the <em>message</em> parameter is copied to thread-local storage, and subsequent calls to <a class="el" href="group__globus__gram__protocol__error__messages.html#ga3a34390199dff664dd92a1647465dfd9" title="Get a description of a a GRAM error code.">globus_gram_protocol_error_string()</a> with this error number will return this copy of the string. Each time <a class="el" href="group__globus__gram__protocol__error__messages.html#ga1727057d911624fca9f8599aa1063377" title="Replace the error message associated with error 10 with a custom message.">globus_gram_protocol_error_10_hack_replace_message()</a> is called for a particular thread, the previous message is freed.</p>
<p>The purpose of this function is to allow more meaningful error messages to be generated when protocol errors occur. In particular, the specific XIO error reason can be used in place of a generic protocol failure message.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">message</td><td>The new message to be associated with the GLOBUS_GRAM_PROTOCOL_ERROR_PROTOCOL_FAILED error code.</td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Since Globus 5.0.0, this function uses thread-specific storage, so that the value returned by <a class="el" href="group__globus__gram__protocol__error__messages.html#ga3a34390199dff664dd92a1647465dfd9" title="Get a description of a a GRAM error code.">globus_gram_protocol_error_string()</a> for GLOBUS_GRAM_PROTOCOL_ERROR_PROTOCOL_FAILED is that for the last authorization error where <a class="el" href="group__globus__gram__protocol__error__messages.html#ga1727057d911624fca9f8599aa1063377" title="Replace the error message associated with error 10 with a custom message.">globus_gram_protocol_error_10_hack_replace_message()</a> was called from this thread. </dd></dl>
</div>
</div>
</div>
</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>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
39907065f1eb3c6a70bcb6d8d4286f7f
>
files
>
25
