/usr/share/doc/libglobus-gsi-openssl-error-dev/html/group__globus__openssl__error__utility.html is in libglobus-gsi-openssl-error-doc 3.8-2build1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>globus_gsi_openssl_error: Error Object Helper Functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">globus_gsi_openssl_error
 <span id="projectnumber">3.8</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Error Object Helper Functions<div class="ingroups"><a class="el" href="group__globus__openssl__error__api.html">Globus OpenSSL Error API</a></div></div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for Error Object Helper Functions:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group__globus__openssl__error__utility.png" border="0" alt="" usemap="#group____globus____openssl____error____utility"/>
<map name="group____globus____openssl____error____utility" id="group____globus____openssl____error____utility">
<area shape="rect" id="node1" href="group__globus__openssl__error__api.html" title="Globus OpenSSL Error API" alt="" coords="5,13,193,39"/>
</map>
</td></tr></table></center>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga944c2c110759c9d3857561beb2a33bc6"><td class="memItemLeft" align="right" valign="top">globus_bool_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__openssl__error__utility.html#ga944c2c110759c9d3857561beb2a33bc6">globus_error_match_openssl_error</a> (globus_object_t *error, unsigned long library, unsigned long function, unsigned long reason)</td></tr>
<tr class="separator:ga944c2c110759c9d3857561beb2a33bc6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga106c894da18b56f40b841b356d7c0ae5"><td class="memItemLeft" align="right" valign="top">globus_object_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__openssl__error__utility.html#ga106c894da18b56f40b841b356d7c0ae5">globus_error_wrap_openssl_error</a> (globus_module_descriptor_t *base_source, int error_type, const char *source_file, const char *source_func, int source_line, const char *format,...)</td></tr>
<tr class="separator:ga106c894da18b56f40b841b356d7c0ae5"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>The functions in the <a class="el" href="group__globus__openssl__error__utility.html">Error Object Helper Functions </a> section deal with Globus error objects constructed with OpenSSL error data. These functions manipulate the generic globus_object_t representation of an OpenSSL error. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga944c2c110759c9d3857561beb2a33bc6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga944c2c110759c9d3857561beb2a33bc6">◆ </a></span>globus_error_match_openssl_error()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_bool_t globus_error_match_openssl_error </td>
<td>(</td>
<td class="paramtype">globus_object_t * </td>
<td class="paramname"><em>error</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>library</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>function</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>reason</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether the error originated from a specific library, from a specific function and is of a specific type.</p>
<p>This function checks whether the error or any of it's causative errors originated from a specific library, specific function and is of a specific type.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">error</td><td>The error object for which to perform the check </td></tr>
<tr><td class="paramname">library</td><td>The library to check for </td></tr>
<tr><td class="paramname">function</td><td>The function to check for </td></tr>
<tr><td class="paramname">reason</td><td>The type to check for </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">GLOBUS_TRUE</td><td>Error matched </td></tr>
<tr><td class="paramname">GLOBUS_FALSE</td><td>Error failed to match </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga106c894da18b56f40b841b356d7c0ae5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga106c894da18b56f40b841b356d7c0ae5">◆ </a></span>globus_error_wrap_openssl_error()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_object_t* globus_error_wrap_openssl_error </td>
<td>(</td>
<td class="paramtype">globus_module_descriptor_t * </td>
<td class="paramname"><em>base_source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>error_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>source_file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>source_func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>source_line</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Wrap the OpenSSL error and create a wrapped globus error object from the error.</p>
<p>This function gets all the OpenSSL errors from the error list, and chains them using the globus error string object. The resulting globus error object is a wrapper to the OpenSSL error at the end of the chain.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">base_source</td><td>The module that the error was generated from </td></tr>
<tr><td class="paramname">error_type</td><td>The type of error encapsulating the OpenSSL error </td></tr>
<tr><td class="paramname">source_file</td><td>Name of file. Use <b>FILE</b> </td></tr>
<tr><td class="paramname">source_func</td><td>Name of function. Use _globus_func_name and declare your func with GlobusFuncName(<name>) </td></tr>
<tr><td class="paramname">source_line</td><td>Line number. Use <b>LINE</b> </td></tr>
<tr><td class="paramname">format</td><td>format string for the description of the error entry point where the OpenSSL error occurred, should be followed by parameters to fill the format string (like in printf). </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The globus error object. A globus_result_t object can be created using the globus_error_put function</dd></dl>
<dl class="section see"><dt>See also</dt><dd>globus_error_put() </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
|