<!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.8.3.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><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__globus__rls__client__connection.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Connection Management</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga9a4bf726f4cbeef53efbe3d8c722a3d8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__rls__client__connection.html#ga9a4bf726f4cbeef53efbe3d8c722a3d8">GLOBUS_RLS_URL_SCHEME</a>   "rls"</td></tr>
<tr class="separator:ga9a4bf726f4cbeef53efbe3d8c722a3d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0a312c5bce2b1d2f4e57e79ad9c0dd8f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__rls__client__connection.html#ga0a312c5bce2b1d2f4e57e79ad9c0dd8f">GLOBUS_RLS_URL_SCHEME_NOAUTH</a>   "rlsn"</td></tr>
<tr class="separator:ga0a312c5bce2b1d2f4e57e79ad9c0dd8f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac7584c1893f94ce33bc451e6f9e1e0c1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__rls__client__connection.html#gac7584c1893f94ce33bc451e6f9e1e0c1">GLOBUS_RLS_SERVER_DEFPORT</a>   39281</td></tr>
<tr class="separator:gac7584c1893f94ce33bc451e6f9e1e0c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6d875141188d039246ad7be71599220d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__rls__client__connection.html#ga6d875141188d039246ad7be71599220d">MAXERRMSG</a>   1024</td></tr>
<tr class="separator:ga6d875141188d039246ad7be71599220d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gafc13ec59c7f0bd2cd25d297928b81f02"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__rls__client__connection.html#gafc13ec59c7f0bd2cd25d297928b81f02">globus_rls_client_certificate</a> (char *certfile, char *keyfile)</td></tr>
<tr class="separator:gafc13ec59c7f0bd2cd25d297928b81f02"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0a3dc200cc39bfd6e5fe5bf67143f6f8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__rls__client__connection.html#ga0a3dc200cc39bfd6e5fe5bf67143f6f8">globus_rls_client_proxy_certificate</a> (char *proxy)</td></tr>
<tr class="separator:ga0a3dc200cc39bfd6e5fe5bf67143f6f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7525a2769e3150465566115c3abe8ec1"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><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)</td></tr>
<tr class="separator:ga7525a2769e3150465566115c3abe8ec1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaaec87d67574e91e018a4c146b36f5606"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><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)</td></tr>
<tr class="separator:gaaec87d67574e91e018a4c146b36f5606"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadc8d71afbee28fb0e82ac7a22bc978cc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__rls__client__connection.html#gadc8d71afbee28fb0e82ac7a22bc978cc">globus_rls_client_get_timeout</a> ()</td></tr>
<tr class="separator:gadc8d71afbee28fb0e82ac7a22bc978cc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9f0c0a5a25ffee0c0bcd10bdb0ebdf97"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__rls__client__connection.html#ga9f0c0a5a25ffee0c0bcd10bdb0ebdf97">globus_rls_client_set_timeout</a> (int seconds)</td></tr>
<tr class="separator:ga9f0c0a5a25ffee0c0bcd10bdb0ebdf97"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Functions to open and close connections to an RLS server. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga9a4bf726f4cbeef53efbe3d8c722a3d8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GLOBUS_RLS_URL_SCHEME   "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>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GLOBUS_RLS_URL_SCHEME_NOAUTH   "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>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GLOBUS_RLS_SERVER_DEFPORT   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>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MAXERRMSG   1024</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum length of error messages returned by server. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gafc13ec59c7f0bd2cd25d297928b81f02"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void globus_rls_client_certificate </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>Parameters</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>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void globus_rls_client_proxy_certificate </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>Parameters</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>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_rls_client_connect </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>Parameters</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>Return values</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>
<p>References <a class="el" href="group__globus__rls__client__status.html#gae5cf16690217ac4b05d11bf31b5328f0">GLOBUS_RLS_BADARG</a>, <a class="el" href="group__globus__rls__client__status.html#gad3351fdc8fd9b6aaeaf6d2de9ee0bc9b">GLOBUS_RLS_BADURL</a>, <a class="el" href="group__globus__rls__client__status.html#ga29476a6d45e87ddf75284ec26d47e584">GLOBUS_RLS_INVHANDLE</a>, <a class="el" href="group__globus__rls__client__status.html#ga1d862d0d75b282258bca4a6ffeb24571">GLOBUS_RLS_NOMEMORY</a>, <a class="el" href="group__globus__rls__client__connection.html#gac7584c1893f94ce33bc451e6f9e1e0c1">GLOBUS_RLS_SERVER_DEFPORT</a>, <a class="el" href="group__globus__rls__client__status.html#gac1e581eff0bff5906278155f0aa62549">GLOBUS_RLS_SUCCESS</a>, <a class="el" href="group__globus__rls__client__connection.html#ga9a4bf726f4cbeef53efbe3d8c722a3d8">GLOBUS_RLS_URL_SCHEME</a>, <a class="el" href="group__globus__rls__client__connection.html#ga0a312c5bce2b1d2f4e57e79ad9c0dd8f">GLOBUS_RLS_URL_SCHEME_NOAUTH</a>, and <a class="el" href="group__globus__rls__client__connection.html#ga6d875141188d039246ad7be71599220d">MAXERRMSG</a>.</p>
</div>
</div>
<a class="anchor" id="gaaec87d67574e91e018a4c146b36f5606"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_rls_client_close </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>Parameters</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>Return values</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>
<p>References <a class="el" href="structglobus__rls__handle__t.html#a6bf7511493e899f4830e619419757063">globus_rls_handle_t::flags</a>, <a class="el" href="group__globus__rls__client__status.html#ga29476a6d45e87ddf75284ec26d47e584">GLOBUS_RLS_INVHANDLE</a>, <a class="el" href="structglobus__rls__handle__t.html#a97c91628525224e641fb7f842a6e40b0">globus_rls_handle_t::handle</a>, and <a class="el" href="structglobus__rls__handle__t.html#aa2128e77dcc71a7e997839c8d7b46892">globus_rls_handle_t::url</a>.</p>
</div>
</div>
<a class="anchor" id="gadc8d71afbee28fb0e82ac7a22bc978cc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_rls_client_get_timeout </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>Return values</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>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void globus_rls_client_set_timeout </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>Parameters</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><!-- doc-content -->
<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>
