.TH "globus_ftp_client_restart_plugin" 3 "Tue Jul 5 2022" "Version 9.8" "globus_ftp_client" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_ftp_client_restart_plugin \- Restart Plugin
.PP
 \- Restart Plugin\&.  

.SH SYNOPSIS
.br
.PP
.SS "Macros"

.in +1c
.ti -1c
.RI "#define \fBGLOBUS_FTP_CLIENT_RESTART_PLUGIN_MODULE\fP           (&globus_i_ftp_client_restart_plugin_module)"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "globus_result_t \fBglobus_ftp_client_restart_plugin_init\fP (\fBglobus_ftp_client_plugin_t\fP *plugin, int max_retries, globus_reltime_t *interval, globus_abstime_t *deadline)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_ftp_client_restart_plugin_destroy\fP (\fBglobus_ftp_client_plugin_t\fP *plugin)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Restart Plugin\&. 

The restart plugin implements one scheme for providing reliability functionality for the FTP Client library\&. Other plugins may be developed to provide other methods of reliability\&.
.PP
The specific functionality of this plugin is to restart any FTP operation when a fault occurs\&. The plugin's operation is parameterized to control how often and when to attempt to restart the operation\&.
.PP
This restart plugin will restart an FTP operation if a noticeable fault has occurred---a connection timing out, a failure by the server to process a command, a protocol error, an authentication error\&.
.PP
This plugin has three user-configurable parameters; these are the maximum number of retries to attempt, the interval to wait between retries, and the deadline after which no further retries will be attempted\&. These are set by initializing a restart plugin instance with the function \fBglobus_ftp_client_restart_plugin_init()\fP\&. 
.SH "Macro Definition Documentation"
.PP 
.SS "#define GLOBUS_FTP_CLIENT_RESTART_PLUGIN_MODULE           (&globus_i_ftp_client_restart_plugin_module)"
Module descriptor 
.SH "Function Documentation"
.PP 
.SS "globus_result_t globus_ftp_client_restart_plugin_destroy (\fBglobus_ftp_client_plugin_t\fP * plugin)"
Destroy an instance of the GridFTP restart plugin
.PP
This function will free all restart plugin-specific instance data from this plugin, and will make the plugin unusable for further ftp handle creation\&.
.PP
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\&.
.PP
\fBParameters\fP
.RS 4
\fIplugin\fP A pointer to a GridFTP restart plugin, previously initialized by calling \fBglobus_ftp_client_restart_plugin_init()\fP
.RE
.PP
\fBReturns\fP
.RS 4
This function returns an error if
.IP "\(bu" 2
plugin is null
.IP "\(bu" 2
plugin is not a restart plugin
.PP
.RE
.PP
\fBSee also\fP
.RS 4
\fBglobus_ftp_client_restart_plugin_init()\fP, \fBglobus_ftp_client_handleattr_add_plugin()\fP, globus_ftp_client_handleattr_remove_plugin(), \fBglobus_ftp_client_handle_init()\fP 
.RE
.PP

.SS "globus_result_t globus_ftp_client_restart_plugin_init (\fBglobus_ftp_client_plugin_t\fP * plugin, int max_retries, globus_reltime_t * interval, globus_abstime_t * deadline)"
Initialize an instance of the GridFTP restart plugin
.PP
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\&.
.PP
\fBParameters\fP
.RS 4
\fIplugin\fP A pointer to an uninitialized plugin\&. The plugin will be configured as a restart plugin\&. 
.br
\fImax_retries\fP 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\&. 
.br
\fIinterval\fP 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\&. 
.br
\fIdeadline\fP An absolute timeout\&. If the deadline is GLOBUS_NULL then the retry will never timeout\&.
.RE
.PP
\fBReturns\fP
.RS 4
This function returns an error if
.IP "\(bu" 2
plugin is null
.PP
.RE
.PP
\fBSee also\fP
.RS 4
\fBglobus_ftp_client_restart_plugin_destroy()\fP, \fBglobus_ftp_client_handleattr_add_plugin()\fP, globus_ftp_client_handleattr_remove_plugin(), \fBglobus_ftp_client_handle_init()\fP 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for globus_ftp_client from the source code\&.