<!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__handle.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 Management</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:ga9d8a98c88d529ab539c2fedee545f172"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
globus_i_ftp_client_handle_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handle.html#ga9d8a98c88d529ab539c2fedee545f172">globus_ftp_client_handle_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:ga571af4a23e8985f9b36e2df3320fdd1d"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handle.html#ga571af4a23e8985f9b36e2df3320fdd1d">globus_ftp_client_handle_init</a> (<a class="el" href="group__globus__ftp__client__handle.html#ga9d8a98c88d529ab539c2fedee545f172">globus_ftp_client_handle_t</a> *handle, <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:gac40005934089e52e63d5588d53a468d6"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handle.html#gac40005934089e52e63d5588d53a468d6">globus_ftp_client_handle_destroy</a> (<a class="el" href="group__globus__ftp__client__handle.html#ga9d8a98c88d529ab539c2fedee545f172">globus_ftp_client_handle_t</a> *handle)</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:ga49ebfa81faf91c86513565853ee67be9"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handle.html#ga49ebfa81faf91c86513565853ee67be9">globus_ftp_client_handle_cache_url_state</a> (<a class="el" href="group__globus__ftp__client__handle.html#ga9d8a98c88d529ab539c2fedee545f172">globus_ftp_client_handle_t</a> *handle, const char *url)</td></tr>
<tr class="memitem:gaf05a75915388b3fea5352ca5916d46a0"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handle.html#gaf05a75915388b3fea5352ca5916d46a0">globus_ftp_client_handle_flush_url_state</a> (<a class="el" href="group__globus__ftp__client__handle.html#ga9d8a98c88d529ab539c2fedee545f172">globus_ftp_client_handle_t</a> *handle, const char *url)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="member-group"></a>
User Pointer</h2></td></tr>
<tr class="memitem:ga6a5d89fc09d6a14ba6a21bea66f6dccf"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handle.html#ga6a5d89fc09d6a14ba6a21bea66f6dccf">globus_ftp_client_handle_set_user_pointer</a> (<a class="el" href="group__globus__ftp__client__handle.html#ga9d8a98c88d529ab539c2fedee545f172">globus_ftp_client_handle_t</a> *handle, void *user_pointer)</td></tr>
<tr class="memitem:ga654a0a64b067d9812dfbb12f3ce4e432"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handle.html#ga654a0a64b067d9812dfbb12f3ce4e432">globus_ftp_client_handle_get_user_pointer</a> (const <a class="el" href="group__globus__ftp__client__handle.html#ga9d8a98c88d529ab539c2fedee545f172">globus_ftp_client_handle_t</a> *handle, void **user_pointer)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="member-group"></a>
Plugins</h2></td></tr>
<tr class="memitem:gad03aab00efba8184f9034b2b7655c2c6"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handle.html#gad03aab00efba8184f9034b2b7655c2c6">globus_ftp_client_handle_add_plugin</a> (<a class="el" href="group__globus__ftp__client__handle.html#ga9d8a98c88d529ab539c2fedee545f172">globus_ftp_client_handle_t</a> *handle, <a class="el" href="group__globus__ftp__client__plugins.html#gafd650bbeee4bf50b94275d89352697dc">globus_ftp_client_plugin_t</a> *plugin)</td></tr>
<tr class="memitem:ga45839469104a73e39c626ce1e3848b9d"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__ftp__client__handle.html#ga45839469104a73e39c626ce1e3848b9d">globus_ftp_client_handle_remove_plugin</a> (<a class="el" href="group__globus__ftp__client__handle.html#ga9d8a98c88d529ab539c2fedee545f172">globus_ftp_client_handle_t</a> *handle, <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>Create/Destroy/Modify an FTP Client Handle. </p>
<p>Within the Globus FTP Client Library, all FTP operations require a handle parameter. Currently, only one FTP operation may be in progress at once per FTP handle. FTP connections may be cached between FTP operations, for improved performance.</p>
<p>This section defines operations to create and destroy FTP Client handles, as well as to modify handles' connection caches. </p>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="ga9d8a98c88d529ab539c2fedee545f172"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct globus_i_ftp_client_handle_t* <a class="el" href="group__globus__ftp__client__handle.html#ga9d8a98c88d529ab539c2fedee545f172">globus_ftp_client_handle_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>FTP Client Handle. </p>
<p>An FTP client handle is used to associate state with a group of operations. Handles can have <a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d">attributes</a> associated with them. All FTP <a class="el" href="group__globus__ftp__client__operations.html">operations </a> take a handle pointer as a parameter.</p>
<dl class="section see"><dt>See also:</dt><dd><a class="el" href="group__globus__ftp__client__handle.html#ga571af4a23e8985f9b36e2df3320fdd1d" title="Initialize a client FTP handle.">globus_ftp_client_handle_init()</a>, <a class="el" href="group__globus__ftp__client__handle.html#gac40005934089e52e63d5588d53a468d6" title="Destroy a client FTP handle.">globus_ftp_client_handle_destroy()</a>, <a class="el" href="group__globus__ftp__client__handleattr.html#gab4a1b9fd7b91ba74a5beb576ac3e307d" title="Handle Attributes.">globus_ftp_client_handleattr_t</a> </dd></dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga571af4a23e8985f9b36e2df3320fdd1d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_ftp_client_handle_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__ftp__client__handle.html#ga9d8a98c88d529ab539c2fedee545f172">globus_ftp_client_handle_t</a> * </td>
<td class="paramname"><em>handle</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>attr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize a client FTP handle. </p>
<p>Initialize an FTP handle which can be used in subsequent get, put, or transfer requests. A handle may have at most one get, put, or third-party transfer in progress.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The handle to be initialized. </td></tr>
<tr><td class="paramname">attr</td><td>Initial attributes to be used to create this handle.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also:</dt><dd><a class="el" href="group__globus__ftp__client__handle.html#gac40005934089e52e63d5588d53a468d6" title="Destroy a client FTP handle.">globus_ftp_client_handle_destroy()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gac40005934089e52e63d5588d53a468d6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_ftp_client_handle_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__ftp__client__handle.html#ga9d8a98c88d529ab539c2fedee545f172">globus_ftp_client_handle_t</a> * </td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy a client FTP handle. </p>
<p>A FTP client handle may not be destroyed if a get, put, or third-party transfer is in progress.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The handle to be destroyed.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also:</dt><dd><a class="el" href="group__globus__ftp__client__handle.html#ga571af4a23e8985f9b36e2df3320fdd1d" title="Initialize a client FTP handle.">globus_ftp_client_handle_init()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga49ebfa81faf91c86513565853ee67be9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_ftp_client_handle_cache_url_state </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__ftp__client__handle.html#ga9d8a98c88d529ab539c2fedee545f172">globus_ftp_client_handle_t</a> * </td>
<td class="paramname"><em>handle</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>Cache connections to an FTP server. </p>
<p>Explicitly cache connections to URL server in an FTP handle. When an URL is cached, the client library will not close the connection to the URL server after a file transfer completes.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>Handle which will contain a cached connection to the URL server. </td></tr>
<tr><td class="paramname">url</td><td>The URL of the FTP or GSIFTP server to cache.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also:</dt><dd>globus_ftp_client_flush_url_state() </dd></dl>
</div>
</div>
<a class="anchor" id="gaf05a75915388b3fea5352ca5916d46a0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_ftp_client_handle_flush_url_state </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__ftp__client__handle.html#ga9d8a98c88d529ab539c2fedee545f172">globus_ftp_client_handle_t</a> * </td>
<td class="paramname"><em>handle</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>Remove a cached connection from the FTP client handle. </p>
<p>Explicitly remove a cached connection to an FTP server from the FTP handle. If an idle connection to an FTP server exists, it will be closed.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>Handle which will contain a cached connection to the URL server. </td></tr>
<tr><td class="paramname">url</td><td>The URL of the FTP or GSIFTP server to cache. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga6a5d89fc09d6a14ba6a21bea66f6dccf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_ftp_client_handle_set_user_pointer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__ftp__client__handle.html#ga9d8a98c88d529ab539c2fedee545f172">globus_ftp_client_handle_t</a> * </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>user_pointer</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set/Get the user pointer field from an ftp client handle. </p>
<p>The user pointer is provided to all the user of the FTP client library to assocate a pointer to any application-specific data to an FTP client handle. This pointer is never internally used by the client library.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The FTP client handle to set or query. </td></tr>
<tr><td class="paramname">user_pointer</td><td>The value of the user pointer field.</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note:</dt><dd>Access to the user_pointer are not synchronized, the user must take care to make sure that multiple threads are not modifying it's value. </dd></dl>
</div>
</div>
<a class="anchor" id="gad03aab00efba8184f9034b2b7655c2c6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_ftp_client_handle_add_plugin </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__ftp__client__handle.html#ga9d8a98c88d529ab539c2fedee545f172">globus_ftp_client_handle_t</a> * </td>
<td class="paramname"><em>handle</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 a plugin to an FTP client handle. </p>
<p>This function adds a plugin to an FTP client handle after it has been created. Plugins may be added to an ftp client handle whenever an operation is not in progress. The plugin will be appended to the list of plugins present in the handle, and will be invoked during any subsequent operations processed with this handle.</p>
<p>Only one instance of a particular plugin may be added to a particular handle.</p>
<p>Plugins may be removed from a handle by calling globus_ftp_client_remove_plugin().</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The FTP client handle to set or query. </td></tr>
<tr><td class="paramname">plugin</td><td>A pointer to the plugin structure to add to this handle. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also:</dt><dd>globus_ftp_client_remove_plugin(), globus_ftp_clent_handleattr_add_plugin(), globus_ftp_clent_handleattr_remove_plugin() </dd></dl>
</div>
</div>
<a class="anchor" id="ga45839469104a73e39c626ce1e3848b9d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_ftp_client_handle_remove_plugin </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__ftp__client__handle.html#ga9d8a98c88d529ab539c2fedee545f172">globus_ftp_client_handle_t</a> * </td>
<td class="paramname"><em>handle</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>Remove a plugin to an FTP client handle. </p>
<p>This function removes a plugin from an FTP client handle after it has been created. Plugins may be removed from an ftp client handle whenever an operation is not in progress. The plugin will be removed from the list of plugins, and will not be used during any subsequent operations processed with this handle.</p>
<p>This function can remove plugins which were added at <a class="el" href="group__globus__ftp__client__handle.html#ga571af4a23e8985f9b36e2df3320fdd1d">handle initialization time</a> or by calling <a class="el" href="group__globus__ftp__client__handle.html#gad03aab00efba8184f9034b2b7655c2c6" title="Add a plugin to an FTP client handle.">globus_ftp_client_handle_add_plugin()</a>.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The FTP client handle to set or query. </td></tr>
<tr><td class="paramname">plugin</td><td>A pointer to the plugin structure to remove from this handle.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also:</dt><dd>globus_ftp_client_add_plugin(), globus_ftp_clent_handleattr_add_plugin(), globus_ftp_clent_handleattr_remove_plugin() </dd></dl>
</div>
</div>
<a class="anchor" id="ga654a0a64b067d9812dfbb12f3ce4e432"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_ftp_client_handle_get_user_pointer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__globus__ftp__client__handle.html#ga9d8a98c88d529ab539c2fedee545f172">globus_ftp_client_handle_t</a> * </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void ** </td>
<td class="paramname"><em>user_pointer</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set/Get the user pointer field from an ftp client handle. </p>
<p>The user pointer is provided to all the user of the FTP client library to assocate a pointer to any application-specific data to an FTP client handle. This pointer is never internally used by the client library.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The FTP client handle to set or query. </td></tr>
<tr><td class="paramname">user_pointer</td><td>The value of the user pointer field.</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note:</dt><dd>Access to the user_pointer are not synchronized, the user must take care to make sure that multiple threads are not modifying it's value. </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>
