/**
* Destroy an instance of the GridFTP restart plugin
* @ingroup globus_ftp_client_restart_plugin
*
* This function will free all restart plugin-specific instance data
* from this plugin, and will make the plugin unusable for further ftp
* handle creation.
*
* Existing FTP client handles and handle attributes will not be affected by
* destroying a plugin associated with them, as a local copy of the plugin
* is made upon handle initialization.
*
* @param plugin
* A pointer to a GridFTP restart plugin, previously initialized by
* calling globus_ftp_client_restart_plugin_init()
*
* @return This function returns an error if
* - plugin is null
* - plugin is not a restart plugin
*
* @see globus_ftp_client_restart_plugin_init(),
* globus_ftp_client_handleattr_add_plugin(),
* globus_ftp_client_handleattr_remove_plugin(),
* globus_ftp_client_handle_init()
*/
globus_result_t
globus_ftp_client_restart_plugin_destroy(
globus_ftp_client_plugin_t * plugin)
{
globus_l_ftp_client_restart_plugin_t * d;
globus_result_t result;
GlobusFuncName(globus_ftp_client_restart_plugin_destroy);
GLOBUS_L_FTP_CLIENT_RESTART_PLUGIN_RETURN(plugin);
result = globus_ftp_client_plugin_get_plugin_specific(plugin,
(void **) &d);
if(result != GLOBUS_SUCCESS)
{
return result;
}
globus_l_ftp_client_restart_plugin_genericify(d);
if(d->ticker_set)
{
d->ticker_set = GLOBUS_FALSE;
/* XXX where is d freed? if was a previous leak free in l_ticker_done */
globus_callback_unregister(
d->ticker_handle, l_ticker_done, d, NULL);
}
else
{
/* XXX free d here ? */
globus_free(d);
}
return globus_ftp_client_plugin_destroy(plugin);
}
globus_result_t
globus_ftp_client_restart_marker_plugin_destroy(
globus_ftp_client_plugin_t * plugin)
{
globus_result_t result;
restart_marker_plugin_info_t * ps;
GlobusFuncName(globus_ftp_client_restart_marker_plugin_destroy);
if(plugin == GLOBUS_NULL)
{
return globus_error_put(globus_error_construct_string(
GLOBUS_FTP_CLIENT_MODULE,
GLOBUS_NULL,
"[%s] NULL plugin at %s\n",
GLOBUS_FTP_CLIENT_MODULE->module_name,
_globus_func_name));
}
result = globus_ftp_client_plugin_get_plugin_specific(
plugin,
(void **) (void *) &ps);
if(result != GLOBUS_SUCCESS)
{
return result;
}
if(ps->error_obj)
{
globus_object_free(ps->error_obj);
ps->error_obj = GLOBUS_NULL;
}
if(ps->error_url)
{
globus_libc_free(ps->error_url);
ps->error_url = GLOBUS_NULL;
}
globus_mutex_destroy(&ps->lock);
globus_free(ps);
return globus_ftp_client_plugin_destroy(plugin);
}
/**
* Initialize an instance of the GridFTP restart plugin
* @ingroup globus_ftp_client_restart_plugin
*
* This function will initialize the plugin-specific instance data
* for this plugin, and will make the plugin usable for ftp
* client handle attribute and handle creation.
*
* @param plugin
* A pointer to an uninitialized plugin. The plugin will be
* configured as a restart plugin.
* @param max_retries
* The maximum number of times to retry the operation before giving
* up on the transfer. If this value is less than or equal to 0,
* then the restart plugin will keep trying to restart the operation
* until it completes or the deadline is reached with an unsuccessful
* operation.
* @param interval
* The interval to wait after a failures before retrying the transfer.
* If the interval is 0 seconds or GLOBUS_NULL, then an exponential
* backoff will be used.
* @param deadline
* An absolute timeout. If the deadline is GLOBUS_NULL then the retry
* will never timeout.
*
* @return This function returns an error if
* - plugin is null
*
* @see globus_ftp_client_restart_plugin_destroy(),
* globus_ftp_client_handleattr_add_plugin(),
* globus_ftp_client_handleattr_remove_plugin(),
* globus_ftp_client_handle_init()
*/
globus_result_t
globus_ftp_client_restart_plugin_init(
globus_ftp_client_plugin_t * plugin,
int max_retries,
globus_reltime_t * interval,
globus_abstime_t * deadline)
{
char * env_str;
globus_l_ftp_client_restart_plugin_t * d;
globus_result_t result;
GlobusFuncName(globus_ftp_client_restart_plugin_init);
if(plugin == GLOBUS_NULL)
{
return globus_error_put(globus_error_construct_string(
GLOBUS_FTP_CLIENT_MODULE,
GLOBUS_NULL,
"[%s] NULL plugin at %s\n",
GLOBUS_FTP_CLIENT_MODULE->module_name,
_globus_func_name));
}
d =
globus_libc_calloc(1, sizeof(globus_l_ftp_client_restart_plugin_t));
if(! d)
{
return globus_error_put(globus_error_construct_string(
GLOBUS_FTP_CLIENT_MODULE,
GLOBUS_NULL,
"[%s] Out of memory at %s\n",
GLOBUS_FTP_CLIENT_MODULE->module_name,
_globus_func_name));
}
result = globus_ftp_client_plugin_init(plugin,
GLOBUS_L_FTP_CLIENT_RESTART_PLUGIN_NAME,
GLOBUS_FTP_CLIENT_CMD_MASK_ALL,
d);
if(result != GLOBUS_SUCCESS)
{
globus_libc_free(d);
return result;
}
d->max_retries = max_retries > 0 ? max_retries : -1;
if(interval)
{
GlobusTimeReltimeCopy(d->interval, *interval);
}
if((!interval) || (interval->tv_sec == 0 && interval->tv_usec == 0))
{
d->backoff = GLOBUS_TRUE;
d->interval.tv_sec = 1;
d->interval.tv_usec = 0;
}
else
{
d->backoff = GLOBUS_FALSE;
}
if(deadline)
{
GlobusTimeAbstimeCopy(d->deadline, *deadline);
}
else
{
GlobusTimeAbstimeCopy(d->deadline, globus_i_abstime_infinity);
}
d->dest_url = GLOBUS_NULL;
d->source_url = GLOBUS_NULL;
GLOBUS_FTP_CLIENT_RESTART_PLUGIN_SET_FUNC(plugin, copy);
GLOBUS_FTP_CLIENT_RESTART_PLUGIN_SET_FUNC(plugin, destroy);
GLOBUS_FTP_CLIENT_RESTART_PLUGIN_SET_FUNC(plugin, chmod);
GLOBUS_FTP_CLIENT_RESTART_PLUGIN_SET_FUNC(plugin, cksm);
GLOBUS_FTP_CLIENT_RESTART_PLUGIN_SET_FUNC(plugin, delete);
GLOBUS_FTP_CLIENT_RESTART_PLUGIN_SET_FUNC(plugin, modification_time);
GLOBUS_FTP_CLIENT_RESTART_PLUGIN_SET_FUNC(plugin, size);
GLOBUS_FTP_CLIENT_RESTART_PLUGIN_SET_FUNC(plugin, feat);
GLOBUS_FTP_CLIENT_RESTART_PLUGIN_SET_FUNC(plugin, mkdir);
GLOBUS_FTP_CLIENT_RESTART_PLUGIN_SET_FUNC(plugin, rmdir);
GLOBUS_FTP_CLIENT_RESTART_PLUGIN_SET_FUNC(plugin, move);
GLOBUS_FTP_CLIENT_RESTART_PLUGIN_SET_FUNC(plugin, verbose_list);
GLOBUS_FTP_CLIENT_RESTART_PLUGIN_SET_FUNC(plugin, machine_list);
GLOBUS_FTP_CLIENT_RESTART_PLUGIN_SET_FUNC(plugin, mlst);
GLOBUS_FTP_CLIENT_RESTART_PLUGIN_SET_FUNC(plugin, stat);
GLOBUS_FTP_CLIENT_RESTART_PLUGIN_SET_FUNC(plugin, list);
GLOBUS_FTP_CLIENT_RESTART_PLUGIN_SET_FUNC(plugin, get);
GLOBUS_FTP_CLIENT_RESTART_PLUGIN_SET_FUNC(plugin, put);
GLOBUS_FTP_CLIENT_RESTART_PLUGIN_SET_FUNC(plugin, third_party_transfer);
GLOBUS_FTP_CLIENT_RESTART_PLUGIN_SET_FUNC(plugin, fault);
GLOBUS_FTP_CLIENT_RESTART_PLUGIN_SET_FUNC(plugin, abort);
GLOBUS_FTP_CLIENT_RESTART_PLUGIN_SET_FUNC(plugin, complete);
GLOBUS_FTP_CLIENT_RESTART_PLUGIN_SET_FUNC(plugin, data);
GLOBUS_FTP_CLIENT_RESTART_PLUGIN_SET_FUNC(plugin,
response);
env_str = globus_libc_getenv("GUC_STALL_TIMEOUT");
if(env_str != NULL)
{
int sc;
int to_secs;
sc = sscanf(env_str, "%d", &to_secs);
if(sc == 1)
{
globus_ftp_client_restart_plugin_set_stall_timeout(
plugin, to_secs);
}
}
return GLOBUS_SUCCESS;
result_exit:
globus_ftp_client_plugin_destroy(plugin);
return result;
}
