/usr/share/doc/libglobus-gsi-openssl-error-dev/html/group__globus__openssl__error__object.html is in libglobus-gsi-openssl-error-doc 2.1-1.
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 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 | <!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="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__openssl__error__object.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#define-members">Defines</a> </div>
<div class="headertitle">
<div class="title">Error Construction</div> </div>
<div class="ingroups"><a class="el" href="group__globus__openssl__error__api.html">Globus OPENSSL Error API</a></div></div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for Error Construction:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group__globus__openssl__error__object.png" border="0" alt="" usemap="#group____globus____openssl____error____object"/>
<map name="group____globus____openssl____error____object" id="group____globus____openssl____error____object">
<area shape="rect" id="node2" href="group__globus__openssl__error__api.html" title="Globus OPENSSL Error API" alt="" coords="7,5,193,35"/></map>
</td></tr></table></center>
</div>
<h2><a name="define-members"></a>
Defines</h2>
<ul>
<li>#define <a class="el" href="group__globus__openssl__error__object.html#ga9fc9271ac6e0e5bee545bc4f5bc8d137">GLOBUS_ERROR_TYPE_OPENSSL</a>
</ul>
<h2><a name="member-group"></a>
Get Error Code</h2>
<ul>
<li>unsigned long <a class="el" href="group__globus__openssl__error__object.html#ga3a7dc566f4b90b6efc2842a6001fd4f3">globus_openssl_error_handle_get_error_code</a> (globus_openssl_error_handle_t handle)
</ul>
<h2><a name="member-group"></a>
Get Error Data</h2>
<ul>
<li>const char * <a class="el" href="group__globus__openssl__error__object.html#ga92894399eb0be431cf86bcd07ac364c9">globus_openssl_error_handle_get_data</a> (globus_openssl_error_handle_t handle)
</ul>
<h2><a name="member-group"></a>
Get Error Data Flags</h2>
<ul>
<li>int <a class="el" href="group__globus__openssl__error__object.html#gab7442f5ebf3077d827985aa825e8ad25">globus_openssl_error_handle_get_data_flags</a> (globus_openssl_error_handle_t handle)
</ul>
<h2><a name="member-group"></a>
Get Filename</h2>
<ul>
<li>const char * <a class="el" href="group__globus__openssl__error__object.html#gafe020631795bfbeaf214ebd4386873b7">globus_openssl_error_handle_get_filename</a> (globus_openssl_error_handle_t handle)
</ul>
<h2><a name="member-group"></a>
Get Linenumber</h2>
<ul>
<li>int <a class="el" href="group__globus__openssl__error__object.html#ga3c708ffdc70d3e238f1b868836c3fd4d">globus_openssl_error_handle_get_linenumber</a> (globus_openssl_error_handle_t handle)
</ul>
<h2><a name="member-group"></a>
Get Library</h2>
<ul>
<li>const char * <a class="el" href="group__globus__openssl__error__object.html#gae62e26cae636ffd9f2480781ac787e25">globus_openssl_error_handle_get_library</a> (globus_openssl_error_handle_t handle)
</ul>
<h2><a name="member-group"></a>
Get Function</h2>
<ul>
<li>const char * <a class="el" href="group__globus__openssl__error__object.html#ga6fff82db41872df95870f2c3d2970e69">globus_openssl_error_handle_get_function</a> (globus_openssl_error_handle_t handle)
</ul>
<h2><a name="member-group"></a>
Get Reason</h2>
<ul>
<li>const char * <a class="el" href="group__globus__openssl__error__object.html#gae9f2d4284f223bd55b70a1d6947788a1">globus_openssl_error_handle_get_reason</a> (globus_openssl_error_handle_t handle)
</ul>
<h2><a name="member-group"></a>
Construct Error</h2>
<ul>
<li>globus_object_t * <a class="el" href="group__globus__openssl__error__object.html#ga6769c2de3c1146f8989bc2c1b5b77af3">globus_error_construct_openssl_error</a> (globus_module_descriptor_t *base_source, globus_object_t *base_cause)
</ul>
<h2><a name="member-group"></a>
Initialize Error</h2>
<ul>
<li>globus_object_t * <a class="el" href="group__globus__openssl__error__object.html#gaed064a29bfafeab34eea500e23d9a9b8">globus_error_initialize_openssl_error</a> (globus_object_t *error, globus_module_descriptor_t *base_source, globus_object_t *base_cause, globus_openssl_error_handle_t openssl_error_handle)
</ul>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Create and initialize a Globus OpenSSL Error object. </p>
<p>This section defines operations to create and initialize Globus OpenSSLError objects. </p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ga9fc9271ac6e0e5bee545bc4f5bc8d137"></a><!-- doxytag: member="globus_error_openssl.h::GLOBUS_ERROR_TYPE_OPENSSL" ref="ga9fc9271ac6e0e5bee545bc4f5bc8d137" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define <a class="el" href="group__globus__openssl__error__object.html#ga9fc9271ac6e0e5bee545bc4f5bc8d137">GLOBUS_ERROR_TYPE_OPENSSL</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Error type definition. </p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga3a7dc566f4b90b6efc2842a6001fd4f3"></a><!-- doxytag: member="globus_error_openssl.c::globus_openssl_error_handle_get_error_code" ref="ga3a7dc566f4b90b6efc2842a6001fd4f3" args="(globus_openssl_error_handle_t handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long <a class="el" href="group__globus__openssl__error__object.html#ga3a7dc566f4b90b6efc2842a6001fd4f3">globus_openssl_error_handle_get_error_code</a> </td>
<td>(</td>
<td class="paramtype">globus_openssl_error_handle_t </td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the openssl error code which represents the openssl error from the openssl error handle. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The openssl error handle </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The error code </dd></dl>
</div>
</div>
<a class="anchor" id="ga92894399eb0be431cf86bcd07ac364c9"></a><!-- doxytag: member="globus_error_openssl.c::globus_openssl_error_handle_get_data" ref="ga92894399eb0be431cf86bcd07ac364c9" args="(globus_openssl_error_handle_t handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="group__globus__openssl__error__object.html#ga92894399eb0be431cf86bcd07ac364c9">globus_openssl_error_handle_get_data</a> </td>
<td>(</td>
<td class="paramtype">globus_openssl_error_handle_t </td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the openssl error data which contains additional data about the error from the openssl error handle. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The openssl error handle </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The error data </dd></dl>
</div>
</div>
<a class="anchor" id="gab7442f5ebf3077d827985aa825e8ad25"></a><!-- doxytag: member="globus_error_openssl.c::globus_openssl_error_handle_get_data_flags" ref="gab7442f5ebf3077d827985aa825e8ad25" args="(globus_openssl_error_handle_t handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__globus__openssl__error__object.html#gab7442f5ebf3077d827985aa825e8ad25">globus_openssl_error_handle_get_data_flags</a> </td>
<td>(</td>
<td class="paramtype">globus_openssl_error_handle_t </td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the openssl error data flags from the openssl error handle. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The openssl error handle </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The error data flags </dd></dl>
</div>
</div>
<a class="anchor" id="gafe020631795bfbeaf214ebd4386873b7"></a><!-- doxytag: member="globus_error_openssl.c::globus_openssl_error_handle_get_filename" ref="gafe020631795bfbeaf214ebd4386873b7" args="(globus_openssl_error_handle_t handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="group__globus__openssl__error__object.html#gafe020631795bfbeaf214ebd4386873b7">globus_openssl_error_handle_get_filename</a> </td>
<td>(</td>
<td class="paramtype">globus_openssl_error_handle_t </td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the filename where the openssl error occurred from the openssl error handle. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The openssl error handle </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The filename </dd></dl>
</div>
</div>
<a class="anchor" id="ga3c708ffdc70d3e238f1b868836c3fd4d"></a><!-- doxytag: member="globus_error_openssl.c::globus_openssl_error_handle_get_linenumber" ref="ga3c708ffdc70d3e238f1b868836c3fd4d" args="(globus_openssl_error_handle_t handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__globus__openssl__error__object.html#ga3c708ffdc70d3e238f1b868836c3fd4d">globus_openssl_error_handle_get_linenumber</a> </td>
<td>(</td>
<td class="paramtype">globus_openssl_error_handle_t </td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the linenumber on which the openssl error occurred from the openssl error handle. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The openssl error handle </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The linenumber </dd></dl>
</div>
</div>
<a class="anchor" id="gae62e26cae636ffd9f2480781ac787e25"></a><!-- doxytag: member="globus_error_openssl.c::globus_openssl_error_handle_get_library" ref="gae62e26cae636ffd9f2480781ac787e25" args="(globus_openssl_error_handle_t handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="group__globus__openssl__error__object.html#gae62e26cae636ffd9f2480781ac787e25">globus_openssl_error_handle_get_library</a> </td>
<td>(</td>
<td class="paramtype">globus_openssl_error_handle_t </td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the library name where the openssl error occurred in from the openssl error handle. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The openssl error handle </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The library name </dd></dl>
</div>
</div>
<a class="anchor" id="ga6fff82db41872df95870f2c3d2970e69"></a><!-- doxytag: member="globus_error_openssl.c::globus_openssl_error_handle_get_function" ref="ga6fff82db41872df95870f2c3d2970e69" args="(globus_openssl_error_handle_t handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="group__globus__openssl__error__object.html#ga6fff82db41872df95870f2c3d2970e69">globus_openssl_error_handle_get_function</a> </td>
<td>(</td>
<td class="paramtype">globus_openssl_error_handle_t </td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the function name where the openssl error occurred from the openssl error handle. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The openssl error handle </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The function name </dd></dl>
</div>
</div>
<a class="anchor" id="gae9f2d4284f223bd55b70a1d6947788a1"></a><!-- doxytag: member="globus_error_openssl.c::globus_openssl_error_handle_get_reason" ref="gae9f2d4284f223bd55b70a1d6947788a1" args="(globus_openssl_error_handle_t handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="group__globus__openssl__error__object.html#gae9f2d4284f223bd55b70a1d6947788a1">globus_openssl_error_handle_get_reason</a> </td>
<td>(</td>
<td class="paramtype">globus_openssl_error_handle_t </td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the reason string which caused the openssl error from the openssl error handle. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The openssl error handle </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The reson string </dd></dl>
</div>
</div>
<a class="anchor" id="ga6769c2de3c1146f8989bc2c1b5b77af3"></a><!-- doxytag: member="globus_error_openssl.c::globus_error_construct_openssl_error" ref="ga6769c2de3c1146f8989bc2c1b5b77af3" args="(globus_module_descriptor_t *base_source, globus_object_t *base_cause)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_object_t* <a class="el" href="group__globus__openssl__error__object.html#ga6769c2de3c1146f8989bc2c1b5b77af3">globus_error_construct_openssl_error</a> </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">globus_object_t * </td>
<td class="paramname"><em>base_cause</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Allocate and initialize an error of type GLOBUS_ERROR_TYPE_OPENSSL This function, combined with <a class="el" href="group__globus__openssl__error__object.html#gaed064a29bfafeab34eea500e23d9a9b8" title="Initialize a previously allocated error of type GLOBUS_ERROR_TYPE_OPENSSL.">globus_error_initialize_openssl_error()</a> will recursively generate globus error objects (of type globus_object_t) from the errors on openssl's static error stack. </p>
<p>The errors will be chained in a causal fashion to provide a path to the root cause of the actual error.</p>
<p>NOTE: the static stack openssl implements for its errors currently only supports at most 16 errors, so if more are added, the errors that were added first will be wiped out. If 16 errors are counted in the chain of openssl errors, its possible that some errors (including the original error) are missing.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">base_source</td><td>Pointer to the originating globus module. </td></tr>
<tr><td class="paramname">base_cause</td><td>The error object causing the error. This parameter should be NULL in nearly all cases, as the root cause of an error will most likely be in the openssl code itself. The actual cause of the error is determined from the static stack of openssl errors.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The resulting error object. It is the user's responsibility to eventually free this object using globus_object_free(). A globus_result_t may be obtained by calling globus_error_put() on this object. </dd></dl>
</div>
</div>
<a class="anchor" id="gaed064a29bfafeab34eea500e23d9a9b8"></a><!-- doxytag: member="globus_error_openssl.c::globus_error_initialize_openssl_error" ref="gaed064a29bfafeab34eea500e23d9a9b8" args="(globus_object_t *error, globus_module_descriptor_t *base_source, globus_object_t *base_cause, globus_openssl_error_handle_t openssl_error_handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_object_t* <a class="el" href="group__globus__openssl__error__object.html#gaed064a29bfafeab34eea500e23d9a9b8">globus_error_initialize_openssl_error</a> </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">globus_module_descriptor_t * </td>
<td class="paramname"><em>base_source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_object_t * </td>
<td class="paramname"><em>base_cause</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_openssl_error_handle_t </td>
<td class="paramname"><em>openssl_error_handle</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initialize a previously allocated error of type GLOBUS_ERROR_TYPE_OPENSSL. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">error</td><td>The previously allocated error object. </td></tr>
<tr><td class="paramname">base_source</td><td>Pointer to the originating module. </td></tr>
<tr><td class="paramname">base_cause</td><td>The error object causing the error. If this is the original error this paramater may be NULL. </td></tr>
<tr><td class="paramname">openssl_error_handle</td><td>The openssl error handle associated with this error, this parameter should already be initialized to contain the openssl error code associated with the error. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The resulting error object. You may have to call globus_error_put() on this object before passing it on. </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>
|