<!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.1.1 -->
<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>
<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>
</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__ftp__client__handleattr.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<div class="title">Handle Attributes</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gab4a1b9fd7b91ba74a5beb576ac3e307d"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
globus_i_ftp_client_handleattr_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="member-group"></a>
Initialize</h2></td></tr>
<tr class="memitem:ga55df5cb63ad06755dc9c707fb3b3197e"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handleattr.html#ga55df5cb63ad06755dc9c707fb3b3197e">globus_ftp_client_handleattr_init</a> (<a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> *attr)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="member-group"></a>
Destroy</h2></td></tr>
<tr class="memitem:ga9241a8540f0d63abada0e8b34819303e"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handleattr.html#ga9241a8540f0d63abada0e8b34819303e">globus_ftp_client_handleattr_destroy</a> (<a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> *attr)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="member-group"></a>
Copy</h2></td></tr>
<tr class="memitem:gac3ff5f312f1fe27e2cc2f4957e1f7839"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handleattr.html#gac3ff5f312f1fe27e2cc2f4957e1f7839">globus_ftp_client_handleattr_copy</a> (<a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> *dest, <a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> *src)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="member-group"></a>
Connection Caching</h2></td></tr>
<tr class="memitem:ga3292d4dbbb78248594bb8133284644e6"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handleattr.html#ga3292d4dbbb78248594bb8133284644e6">globus_ftp_client_handleattr_set_cache_all</a> (<a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> *attr, globus_bool_t cache_all)</td></tr>
<tr class="memitem:gae4c7066d66fda41c02961408c18076c2"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handleattr.html#gae4c7066d66fda41c02961408c18076c2">globus_ftp_client_handleattr_get_cache_all</a> (const <a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> *attr, globus_bool_t *cache_all)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="member-group"></a>
Non-root relative URLs</h2></td></tr>
<tr class="memitem:ga375ad9f3973a2b0941ba2329fd24393e"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handleattr.html#ga375ad9f3973a2b0941ba2329fd24393e">globus_ftp_client_handleattr_set_rfc1738_url</a> (<a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> *attr, globus_bool_t rfc1738_url)</td></tr>
<tr class="memitem:gaa0308167080fe2dbb9e5e9088348193e"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handleattr.html#gaa0308167080fe2dbb9e5e9088348193e">globus_ftp_client_handleattr_get_rfc1738_url</a> (const <a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> *attr, globus_bool_t *rfc1738_url)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="member-group"></a>
Client Info</h2></td></tr>
<tr class="memitem:gab74b321e6be17b2e75e4e746c177402a"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handleattr.html#gab74b321e6be17b2e75e4e746c177402a">globus_ftp_client_handleattr_set_clientinfo</a> (<a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> *attr, const char *app_name, const char *app_version, const char *other)</td></tr>
<tr class="memitem:ga43de108c09716cc7f66f6af67591f6d7"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handleattr.html#ga43de108c09716cc7f66f6af67591f6d7">globus_ftp_client_handleattr_get_clientinfo</a> (<a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> *attr, char **app_name, char **app_version, char **other)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="member-group"></a>
GridFTP2 support</h2></td></tr>
<tr class="memitem:ga0fa9f796498b99f940fa208a2e21d972"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handleattr.html#ga0fa9f796498b99f940fa208a2e21d972">globus_ftp_client_handleattr_set_gridftp2</a> (<a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> *attr, globus_bool_t gridftp2)</td></tr>
<tr class="memitem:gab570a1703a634e2bcd247530743511f9"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handleattr.html#gab570a1703a634e2bcd247530743511f9">globus_ftp_client_handleattr_get_gridftp2</a> (const <a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> *attr, globus_bool_t *gridftp2)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="member-group"></a>
Command Pipelining</h2></td></tr>
<tr class="memitem:ga185174b644976c44de8a3f1e24c3aa9d"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handleattr.html#ga185174b644976c44de8a3f1e24c3aa9d">globus_ftp_client_handleattr_set_pipeline</a> (<a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> *attr, globus_size_t outstanding_commands, globus_ftp_client_pipeline_callback_t pipeline_callback, void *pipeline_arg)</td></tr>
<tr class="memitem:ga605ba6cb8bb4cf6899ea721f8185e91e"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handleattr.html#ga605ba6cb8bb4cf6899ea721f8185e91e">globus_ftp_client_handleattr_get_pipeline</a> (const <a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> *attr, globus_size_t *outstanding_commands, globus_ftp_client_pipeline_callback_t *pipeline_callback, void **pipeline_arg)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="member-group"></a>
URL Caching</h2></td></tr>
<tr class="memitem:ga654dcd09a9e551b0063c981cb15cec95"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handleattr.html#ga654dcd09a9e551b0063c981cb15cec95">globus_ftp_client_handleattr_add_cached_url</a> (<a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> *attr, const char *url)</td></tr>
<tr class="memitem:ga7f22ef06fdecfe65ae64709b7ef929d0"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handleattr.html#ga7f22ef06fdecfe65ae64709b7ef929d0">globus_ftp_client_handleattr_remove_cached_url</a> (<a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> *attr, const char *url)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="member-group"></a>
Netlogger management</h2></td></tr>
<tr class="memitem:ga9b7036d64d164ada56705d1edc71e98d"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handleattr.html#ga9b7036d64d164ada56705d1edc71e98d">globus_ftp_client_handleattr_set_netlogger</a> (<a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> *attr, globus_netlogger_handle_t *nl_handle)</td></tr>
<tr class="memitem:ga95b7d4f10cb728411c54fe83c35e672c"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handleattr.html#ga95b7d4f10cb728411c54fe83c35e672c">globus_ftp_client_handleattr_set_netlogger_ftp_io</a> (<a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> *attr, globus_netlogger_handle_t *nl_handle, globus_bool_t ftp, globus_bool_t io)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="member-group"></a>
Plugin Management</h2></td></tr>
<tr class="memitem:ga77e24c2d75f9c847167179958fa28998"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handleattr.html#ga77e24c2d75f9c847167179958fa28998">globus_ftp_client_handleattr_add_plugin</a> (<a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> *attr, <a class="el" href="group__globus__ftp__client__plugins.html#gafd650bbeee4bf50b94275d89352697dc">globus_ftp_client_plugin_t</a> *plugin)</td></tr>
<tr class="memitem:ga4ecb53ff8b985af31ad384f9ea5f31db"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handleattr.html#ga4ecb53ff8b985af31ad384f9ea5f31db">globus_ftp_client_handleattr_remove_plugin</a> (<a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> *attr, <a class="el" href="group__globus__ftp__client__plugins.html#gafd650bbeee4bf50b94275d89352697dc">globus_ftp_client_plugin_t</a> *plugin)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Handle attributes are used to control additional features of the FTP Client handle. </p>
<p>These features are operation independent.</p>
<p>The attribute which can currently set on a handle concern the connection caching behavior of the handle, and the associations of plugins with a handle.</p>
<dl class="section see"><dt>See also:</dt><dd><a class="el" href="group__globus__ftp__client__handle.html#ga9d8a98c88d529ab539c2fedee545f172" title="FTP Client Handle.">globus_ftp_client_handle_t</a> </dd></dl>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="gab4a1b9fd7b91ba74a5beb576ac3e307d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct globus_i_ftp_client_handleattr_t* <a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Handle Attributes. </p>
<p>Handle attributes are used to control the caching behavior of the ftp client handle, and to implement the plugin features for reliability and performance tuning.</p>
<dl class="section see"><dt>See also:</dt><dd><a class="el" href="group__globus__ftp__client__handle.html#ga9d8a98c88d529ab539c2fedee545f172" title="FTP Client Handle.">globus_ftp_client_handle_t</a>, <a class="el" href="group__globus__ftp__client__handleattr.html">Handle Attributes</a> </dd></dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga55df5cb63ad06755dc9c707fb3b3197e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_ftp_client_handleattr_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> * </td>
<td class="paramname"><em>attr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize an FTP client handle attribute set. </p>
<p>This function creates an empty FTP Client handle attribute set. This function must be called on each attribute set before any of the other functions in this section may be called.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>The new handle attribute.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also:</dt><dd><a class="el" href="group__globus__ftp__client__handleattr.html#ga9241a8540f0d63abada0e8b34819303e" title="Destroy an FTP client handle attribute set.">globus_ftp_client_handleattr_destroy()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga9241a8540f0d63abada0e8b34819303e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_ftp_client_handleattr_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> * </td>
<td class="paramname"><em>attr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy an FTP client handle attribute set. </p>
<p>This function destroys an ftp client handle attribute set. All attributes on this set will be lost. The user must call <a class="el" href="group__globus__ftp__client__handleattr.html#ga55df5cb63ad06755dc9c707fb3b3197e" title="Initialize an FTP client handle attribute set.">globus_ftp_client_handleattr_init()</a> again on this attribute set before calling any other handle attribute functions on it.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>The attribute set to destroy. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gac3ff5f312f1fe27e2cc2f4957e1f7839"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_ftp_client_handleattr_copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> * </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> * </td>
<td class="paramname"><em>src</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a duplicate of a handle attribute set. </p>
<p>The duplicated attribute set has a deep copy of all data in the attribute set, so the original may be destroyed while the copy is still valid.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">dest</td><td>The attribute set to be initialized to the same values as src. </td></tr>
<tr><td class="paramname">src</td><td>The original attribute set to duplicate. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga3292d4dbbb78248594bb8133284644e6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_ftp_client_handleattr_set_cache_all </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> * </td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_bool_t </td>
<td class="paramname"><em>cache_all</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set/Get the cache all connections attribute for an ftp client handle attribute set. </p>
<p>This attribute allows the user to cause all control connections to be cached between ftp operations. When this is enabled, the user skips the authentication handshake and connection establishment overhead for multiple subsequent ftp operations to the same server.</p>
<p>Memory and network connections associated with the caching will be used until the handle is destroyed. If fine grained caching is needed, then the user should disable this attribute and explicitly cache specific URLs.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>Attribute to query or modify. </td></tr>
<tr><td class="paramname">cache_all</td><td>Value of the cache_all attribute.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also:</dt><dd><a class="el" href="group__globus__ftp__client__handleattr.html#ga654dcd09a9e551b0063c981cb15cec95" title="Enable/Disable caching for a specific URL.">globus_ftp_client_handleattr_add_cached_url()</a>, <a class="el" href="group__globus__ftp__client__handleattr.html#ga7f22ef06fdecfe65ae64709b7ef929d0" title="Enable/Disable caching for a specific URL.">globus_ftp_client_handleattr_remove_cached_url()</a>, <a class="el" href="group__globus__ftp__client__handle.html#ga49ebfa81faf91c86513565853ee67be9" title="Cache connections to an FTP server.">globus_ftp_client_handle_cache_url_state()</a> <a class="el" href="group__globus__ftp__client__handle.html#gaf05a75915388b3fea5352ca5916d46a0" title="Remove a cached connection from the FTP client handle.">globus_ftp_client_handle_flush_url_state()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga375ad9f3973a2b0941ba2329fd24393e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_ftp_client_handleattr_set_rfc1738_url </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> * </td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_bool_t </td>
<td class="paramname"><em>rfc1738_url</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable/Disable rfc1738 support for non-root relative URLs. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>Attribute to modify </td></tr>
<tr><td class="paramname">rfc1738_url</td><td>Set to GLOBUS_TRUE to enable non-root relative URLs. Default of GLOBUS_FALSE specifies root-relative URLs. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gab74b321e6be17b2e75e4e746c177402a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_ftp_client_handleattr_set_clientinfo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> * </td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>app_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>app_version</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>other</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set/Get client info reported to server. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>Attribute to modify </td></tr>
<tr><td class="paramname">app_name</td><td>Name of client application. </td></tr>
<tr><td class="paramname">app_version</td><td>Client application specific version string. </td></tr>
<tr><td class="paramname">other</td><td>Additional client info to be reported to the server. This may be used to pass custom info to a custom server module. The format of the string must be: key1="value1";key2="value2";[keyn="valuen";]</td></tr>
</table>
</dd>
</dl>
<p>Any parameter may be NULL. By default, generic library info will be reported to the server – set all NULL to disable this. </p>
</div>
</div>
<a class="anchor" id="ga0fa9f796498b99f940fa208a2e21d972"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_ftp_client_handleattr_set_gridftp2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> * </td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_bool_t </td>
<td class="paramname"><em>gridftp2</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable/Disable GridFTP2 [GFD.41] support for servers supporting it. </p>
<p>This currently only applies to the GET/PUT command.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>Attribute to modify </td></tr>
<tr><td class="paramname">gridftp2</td><td>Set to GLOBUS_FALSE to disable GridFTP2 support. GridFTP2 support is enabled by default for servers that support it. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga185174b644976c44de8a3f1e24c3aa9d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_ftp_client_handleattr_set_pipeline </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> * </td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_size_t </td>
<td class="paramname"><em>outstanding_commands</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_ftp_client_pipeline_callback_t </td>
<td class="paramname"><em>pipeline_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>pipeline_arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable/Disable command queueing for pipelined transfers. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>Attribute to modify </td></tr>
<tr><td class="paramname">outstanding_commands</td><td>Set to the number of commands to have sent without receiving a reply. Use 0 for the library default. </td></tr>
<tr><td class="paramname">pipeline_callback</td><td>Set to a function of type globus_ftp_client_pipeline_callback_t to enable command pipelining. This function will be called during a transfer operation to request the next urls to be transferred. </td></tr>
<tr><td class="paramname">pipeline_arg</td><td>User data that will be passed in the pipeline_callback. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga654dcd09a9e551b0063c981cb15cec95"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_ftp_client_handleattr_add_cached_url </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> * </td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>url</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable/Disable caching for a specific URL. </p>
<p>This function adds/removes the specified URL into the default cache for a handle attribute. Handles initialized with this attr will keep connections to FTP servers associated with the URLs in its cache open between <a class="el" href="group__globus__ftp__client__operations.html">operations </a>.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>Attribute to modify </td></tr>
<tr><td class="paramname">url</td><td>URL string to cache </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga7f22ef06fdecfe65ae64709b7ef929d0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_ftp_client_handleattr_remove_cached_url </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> * </td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>url</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable/Disable caching for a specific URL. </p>
<p>This function adds/removes the specified URL into the default cache for a handle attribute. Handles initialized with this attr will keep connections to FTP servers associated with the URLs in its cache open between <a class="el" href="group__globus__ftp__client__operations.html">operations </a>.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>Attribute to modify </td></tr>
<tr><td class="paramname">url</td><td>URL string to cache </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga9b7036d64d164ada56705d1edc71e98d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_ftp_client_handleattr_set_netlogger </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> * </td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_netlogger_handle_t * </td>
<td class="paramname"><em>nl_handle</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the netlogger handle used with this transfer. </p>
<p>Each handle can have a netlogger handle associated with it for logging its data.</p>
<p>Only 1 netlogger handle can be associated with a client handle.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>The attribute set to modify. </td></tr>
<tr><td class="paramname">nl_handle</td><td>The open netlogger handle to be associated with this attribute set. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga77e24c2d75f9c847167179958fa28998"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_ftp_client_handleattr_add_plugin </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> * </td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__globus__ftp__client__plugins.html#gafd650bbeee4bf50b94275d89352697dc">globus_ftp_client_plugin_t</a> * </td>
<td class="paramname"><em>plugin</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add/Remove a plugin to a handle attribute set. </p>
<p>Each handle attribute set contains a list of plugins associated with it. When a handle is created with a particular attribute set, it will be associated with a copy of those plugins.</p>
<p>Only one instance of a specific plugin may be added to an attribute set. Each plugin must have a different name.</p>
<p>A copy of the plugin is created via the plugins 'copy' method when it is added to an attribute set. Thus, any changes to a particular plugin must be done before the plugin is added to an attribute set, and before the attribute set is used to create handles.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>The attribute set to modify. </td></tr>
<tr><td class="paramname">plugin</td><td>The plugin to add or remove from the list. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gae4c7066d66fda41c02961408c18076c2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_ftp_client_handleattr_get_cache_all </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> * </td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_bool_t * </td>
<td class="paramname"><em>cache_all</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set/Get the cache all connections attribute for an ftp client handle attribute set. </p>
<p>This attribute allows the user to cause all control connections to be cached between ftp operations. When this is enabled, the user skips the authentication handshake and connection establishment overhead for multiple subsequent ftp operations to the same server.</p>
<p>Memory and network connections associated with the caching will be used until the handle is destroyed. If fine grained caching is needed, then the user should disable this attribute and explicitly cache specific URLs.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>Attribute to query or modify. </td></tr>
<tr><td class="paramname">cache_all</td><td>Value of the cache_all attribute.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also:</dt><dd><a class="el" href="group__globus__ftp__client__handleattr.html#ga654dcd09a9e551b0063c981cb15cec95" title="Enable/Disable caching for a specific URL.">globus_ftp_client_handleattr_add_cached_url()</a>, <a class="el" href="group__globus__ftp__client__handleattr.html#ga7f22ef06fdecfe65ae64709b7ef929d0" title="Enable/Disable caching for a specific URL.">globus_ftp_client_handleattr_remove_cached_url()</a>, <a class="el" href="group__globus__ftp__client__handle.html#ga49ebfa81faf91c86513565853ee67be9" title="Cache connections to an FTP server.">globus_ftp_client_handle_cache_url_state()</a> <a class="el" href="group__globus__ftp__client__handle.html#gaf05a75915388b3fea5352ca5916d46a0" title="Remove a cached connection from the FTP client handle.">globus_ftp_client_handle_flush_url_state()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaa0308167080fe2dbb9e5e9088348193e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_ftp_client_handleattr_get_rfc1738_url </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> * </td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_bool_t * </td>
<td class="paramname"><em>rfc1738_url</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable/Disable rfc1738 support for non-root relative URLs. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>Attribute to modify </td></tr>
<tr><td class="paramname">rfc1738_url</td><td>Set to GLOBUS_TRUE to enable non-root relative URLs. Default of GLOBUS_FALSE specifies root-relative URLs. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga43de108c09716cc7f66f6af67591f6d7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_ftp_client_handleattr_get_clientinfo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> * </td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>app_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>app_version</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>other</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set/Get client info reported to server. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>Attribute to modify </td></tr>
<tr><td class="paramname">app_name</td><td>Name of client application. </td></tr>
<tr><td class="paramname">app_version</td><td>Client application specific version string. </td></tr>
<tr><td class="paramname">other</td><td>Additional client info to be reported to the server. This may be used to pass custom info to a custom server module. The format of the string must be: key1="value1";key2="value2";[keyn="valuen";]</td></tr>
</table>
</dd>
</dl>
<p>Any parameter may be NULL. By default, generic library info will be reported to the server – set all NULL to disable this. </p>
</div>
</div>
<a class="anchor" id="gab570a1703a634e2bcd247530743511f9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_ftp_client_handleattr_get_gridftp2 </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> * </td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_bool_t * </td>
<td class="paramname"><em>gridftp2</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable/Disable GridFTP2 [GFD.41] support for servers supporting it. </p>
<p>This currently only applies to the GET/PUT command.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>Attribute to modify </td></tr>
<tr><td class="paramname">gridftp2</td><td>Set to GLOBUS_FALSE to disable GridFTP2 support. GridFTP2 support is enabled by default for servers that support it. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga605ba6cb8bb4cf6899ea721f8185e91e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_ftp_client_handleattr_get_pipeline </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> * </td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_size_t * </td>
<td class="paramname"><em>outstanding_commands</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_ftp_client_pipeline_callback_t * </td>
<td class="paramname"><em>pipeline_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void ** </td>
<td class="paramname"><em>pipeline_arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable/Disable command queueing for pipelined transfers. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>Attribute to modify </td></tr>
<tr><td class="paramname">outstanding_commands</td><td>Set to the number of commands to have sent without receiving a reply. Use 0 for the library default. </td></tr>
<tr><td class="paramname">pipeline_callback</td><td>Set to a function of type globus_ftp_client_pipeline_callback_t to enable command pipelining. This function will be called during a transfer operation to request the next urls to be transferred. </td></tr>
<tr><td class="paramname">pipeline_arg</td><td>User data that will be passed in the pipeline_callback. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga95b7d4f10cb728411c54fe83c35e672c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_ftp_client_handleattr_set_netlogger_ftp_io </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> * </td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_netlogger_handle_t * </td>
<td class="paramname"><em>nl_handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_bool_t </td>
<td class="paramname"><em>ftp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_bool_t </td>
<td class="paramname"><em>io</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the netlogger handle used with this transfer. </p>
<p>Each handle can have a netlogger handle associated with it for logging its data.</p>
<p>Only 1 netlogger handle can be associated with a client handle.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>The attribute set to modify. </td></tr>
<tr><td class="paramname">nl_handle</td><td>The open netlogger handle to be associated with this attribute set. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga4ecb53ff8b985af31ad384f9ea5f31db"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_ftp_client_handleattr_remove_plugin </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">globus_ftp_client_handleattr_t</a> * </td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__globus__ftp__client__plugins.html#gafd650bbeee4bf50b94275d89352697dc">globus_ftp_client_plugin_t</a> * </td>
<td class="paramname"><em>plugin</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add/Remove a plugin to a handle attribute set. </p>
<p>Each handle attribute set contains a list of plugins associated with it. When a handle is created with a particular attribute set, it will be associated with a copy of those plugins.</p>
<p>Only one instance of a specific plugin may be added to an attribute set. Each plugin must have a different name.</p>
<p>A copy of the plugin is created via the plugins 'copy' method when it is added to an attribute set. Thus, any changes to a particular plugin must be done before the plugin is added to an attribute set, and before the attribute set is used to create handles.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>The attribute set to modify. </td></tr>
<tr><td class="paramname">plugin</td><td>The plugin to add or remove from the list. </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>
