/usr/share/doc/libglobus-rls-client-dev/html/group__globus__rls__client__connection.html is in libglobus-rls-client-doc 5.2-8.
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 | <!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>
<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__rls__client__connection.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#define-members">Defines</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Connection Management</div> </div>
</div><!--header-->
<div class="contents">
<h2><a name="define-members"></a>
Defines</h2>
<ul>
<li>#define <a class="el" href="group__globus__rls__client__connection.html#ga9a4bf726f4cbeef53efbe3d8c722a3d8">GLOBUS_RLS_URL_SCHEME</a>   "rls"
<li>#define <a class="el" href="group__globus__rls__client__connection.html#ga0a312c5bce2b1d2f4e57e79ad9c0dd8f">GLOBUS_RLS_URL_SCHEME_NOAUTH</a>   "rlsn"
<li>#define <a class="el" href="group__globus__rls__client__connection.html#gac7584c1893f94ce33bc451e6f9e1e0c1">GLOBUS_RLS_SERVER_DEFPORT</a>   39281
<li>#define <a class="el" href="group__globus__rls__client__connection.html#ga6d875141188d039246ad7be71599220d">MAXERRMSG</a>   1024
</ul>
<h2><a name="func-members"></a>
Functions</h2>
<ul>
<li>void <a class="el" href="group__globus__rls__client__connection.html#gafc13ec59c7f0bd2cd25d297928b81f02">globus_rls_client_certificate</a> (char *certfile, char *keyfile)
<li>void <a class="el" href="group__globus__rls__client__connection.html#ga0a3dc200cc39bfd6e5fe5bf67143f6f8">globus_rls_client_proxy_certificate</a> (char *proxy)
<li>globus_result_t <a class="el" href="group__globus__rls__client__connection.html#ga7525a2769e3150465566115c3abe8ec1">globus_rls_client_connect</a> (char *url, <a class="el" href="structglobus__rls__handle__t.html">globus_rls_handle_t</a> **h)
<li>globus_result_t <a class="el" href="group__globus__rls__client__connection.html#gaaec87d67574e91e018a4c146b36f5606">globus_rls_client_close</a> (<a class="el" href="structglobus__rls__handle__t.html">globus_rls_handle_t</a> *h)
<li>int <a class="el" href="group__globus__rls__client__connection.html#gadc8d71afbee28fb0e82ac7a22bc978cc">globus_rls_client_get_timeout</a> ()
<li>void <a class="el" href="group__globus__rls__client__connection.html#ga9f0c0a5a25ffee0c0bcd10bdb0ebdf97">globus_rls_client_set_timeout</a> (int seconds)
</ul>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Functions to open and close connections to an RLS server. </p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ga9a4bf726f4cbeef53efbe3d8c722a3d8"></a><!-- doxytag: member="globus_rls_client.h::GLOBUS_RLS_URL_SCHEME" ref="ga9a4bf726f4cbeef53efbe3d8c722a3d8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define <a class="el" href="group__globus__rls__client__connection.html#ga9a4bf726f4cbeef53efbe3d8c722a3d8">GLOBUS_RLS_URL_SCHEME</a>   "rls"</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>URL scheme to use when connecting to RLS server. </p>
</div>
</div>
<a class="anchor" id="ga0a312c5bce2b1d2f4e57e79ad9c0dd8f"></a><!-- doxytag: member="globus_rls_client.h::GLOBUS_RLS_URL_SCHEME_NOAUTH" ref="ga0a312c5bce2b1d2f4e57e79ad9c0dd8f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define <a class="el" href="group__globus__rls__client__connection.html#ga0a312c5bce2b1d2f4e57e79ad9c0dd8f">GLOBUS_RLS_URL_SCHEME_NOAUTH</a>   "rlsn"</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>URL scheme when connecting to RLS server without authentication. </p>
</div>
</div>
<a class="anchor" id="gac7584c1893f94ce33bc451e6f9e1e0c1"></a><!-- doxytag: member="globus_rls_client.h::GLOBUS_RLS_SERVER_DEFPORT" ref="gac7584c1893f94ce33bc451e6f9e1e0c1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define <a class="el" href="group__globus__rls__client__connection.html#gac7584c1893f94ce33bc451e6f9e1e0c1">GLOBUS_RLS_SERVER_DEFPORT</a>   39281</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default port number that RLS server listens on. </p>
</div>
</div>
<a class="anchor" id="ga6d875141188d039246ad7be71599220d"></a><!-- doxytag: member="globus_rls_client.h::MAXERRMSG" ref="ga6d875141188d039246ad7be71599220d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define <a class="el" href="group__globus__rls__client__connection.html#ga6d875141188d039246ad7be71599220d">MAXERRMSG</a>   1024</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Maximum length of error messages returned by server. </p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gafc13ec59c7f0bd2cd25d297928b81f02"></a><!-- doxytag: member="globus_rls_client.h::globus_rls_client_certificate" ref="gafc13ec59c7f0bd2cd25d297928b81f02" args="(char *certfile, char *keyfile)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="group__globus__rls__client__connection.html#gafc13ec59c7f0bd2cd25d297928b81f02">globus_rls_client_certificate</a> </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>certfile</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>keyfile</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set certificate used in authentication. </p>
<p>Sets environment variables X509_USER_CERT, X509_USER_KEY, and clears X509_USER_PROXY.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">certfile</td><td>Name of X509 certificate file.</td></tr>
<tr><td class="paramname">keyfile</td><td>Name of X509 key file. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga0a3dc200cc39bfd6e5fe5bf67143f6f8"></a><!-- doxytag: member="globus_rls_client.h::globus_rls_client_proxy_certificate" ref="ga0a3dc200cc39bfd6e5fe5bf67143f6f8" args="(char *proxy)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="group__globus__rls__client__connection.html#ga0a3dc200cc39bfd6e5fe5bf67143f6f8">globus_rls_client_proxy_certificate</a> </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>proxy</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set X509_USER_PROXY environment variable to specified file. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">proxy</td><td>Name of X509 proxy certificate file. If NULL clears X509_USER_PROXY. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga7525a2769e3150465566115c3abe8ec1"></a><!-- doxytag: member="globus_rls_client.h::globus_rls_client_connect" ref="ga7525a2769e3150465566115c3abe8ec1" args="(char *url, globus_rls_handle_t **h)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t <a class="el" href="group__globus__rls__client__connection.html#ga7525a2769e3150465566115c3abe8ec1">globus_rls_client_connect</a> </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>url</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structglobus__rls__handle__t.html">globus_rls_handle_t</a> ** </td>
<td class="paramname"><em>h</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Open connection to RLS server. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">url</td><td>URL of server to connect to. URL scheme should be <b>RLS</b> or <b>RLSN</b>, eg <b>RLS://my.host</b>. If the URL scheme is <b>RLSN</b> then no authentication is performed (the RLS server must be started with authentication disabled as well, this option is primarily intended for testing).</td></tr>
<tr><td class="paramname">h</td><td>If the connection is successful <em>*h</em> will be set to the connection handle. This handle is required by all other functions in the API.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt><b>Return values:</b></dt><dd>
<table class="retval">
<tr><td class="paramname">GLOBUS_SUCCESS</td><td>Handle <em>h</em> now connected to RLS server identified by <em>url</em>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaaec87d67574e91e018a4c146b36f5606"></a><!-- doxytag: member="globus_rls_client.h::globus_rls_client_close" ref="gaaec87d67574e91e018a4c146b36f5606" args="(globus_rls_handle_t *h)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t <a class="el" href="group__globus__rls__client__connection.html#gaaec87d67574e91e018a4c146b36f5606">globus_rls_client_close</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structglobus__rls__handle__t.html">globus_rls_handle_t</a> * </td>
<td class="paramname"><em>h</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Close connection to RLS server. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">h</td><td>Connection handle to be closed, previously allocated by <a class="el" href="group__globus__rls__client__connection.html#ga7525a2769e3150465566115c3abe8ec1" title="Open connection to RLS server.">globus_rls_client_connect()</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt><b>Return values:</b></dt><dd>
<table class="retval">
<tr><td class="paramname">GLOBUS_SUCCESS</td><td>Connection closed, <em>h</em> is no longer valid. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gadc8d71afbee28fb0e82ac7a22bc978cc"></a><!-- doxytag: member="globus_rls_client.h::globus_rls_client_get_timeout" ref="gadc8d71afbee28fb0e82ac7a22bc978cc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__globus__rls__client__connection.html#gadc8d71afbee28fb0e82ac7a22bc978cc">globus_rls_client_get_timeout</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get timeout for IO calls to RLS server. </p>
<p>If 0 IO calls do not timeout. The default is 30 seconds.</p>
<dl class="retval"><dt><b>Return values:</b></dt><dd>
<table class="retval">
<tr><td class="paramname">timeout</td><td>Seconds to wait before timing out an IO operation. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga9f0c0a5a25ffee0c0bcd10bdb0ebdf97"></a><!-- doxytag: member="globus_rls_client.h::globus_rls_client_set_timeout" ref="ga9f0c0a5a25ffee0c0bcd10bdb0ebdf97" args="(int seconds)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="group__globus__rls__client__connection.html#ga9f0c0a5a25ffee0c0bcd10bdb0ebdf97">globus_rls_client_set_timeout</a> </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>seconds</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set timeout for IO calls to RLS server. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">seconds</td><td>Seconds to wait before timing out an IO operation. If 0 IO calls do not timeout. The default is 30 seconds. </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>
|