NAME
globus_ftp_client_abort
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_abort
handle
DESCRIPTION
This command is used to abort the operation currently in progress.
PARAMETERS
handle - Handle which to abort.
RETURN VALUE
On success globus_ftp_client_abort returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_abort $handle ] result
BUGS
None
TODO
None
NAME
globus_ftp_client_chmod
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_chmod
u_handle
url
mode
attr
script
DESCRIPTION
This command is used to change permissions on a file.
When the response to the chmod request has been received the script will be invoked with the result of the operation.
PARAMETERS
u_handle - An FTP client handle to use for the chmod operation.
url - The URL for the file to delete. The URL may be a FTP or GSIFTP URL.
mode - The file mode to change to.
attr - Attributes to use for this operation.
script - TCL script invoked when the command is completed. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_ftp_client_chmod returns 0. On error, this command will raise an error and must be caught using the appropriate bgerror command.
EXAMPLE
lassign [ globus_ftp_client_chmod $handle $url $mode $attr { callback callback_arg } ] result
BUGS
None
TODO
None
NAME
globus_ftp_client_cksm
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_cksm
u_handle
url
attr
offset
length
algorithm
script
DESCRIPTION
This command is used to request the checksum of a file from an FTP server.
When the checksum request is completed or aborted, the script will be invoked with the final status of the operation. If the callback is returned without an error, the checksum will be stored in the cksm parameter of the callback script.
PARAMETERS
u_handle - An FTP client handle to use for the chmod operation.
url - The URL for the file to delete. The URL may be a FTP or GSIFTP URL.
attr - Attributes to use for this operation.
offset - File offset to start calculating checksum.
length - Length of data to read from the starting offset. Use -1 to read the entire file.
algorithm - Currently the command only supports MD5.
script - TCL script invoked when the command is completed. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_ftp_client_cksm returns 0. On error, this command will raise an error and must be caught using the appropriate bgerror command.
EXAMPLE
lassign [ globus_ftp_client_cksm $handle $url $operation_attr $offset $length $algorithm { callback_script callback_arg } ] result
BUGS
None
TODO
None
NAME
globus_ftp_client_delete
SYNOPSIS
package require globus_ftp_delete
globus_ftp_client_delete
handle
url
operation_attr
script
DESCRIPTION
This command starts a delete operation on a FTP server. When the response to the delete request has been received the script will be invoked with the result of the delete operation.
Note that this functions will only delete files, not directories.
PARAMETERS
handle - An FTP client handle to use for the delete operation.
url - The URL for the file to delete. The URL may be a FTP or GSIFTP URL.
attr - Attributes to use for this operation.
script - TCL script invoked when the command is completed. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_ftp_client_delete returns 0. On error, this command will raise an error and must be caught using the appropriate bgerror command.
EXAMPLE
lassign [ globus_ftp_client_delete $handle $url $operation_attr { callback callback_arg } ] result
BUGS
None
TODO
None
NAME
globus_ftp_client_exists
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_exists
handle
url
operation_attr
script
DESCRIPTION
This command is used to check for the existence of a file or directory on an FTP server.
PARAMETERS
handle - An FTP client handle to use for the existence check operation.
url - The URL of the directory or file to check. The URL may be a FTP or GSIFTP URL.
attr - Attributes to use for this operation.
script - TCL script invoked when the command is completed. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_ftp_client_exists returns 0. On error, this command will raise an error and must be caught using the appropriate bgerror command.
EXAMPLE
lassign [ globus_ftp_client_exists $handle $url $operation_attr { callback callback_arg } ] result
BUGS
None
TODO
None
NAME
globus_ftp_client_extended_get
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_extended_get
handle
url
attr
restart
eret_alg_str
script
DESCRIPTION
This command is used to initiate a "get" file transfer from a FTP server with server-side processing. If this command returns no error, then the user may immediately begin calling globus_ftp_client_read to retrieve the data associated with this URL.
When all of the data associated with this URL is retrieved, and all of the data callbacks have been called, or if the get request is aborted, the script will be invoked with the final status of the get.
This function differs from the globus_ftp_client_get command by allowing the user to invoke server-side data processing algorithms. GridFTP servers may support support algorithms for data reduction or other customized data storage requirements. There is no client-side verification done on the algorithm string provided by the user. If the server does not understand the requested algorithm, the transfer will fail.
PARAMETERS
handle - FTP client handle to use for the get operation.
url - The URL to download. The URL may be FTP or GSIFTP URL.
attr - Attributes for this file transfer.
restart - A restart marker.
eret_alg_str - The ERET algorithm string. This string contains information needed to invoke a server-specific data reduction algorithm on the file being retrieved.
script - TCL script invoked once the "get" is completed. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_ftp_client_extended_get returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
TBD
BUGS
None
TODO
None
SEE ALSO
NAME
globus_ftp_client_extended_put
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_extended_put
handle
url
attr
restart
eret_alg_str
script
DESCRIPTION
This command is used to initiate a "put" file transfer to a FTP server with server-side processing. If this command returns no error, then the user may immediately begin calling globus_ftp_client_write to send the data associated with this URL.
When all of the data associated with this URL is sent, and all of the data callbacks have been called, or if the get request is aborted, the script will be invoked with the final status of the put.
This function differs from the globus_ftp_client_put command by allowing the user to invoke server-side data processing algorithms. GridFTP servers may support support algorithms for data reduction or other customized data storage requirements. There is no client-side verification done on the algorithm string provided by the user. If the server does not understand the requested algorithm, the transfer will fail.
PARAMETERS
handle - FTP client handle to use for the get operation.
url - The URL to download. The URL may be FTP or GSIFTP URL.
attr - Attributes for this file transfer.
restart - A restart marker.
eret_alg_str - The ERET algorithm string. This string contains information needed to invoke a server-specific data reduction algorithm on the file being retrieved.
script - TCL script invoked once the "put" is completed. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_ftp_client_extended_put returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
TBD
BUGS
None
TODO
None
SEE ALSO
NAME
globus_ftp_client_extended_third_party_transfer
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_extended_third_party_transfer
handle
source_url
source_attr
eret_alg_str
dest_url
dest_attr
eret_alg_str
restart
script
DESCRIPTION
This command is used to transfer a file between two FTP servers with server-side processing.
When the transfer is completed or if the transfer is aborted, the script will be invoked with the final status of the transfer.
This function differs from the globus_ftp_client_third_party_transfer command by allowing the user to invoke server-side data processing algorithms. GridFTP servers may support algorithms for data reduction or other customized data storage requirements. There is no client-side verification done on the algorithm string provided by the user. If the server does not understand the requested algorithm, the transfer will fail.
PARAMETERS
handle - An FTP client handle to use for the transfer operation.
source_url - The URL to transfer. The URL may be an FTP or GSIFTP URL.
source_attr - Attributes for the souce URL.
eret_alg_str - The ERET algorithm string. This string contains information needed to invoke a server-specific data reduction algorithm on the file being retrieved.
dest_url - The destination URL for the transfer. The URL may be an FTP or GSIFTP URL.
dest_attr - Attributes for the destination URL.
eret_alg_str - The ERET algorithm string. This string contains information needed to invoke a server-specific data reduction algorithm on the file being retrieved.
restart - A restart marker.
script - TCL script invoked once the "transfer" operation is completed. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_ftp_client_extended_third_party_transfer returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
TBD
BUGS
None
TODO
None
NAME
globus_ftp_client_get
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_get
handle
url
attr
restart
script
DESCRIPTION
This command is used to initiate a "get" file transfer from a FTP server. If this command returns no error, then the user may immediately begin calling globus_ftp_client_register_read to retrieve the data associated with this URL.
When all of the data associated with this URL is retrieved, and all of the data callbacks have been called, or if the get request is aborted, the script will be invoked with the final status of the get.
PARAMETERS
handle - FTP client handle to use for the get operation.
url - The URL to download. The URL may be FTP or GSIFTP URL.
attr - Attributes for this file transfer.
restart - A restart marker.
script - TCL script invoked once the "get" is completed. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_ftp_client_get returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_get $handle $url NULL NULL { callback callback_arg } ] result
BUGS
None
TODO
None
SEE ALSO
NAME
globus_ftp_client_handle_add_plugin
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_handle_add_plugin
handle
plugin
DESCRIPTION
This command is used to add 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.
Only one instance of a particular plugin may be added to a particular handle.
Plugins may be removed from a handle by calling globus_ftp_client_handle_remove_plugin.
PARAMETERS
handle - The FTP client handle.
plugin - A pointer to the plugin structure to add to this handle.
RETURN VALUE
On success globus_ftp_client_handle_add_plugin returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_handle_add_plugin $handle $plugin ] result
BUGS
None
TODO
None
SEE ALSO
globus_ftp_client_remove_plugin, globus_ftp_clent_handleattr_add_plugin, globus_ftp_clent_handleattr_remove_plugin.
NAME
globus_ftp_client_handle_cache_url_state
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_handle_cache_url_state
handle
url
DESCRIPTION
This command is used to 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.
PARAMETERS
handle - Handle which will contain a cached connection to the URL server.
url - The URL of the FTP or GSIFTP server to cache.
RETURN VALUE
On success globus_ftp_client_handle_cache_url_state returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_handle_cache_url_state $handle $url ] result
BUGS
None
TODO
None
SEE ALSO
globus_ftp_client_flush_url_state.
NAME
globus_ftp_client_handle_destroy
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_handle_destroy
handle
DESCRIPTION
This command is used to destroy a client FTP handle.
A FTP client handle may not be destroyed if a get, put, or third-party transfer is in progress.
PARAMETERS
handle - The handle to be destroyed.
RETURN VALUE
On success globus_ftp_client_handle_destroy returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_handle_destroy $handle ] result
BUGS
None
TODO
None
SEE ALSO
NAME
globus_ftp_client_handle_flush_url_state
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_handle_flush_url_state
handle
url
DESCRIPTION
This command is used to 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.
PARAMETERS
handle - Handle which will contain a cached connection to the URL server.
url - The URL of the FTP or GSIFTP server to cache.
RETURN VALUE
On success globus_ftp_client_handle_flush_url_state returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_handle_flush_url_state $handle $url ] result
BUGS
None
TODO
None
SEE ALSO
NAME
globus_ftp_client_handle_get_user_pointer
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_handle_get_user_pointer
handle
DESCRIPTION
This command is used to get the user pointer field from an FTP client handle.
The user pointer is provided to all the user of the FTP client library to associate a pointer to any application-specific data to an FTP client handle. This pointer is never internally used by the client library.
PARAMETERS
handle - The FTP client handle to query.
RETURN VALUE
On success globus_ftp_client_handle_get_user_pointer returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_handle_get_user_pointer $handle ] result
BUGS
None
TODO
None
NAME
globus_ftp_client_handle_init
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_handle_init
handle
attr
DESCRIPTION
This command is used to initialize a client 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.
PARAMETERS
handle - The handle to be initialized.
attr - Initial attributes to be used to create this handle. This can be NULL.
RETURN VALUE
On success globus_ftp_client_handle_init returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_handle_init $handle NULL ] result
BUGS
None
TODO
None
SEE ALSO
NAME
globus_ftp_client_handle_remove_plugin
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_handle_remove_plugin
handle
plugin
DESCRIPTION
This command is used to remove a plugin to an FTP client handle.
This command 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.
This command can remove plugins which were added at globus_ftp_client_handle_init "handle initialization time" or by calling globus_ftp_client_handle_add_plugin.
PARAMETERS
handle - The FTP client handle.
plugin - A pointer to the plugin structure to remove from this handle.
RETURN VALUE
On success globus_ftp_client_handle_remove_plugin returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_handle_add_plugin $handle $plugin ] result
BUGS
None
TODO
None
SEE ALSO
globus_ftp_client_handleattr_add_plugin, globus_ftp_client_handleattr_remove_plugin.
NAME
globus_ftp_client_handle_set_user_pointer
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_handle_set_user_pointer
handle
user_pointer
DESCRIPTION
This command is used to set the user pointer field from an FTP client handle.
The user pointer is provided to all the user of the FTP client library to associate a pointer to any application-specific data to an FTP client handle. This pointer is never internally used by the client library.
PARAMETERS
handle - The FTP client handle to set.
user_pointer - The value of the user pointer.
RETURN VALUE
On success globus_ftp_client_handle_set_user_pointer returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_handle_set_user_pointer $handle $user_pointer ] result
BUGS
None
TODO
None
NAME
globus_ftp_client_handleattr_add_cached_url
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_handleattr_add_cached_url
attr
url
DESCRIPTION
This command is used to enable caching for a specific URL.
This command adds 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 operations.
PARAMETERS
attr - Attribute to modify.
url - URL string to cache.
RETURN VALUE
On success globus_ftp_client_handleattr_add_cached_url returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_handleattr_add_cached_url $attr $url ] result
BUGS
None
TODO
None
NAME
globus_ftp_client_handleattr_add_plugin
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_handleattr_add_plugin
attr
plugin
DESCRIPTION
This command is used to add a plugin to a handle attribute set.
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.
Only one instance of a specific plugin may be added to an attribute set. Each plugin must have a different name.
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.
PARAMETERS
attr - The attribute set to modify.
plugin - The plugin to add to the list.
RETURN VALUE
On success globus_ftp_client_handleattr_add_plugin returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_handleattr_add_plugin $attr $plugin ] result
BUGS
None
TODO
None
NAME
globus_ftp_client_handleattr_copy
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_handleattr_copy
dest
src
DESCRIPTION
This command is used to create a duplicate of a handle attribute set.
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.
PARAMETERS
dest - The attribute set to be initialized to the same values as src.
src - The original attribute set to duplicate.
RETURN VALUE
On success globus_ftp_client_handleattr_copy returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_handleattr_copy $dest $src ] result
BUGS
None
TODO
None
NAME
globus_ftp_client_handleattr_destroy
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_handleattr_destroy
attr
DESCRIPTION
This command is used to destroy a FTP client handle attribute set.
This command destroys a FTP client handle attribute set. All attributes on this set will be lost. The user must call globus_ftp_client_handleattr_init again on this attribute set before calling any other handle attribute functions on it.
PARAMETERS
attr - The attribute set to destroy.
RETURN VALUE
On success globus_ftp_client_handleattr_destroy returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_handleattr_destroy $attr ] result
BUGS
None
TODO
None
SEE ALSO
NAME
globus_ftp_client_handleattr_get_cache_all
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_handleattr_get_cache_all
attr
DESCRIPTION
This command is used to get the cache all connections attribute for an FTP client handle attribute set.
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.
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.
PARAMETERS
attr - Attribute to query.
RETURN VALUE
On success globus_ftp_client_handleattr_get_cache_all returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_handleattr_get_cache_all $attr ] result cache_all
BUGS
None
TODO
None
SEE ALSO
globus_ftp_client_handleattr_add_cached_url, globus_ftp_client_handleattr_remove_cached_url, globus_ftp_client_handle_cache_url_state, globus_ftp_client_handle_flush_url_state
NAME
globus_ftp_client_handleattr_get_rfc1738_url
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_handleattr_get_rfc1738_url
attr
DESCRIPTION
This command is used to query the value of RFC1738 support for non-root relative URLs.
PARAMETERS
attr - Attribute to modify.
RETURN VALUE
On success globus_ftp_client_handleattr_get_rfc1738_url returns 0 and the value of rfc1738_url flag set by globus_ftp_client_handleattr_set_rfc1738_url. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_handleattr_get_rfc1738_url $attr ] result rfc1738_url
BUGS
None
TODO
None
NAME
globus_ftp_client_handleattr_init
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_handleattr_init
attr
DESCRIPTION
This command is used to initialize an FTP client handle attribute set.
This command creates an empty FTP client handle attribute set. This command must be called on each attribute set before any of the other methods may be called.
PARAMETERS
attr - The new handle attribute.
RETURN VALUE
On success globus_ftp_client_handleattr_init returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_handleattr_init $attr ] result
BUGS
None
TODO
None
SEE ALSO
NAME
globus_ftp_client_handleattr_remove_cached_url
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_handleattr_remove_cached_url
attr
url
DESCRIPTION
This command is used to disable caching for a specific URL.
This command 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 operations.
PARAMETERS
attr - Attribute to modify.
url - URL string to cache.
RETURN VALUE
On success globus_ftp_client_handleattr_remove_cached_url returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_handleattr_remove_cached_url $attr $url ] result
BUGS
None
TODO
None
NAME
globus_ftp_client_handleattr_remove_plugin
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_handleattr_remove_plugin
attr
plugin
DESCRIPTION
This command is used to remove a plugin from a handle attribute set.
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.
Only one instance of a specific plugin may be added to an attribute set. Each plugin must have a different name.
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.
PARAMETERS
attr - The attribute set to modify.
plugin - The plugin to remove from the list.
RETURN VALUE
On success globus_ftp_client_handleattr_remove_plugin returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_handleattr_remove_plugin $attr $plugin ] result
BUGS
None
TODO
None
NAME
globus_ftp_client_handleattr_set_cache_all
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_handleattr_set_cache_all
attr
cache_all
DESCRIPTION
This command is used to set the cache all connections attribute for an FTP client handle attribute set.
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.
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.
PARAMETERS
attr - Attribute to query or modify.
cache_all - Boolean value of the cache_all attribute.
RETURN VALUE
On success globus_ftp_client_handleattr_set_cache_all returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_handleattr_set_cache_all $attr $cache_all ] result
BUGS
None
TODO
None
SEE ALSO
globus_ftp_client_handleattr_add_cached_url, globus_ftp_client_handleattr_remove_cached_url, globus_ftp_client_handle_cache_url_state, globus_ftp_client_handle_flush_url_state
NAME
globus_ftp_client_handleattr_set_netlogger
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_handleattr_set_netlogger
attr
nl_handle
DESCRIPTION
This command is used to set the netlogger handle used with this transfer. Each handle can have a netlogger handle associated with it for logging its data. Only 1 netlogger handle can be associated with a client handle.
PARAMETERS
attr - The attribute set to modify.
nl_handle - The open netlogger handle to be associated with this attribute set.
RETURN VALUE
On success globus_ftp_client_handleattr_set_netlogger returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
TBD
BUGS
None
TODO
None
NAME
globus_ftp_client_handleattr_set_netlogger_ftp_io
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_handleattr_set_netlogger_ftp_io
attr
nl_handle
ftp
io
DESCRIPTION
This command is used to set the netlogger handle used with this transfer.
Each handle can have a netlogger handle associated with it for logging its data.
Only 1 netlogger handle can be associated with a client handle.
PARAMETERS
attr - The attribute set to modify.
nl_handle - The open netlogger handle to be associated with this attribute set.
ftp - |html <font color="Red"> TBD
io - |html <font color="Red"> TBD
RETURN VALUE
On success globus_ftp_client_handleattr_set_netlogger_ftp_io returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
TBD
BUGS
None
TODO
None
NAME
globus_ftp_client_handleattr_set_rfc1738_url
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_handleattr_set_rfc1738_url
attr
rfc1738_url
DESCRIPTION
This command is used to enable/disable RFC1738 support for non-root relative URLs.
PARAMETERS
attr - Attribute to modify.
rfc1738_url - Set to GLOBUS_TRUE to enable non-root relative URLs. Default of GLOBUS_FALSE specifies root-relative URLs.
RETURN VALUE
On success globus_ftp_client_handleattr_set_rfc1738_url returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_handleattr_set_rfc1738_url $attr $GLOBUS_TRUE ] result
BUGS
None
TODO
None
NAME
globus_ftp_client_list
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_list
handle
url
operation_attr
script
DESCRIPTION
This command is used to get a file listing from an FTP server.
This function starts a "NLST" transfer from an FTP server. If this function returns no error, then the user may immediately begin calling globus_ftp_client_read to retrieve the data associated with this listing.
When all of the data associated with the listing is retrieved, and all of the data callbacks have been called, or if the list request is aborted, the script will be invoked with the final status of the list.
PARAMETERS
handle - An FTP client handle to use for the list operation.
url - The URL to list. The URL may be a FTP or GSIFTP URL.
attr - Attributes for this file transfer.
script - TCL script invoked when the "list" is completed. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_ftp_client_list returns 0. On error, this command will raise an error and must be caught using the appropriate bgerror command.
EXAMPLE
lassign [ globus_ftp_client_list $handle $url $operation_attr { callback callback_arg } ] result
BUGS
None
TODO
None
NAME
globus_ftp_client_machine_list
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_machine_list
u_handle
url
attr
script
DESCRIPTION
This command is used to get a machine parseable file listing from an FTP server.
This command starts a "MLSD" transfer from an FTP server. If this command returns GLOBUS_SUCCESS, then the user may immediately begin calling globus_ftp_client_register_read to retrieve the data associated with this listing.
When all of the data associated with the listing is retrieved, and all of the data callbacks have been called, or if the list request is aborted, the script will be invoked with the final status of the list.
PARAMETERS
u_handle - An FTP client handle to use for the list operation.
url - The URL to list. The URL may be a FTP or GSIFTP URL.
attr - Attributes for this file transfer.
script - TCL script invoked when the "list" is completed. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_ftp_client_machine_list returns 0. On error, this command will raise an error and must be caught using the appropriate bgerror command.
EXAMPLE
lassign [ globus_ftp_client_machine_list $handle $url $attr { callback callback_arg } ] result
BUGS
None
TODO
None
NAME
globus_ftp_client_mkdir
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_mkdir
handle
url
operation_attr
script
DESCRIPTION
This command is used to make a directory on an FTP server.
When the response to the "mkdir" request has been received the script will be invoked with the result of the "mkdir" operation.
PARAMETERS
handle - An FTP client handle to use for the mkdir operation.
url - The URL for the directory to create. The URL may be a FTP or GSIFTP URL.
attr - Attributes to use for this operation.
script - TCL script invoked when the command is completed. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_ftp_client_mkdir returns 0. On error, this command will raise an error and must be caught using the appropriate bgerror command.
EXAMPLE
lassign [ globus_ftp_client_mkdir $handle $url $operation_attr { callback callback_arg } ] result
BUGS
None
TODO
None
NAME
globus_ftp_client_mlst
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_mlst
u_handle
url
attr
mlst_buffer
mlst_buffer_length
script
DESCRIPTION
This command is used to get information about a file or directory from a FTP server.
This command requests the MLST fact string of a file or directory from an FTP server.
When the MLST request is completed or aborted, the script will be invoked with the final status of the operation. If the callback is returns without an error, the MLST fact string will be stored in the mlst_buffer parameter to this command.
PARAMETERS
u_handle - An FTP client handle to use for the list operation.
url - The URL to list. The URL may be a FTP or GSIFTP URL.
attr - Attributes for this file transfer.
mlst_buffer - It contains the MLST fact string of the file, if it exists. Otherwise, the value pointed to by it is undefined.
mlst_buffer_length - It contains the length of the data in mlst_buffer.
script - TCL script invoked when the "list" is completed. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_ftp_client_mlst returns 0. On error, this command will raise an error and must be caught using the appropriate bgerror command.
EXAMPLE
lassign [ globus_ftp_client_mlst $handle $url $attr $mlst_buffer $mlst_buffer_length { callback callback_arg } ] result
BUGS
None
TODO
None
NAME
globus_ftp_client_modification_time
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_modification_time
handle
url
attr
script
DESCRIPTION
This command is used to request the modification time of a file from an FTP server.
When the modification time request is completed or aborted, the script will be invoked with the final status of the operation. If the callback script is returned without an error, the modification time will be stored in the modification_time parameter of the callback script.
PARAMETERS
handle - FTP client handle to use for the operation.
url - The URL to store the data to. The URL may be FTP or GSIFTP URL.
attr - Attributes for this file transfer.
script - TCL script invoked once the operation is completed. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_ftp_client_modification_time returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_modification_time $handle $url $operation_attr { callback_script callback_arg } ] result
BUGS
None
TODO
None
NAME
globus_ftp_client_move
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_move
handle
url
attr
restart
script
DESCRIPTION
This command is used to start a move (rename) operation on an FTP server. Note that this function does not move files between FTP servers and that the host:port part of the destination url is ignored.
When the response to the move request has been received the script will be invoked with the result of the move operation.
PARAMETERS
handle - An FTP Client handle to use for the move operation.
source_url - The URL for the file to move.
dest_url - The URL for the target of the move. The host:port part of this URL is ignored.
attr - Attributes for this operation.
script - TCL script invoked once the "move" operation is completed. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_ftp_client_move returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_move $handle $source_url $dest_url $attr { callback callback_arg } ] result
BUGS
None
TODO
None
NAME
globus_ftp_client_operationattr_copy
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_copy
dest
src
DESCRIPTION
This command is used to create a duplicate of an attribute set.
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.
PARAMETERS
dest - The attribute set to be initialized to the same values as src.
src - The original attribute set to duplicate.
RETURN VALUE
On success globus_ftp_client_operationattr_copy returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_operationattr_copy $dest $src ] result
BUGS
None
TODO
None
NAME
globus_ftp_client_operationattr_destroy
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_destroy
attr
DESCRIPTION
This command is used to destroy a FTP client attribute set.
PARAMETERS
attr - The new attribute set.
RETURN VALUE
On success globus_ftp_client_operationattr_destroy returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_operationattr_destroy $attr ] result
BUGS
None
TODO
None
SEE ALSO
NAME
globus_ftp_client_operationattr_get_append
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_get_append
attr
DESCRIPTION
This command is used to get the append attribute for an FTP client attribute set.
This attribute allows the user to append to a file on an FTP server, instead of replacing the existing file when doing a globus_ftp_client_put or globus_ftp_client_transfer.
This attribute is ignored on the retrieving side of a transfer, or a globus_ftp_client_get.
PARAMETERS
attr - The attribute set to query.
append - The value of append attribute.
RETURN VALUE
On success globus_ftp_client_operationattr_get_append returns 0 and The value of append attribute. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_operationattr_set_append $attr ] result append
BUGS
None
TODO
None
NAME
globus_ftp_client_operationattr_get_authorization
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_get_authorization
attr
DESCRIPTION
This command is used to get the authorization attribute for an FTP client attribute set.
This attribute allows the user to pass authentication information to the FTP client library. This information is used to authenticate with the FTP server.
The Globus FTP client library supports authentication using either the GSSAPI, or standard plaintext username and passwords. The type of authentication is determined by the URL scheme which is used for the individual get, put, or 3rd party transfer calls.
PARAMETERS
attr - The attribute set to query.
RETURN VALUE
On success globus_ftp_client_operationattr_get_authorization returns 0 and the following variables:
user - The user name to send to the FTP server. When doing a GSIFTP transfer, this may be set to NULL, and the default globusmap entry for the user's GSI identity will be used.
password - The password to send to the FTP server. When doing a GSIFTP transfer, this may be set to NULL.
account - The account to use for the data transfer. Most FTP servers do not require this.
subject - The subject name of the FTP server. This is only used when doing a GSIFTP transfer, and then only when the security subject name does not match the hostname of the server (ie, when the server is being run by a user).
EXAMPLE
TBD
BUGS
None
TODO
None
NAME
globus_ftp_client_operationattr_get_control_protection
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_get_control_protection
attr
protection
DESCRIPTION
This command is used to get the control channel protection attribute for an FTP client attribute set.
PARAMETERS
attr - The attribute set to query.
RETURN VALUE
On success globus_ftp_client_operationattr_get_control_protection returns 0 and The value of control channel protection attribute. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_operationattr_get_control_protection $attr ] result protection
BUGS
The clear and safe protection levels are treated identically, with the client integrity checking all commands. The confidential and private protection levels are treated identically, with the client encrypting all commands.
TODO
None
SEE ALSO
globus_ftp_control_protection_t
NAME
globus_ftp_client_operationattr_get_data_protection
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_get_data_protection
attr
DESCRIPTION
This command is used to get the data channel protection attribute for an FTP client attribute set.
PARAMETERS
attr - The attribute set to query.
RETURN VALUE
On success globus_ftp_client_operationattr_get_data_protection returns 0 and the value of data channel protection attribute. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_operationattr_get_data_protection $attr ] result protection
BUGS
Only safe and private protection levels are supported by GSIFTP.
TODO
None
SEE ALSO
globus_ftp_control_protection_t
NAME
globus_ftp_client_operationattr_get_dcau
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_get_dcau
attr
DESCRIPTION
This command is used to get the data channel authentication attribute for an FTP client attribute set.
Data channel authentication is a GridFTP extension, and may not be supported by all servers. If a server supports it, then the default is to delegate a credential to the server, and authenticate all data channels with that delegated credential.
PARAMETERS
attr - The attribute set to modify.
RETURN VALUE
On success globus_ftp_client_operationattr_get_dcau returns 0 and the value of data channel authentication attribute. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_operationattr_get_dcau $attr ] result dcau
BUGS
None
TODO
None
SEE ALSO
globus_ftp_control_dcau_t
NAME
globus_ftp_client_operationattr_get_layout
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_get_layout
attr
DESCRIPTION
This command is used to get the layout attribute for an FTP client attribute set.
This attribute allows the user to control the layout of a file being transfered to a striped Grid-FTP server. The striping layout defines what regions of a file will be stored on each stripe of a multiple-striped FTP server.
The layout attribute is used only when the data is being stored on the server (on a put or 3rd party transfer). This attribute is ignored for stream mode data transfers.
PARAMETERS
attr - The attribute set to query.
RETURN VALUE
On success globus_ftp_client_operationattr_get_layout returns 0 and the layout attribute. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_operationattr_get_layout $attr ] result layout
BUGS
None
TODO
None
SEE ALSO
globus_ftp_control_layout_t, globus_ftp_client_operationattr_set_layout, globus_ftp_client_operationattr_set_mode.
NAME
globus_ftp_client_operationattr_get_list_uses_data_mode
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_get_list_uses_data_mode
attr
DESCRIPTION
This command is used to get whether or not list data will use the current data mode.
PARAMETERS
attr - The attribute set to query.
RETURN VALUE
On success globus_ftp_client_operationattr_get_list_uses_data_mode returns 0 and the value of list_uses_data_mode. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_operationattr_get_list_uses_data_mode $attr ] result list_uses_data_mode
BUGS
None
TODO
None
NAME
globus_ftp_client_operationattr_get_mode
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_get_mode
attr
DESCRIPTION
This command is used to get the file transfer mode attribute for an FTP client attribute set.
This attribute allows the user to choose the data channel protocol used to transfer a file. There are two modes supported by this library:
Stream mode is a file transfer mode where all data is sent over a single TCP socket, without any data framing. In stream mode, data will arrive in sequential order. This mode is supported by nearly all FTP servers.
Extended block mode is a file transfer mode where data can be sent over multiple parallel connections and to multiple data storage nodes to provide a high-performance data transfer. In extended block mode, data may arrive out-of-order. ASCII type files are not supported in extended block mode .
PARAMETERS
attr - The attribute set to query.
RETURN VALUE
On success globus_ftp_client_operationattr_get_mode returns 0 and the value of mode attribute. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_operationattr_get_mode $attr ] result mode
BUGS
None
TODO
None
SEE ALSO
globus_ftp_control_type_t, globus_ftp_client_operationattr_set_parallelism, globus_ftp_client_operationattr_set_layout.
NAME
globus_ftp_client_operationattr_get_parallelism
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_get_parallelism
attr
DESCRIPTION
This command is used to get the parallelism attribute from an FTP client attribute set.
This attribute allows the user to control the level of parallelism to be used on an extended block mode file transfer. Currently, only a "fixed" parallelism level is supported. This is interpreted by the FTP server as the number of parallel data connections to be allowed for each stripe of data. Currently, only the "fixed" parallelism type is.
This attribute is ignored in stream mode.
PARAMETERS
attr - The attribute set to query or modify.
RETURN VALUE
On success globus_ftp_client_operationattr_get_parallelism returns 0 and the parallelism attribute. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_operationattr_get_parallelism $attr ] result parallelism
BUGS
None
TODO
None
SEE ALSO
globus_gsiftp_control_parallelism_t, globus_ftp_client_operationattr_set_layout, globus_ftp_client_operationattr_set_mode.
NAME
globus_ftp_client_operationattr_get_read_all
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_get_read_all
attr
DESCRIPTION
This command is used to get the read_all attribute for an FTP client attribute set.
This attribute allows the user to pass in a single buffer to receive all of the data for the current transfer. This buffer must be large enough to hold all of the data for the transfer. Only one buffer may be registered with globus_ftp_client_register_read when this attribute is used for a get.
In extended block mode, this attribute will cause data to be stored directly into the buffer from multiple streams without any extra data copies.
If the user sets the script to a non-null value, this script will be called whenever an intermediate sub-section of the data is received into the buffer.
This attribute is ignored for globus_ftp_client_put or globus_ftp_client_third_party_transfer operations.
PARAMETERS
attr - The attribute set to query.
RETURN VALUE
On success globus_ftp_client_operationattr_get_read_all returns 0 and the value of read_all attribute. On error, this command will raise an error and must be caught using the appropriate bgerror command.
EXAMPLE
TBD
BUGS
None
TODO
None
NAME
globus_ftp_client_operationattr_get_striped
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_get_striped
attr
DESCRIPTION
This command is used to get the striped attribute from an FTP client attribute set.
This attribute allows the user to force the client library to used the FTP commands to do a striped data transfer, even when the user has not requested a specific file layout via the layout attribute. This is useful when transferring files between servers which use the server side processing commands ERET or ESTO to transform data and send it to particular stripes on the destination server.
The layout attribute is used only when the data is being stored the server (on a put or 3rd party transfer). This attribute is ignored for stream mode data transfers.
PARAMETERS
attr - The attribute set to query.
RETURN VALUE
On success globus_ftp_client_operationattr_get_striped returns 0 and the striped attribute. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_operationattr_get_striped $attr ] result striped
BUGS
None
TODO
None
SEE ALSO
globus_ftp_client_operationattr_set_parallelism, globus_ftp_client_operationattr_set_layout, globus_ftp_client_operationattr_set_mode.
NAME
globus_ftp_client_operationattr_get_tcp_buffer
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_get_tcp_buffer
attr
DESCRIPTION
This command is used to get the TCP buffer attribute for an FTP client attribute set.
This attribute allows the user to control the TCP buffer size used for all data channels used in a file transfer. The size of the TCP buffer can make a significant impact on the performance of a file transfer. The user may set the buffer to either a system-dependent default value, or to a fixed value.
The actual implementation of this attribute is designed to be as widely interoperable as possible. In addition to supporting the SBUF command described in the GridFTP protocol extensions document, it also supports other commands and site commands which are used by other servers to set TCP buffer sizes. These are:
This attribute is affects any type of data transfer done with the FTP client library.
PARAMETERS
attr - The attribute set to modify.
RETURN VALUE
On success globus_ftp_client_operationattr_get_tcp_buffer returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_operationattr_get_tcp_buffer $attr ] result tcp_buffer
BUGS
None
TODO
None
SEE ALSO
globus_gsiftp_control_tcpbuffer_t
NAME
globus_ftp_client_operationattr_get_type
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_get_type
attr
DESCRIPTION
This command is used to get the file representation type attribute for an FTP client attribute set.
This attribute allows the user to choose the file type used for an FTP file transfer. The file may be transferred as either ASCII or a binary image.
When transferring an ASCII file, the data will be transformed in the following way:
The default type for the ftp client libary is binary.
PARAMETERS
attr - The attribute set to query.
RETURN VALUE
On success globus_ftp_client_operationattr_get_type returns 0 and the value of type attribute. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_operationattr_get_type $attr ] result type
BUGS
None
TODO
None
SEE ALSO
globus_ftp_control_type_t,
NAME
globus_ftp_client_operationattr_init
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_init
attr
DESCRIPTION
This command is used to initialize an FTP client attribute set.
PARAMETERS
attr - The new attribute set.
RETURN VALUE
On success globus_ftp_client_operationattr_init returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_operationattr_init $attr ] result
BUGS
None
TODO
None
NAME
globus_ftp_client_operationattr_set_append
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_set_append
attr
append
DESCRIPTION
This command is used to set the append attribute for an FTP client attribute set.
This attribute allows the user to append to a file on an FTP server, instead of replacing the existing file when doing a globus_ftp_client_put or globus_ftp_client_transfer.
This attribute is ignored on the retrieving side of a transfer, or a globus_ftp_client_get.
PARAMETERS
attr - The attribute set to modify.
append - The value of append attribute.
RETURN VALUE
On success globus_ftp_client_operationattr_set_append returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_operationattr_set_append $attr TRUE ] result
BUGS
None
TODO
None
NAME
globus_ftp_client_operationattr_set_authorization
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_set_authorization
attr
credential
user
password
account
subject
DESCRIPTION
This command is used to set the authorization attribute for an FTP client attribute set.
This attribute allows the user to pass authentication information to the FTP client library. This information is used to authenticate with the FTP server.
The Globus FTP client library supports authentication using either the GSSAPI, or standard plaintext username and passwords. The type of authentication is determined by the URL scheme which is used for the individual get, put, or 3rd party transfer calls.
PARAMETERS
attr - The attribute set to modify.
credential - The credential to use for authenticating with a GSIFTP server. This may be GSS_C_NO_CREDENTIAL to use the default credential.
user - The user name to send to the FTP server. When doing a GSIFTP transfer, this may be set to NULL, and the default globusmap entry for the user's GSI identity will be used.
password - The password to send to the FTP server. When doing a GSIFTP transfer, this may be set to NULL.
account - The account to use for the data transfer. Most FTP servers do not require this.
subject - The subject name of the FTP server. This is only used when doing a GSIFTP transfer, and then only when the security subject name does not match the hostname of the server (ie, when the server is being run by a user).
RETURN VALUE
On success globus_ftp_client_operationattr_set_authorization returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
TBD
BUGS
None
TODO
None
NAME
globus_ftp_client_operationattr_set_control_protection
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_set_control_protection
attr
protection
DESCRIPTION
This command is used to set the control channel protection attribute for an FTP client attribute set.
PARAMETERS
attr - The attribute set to modify.
protection - The value of control channel protection attribute.
RETURN VALUE
On success globus_ftp_client_operationattr_set_control_protection returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_operationattr_set_control_protection $attr $protection ] result
BUGS
The clear and safe protection levels are treated identically, with the client integrity checking all commands. The confidential and private protection levels are treated identically, with the client encrypting all commands.
TODO
None
SEE ALSO
globus_ftp_control_protection_t
NAME
globus_ftp_client_operationattr_set_data_protection
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_set_data_protection
attr
protection
DESCRIPTION
This command is used to set the data channel protection attribute for an FTP client attribute set.
PARAMETERS
attr - The attribute set to modify.
protection - The value of data channel protection attribute.
RETURN VALUE
On success globus_ftp_client_operationattr_set_data_protection returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_operationattr_set_data_protection $attr $protection ] result
BUGS
Only safe and private protection levels are supported by GSIFTP.
TODO
None
SEE ALSO
globus_ftp_control_protection_t
NAME
globus_ftp_client_operationattr_set_dcau
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_set_dcau
attr
dcau
DESCRIPTION
This command is used to set the data channel authentication attribute for an FTP client attribute set.
Data channel authentication is a GridFTP extension, and may not be supported by all servers. If a server supports it, then the default is to delegate a credential to the server, and authenticate all data channels with that delegated credential.
PARAMETERS
attr - The attribute set to modify.
dcau - The value of mode attribute.
RETURN VALUE
On success globus_ftp_client_operationattr_set_dcau returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_operationattr_set_dcau $attr $dcau ] result
BUGS
None
TODO
None
SEE ALSO
globus_ftp_control_dcau_t
NAME
globus_ftp_client_operationattr_set_layout
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_set_layout
attr
layout
DESCRIPTION
This command is used to set the layout attribute for an FTP client attribute set.
This attribute allows the user to control the layout of a file being transfered to a striped Grid-FTP server. The striping layout defines what regions of a file will be stored on each stripe of a multiple-striped FTP server.
The layout attribute is used only when the data is being stored on the server (on a put or 3rd party transfer). This attribute is ignored for stream mode data transfers.
PARAMETERS
attr - The attribute set to modify.
layout - The value of layout attribute.
RETURN VALUE
On success globus_ftp_client_operationattr_set_striped returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_operationattr_set_striped $attr striped ] result
BUGS
None
TODO
None
SEE ALSO
globus_ftp_control_layout_t, globus_ftp_client_operationattr_get_layout, globus_ftp_client_operationattr_set_parallelism, globus_ftp_client_operationattr_set_mode.
NAME
globus_ftp_client_operationattr_set_list_uses_data_mode
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_set_list_uses_data_mode
attr
list_uses_data_mode
DESCRIPTION
This command is used to set whether or not list data will use the current data mode.
PARAMETERS
attr - The attribute set to modify.
list_uses_data_mode - Boolean value.
RETURN VALUE
On success globus_ftp_client_operationattr_set_list_uses_data_mode returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_operationattr_set_list_uses_data_mode $attr $GLOBUS_TRUE ] result
BUGS
None
TODO
None
NAME
globus_ftp_client_operationattr_set_mode
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_set_mode
attr
mode
DESCRIPTION
This command is used to set the file transfer mode attribute for an FTP client attribute set.
This attribute allows the user to choose the data channel protocol used to transfer a file. There are two modes supported by this library:
Stream mode is a file transfer mode where all data is sent over a single TCP socket, without any data framing. In stream mode, data will arrive in sequential order. This mode is supported by nearly all FTP servers.
Extended block mode is a file transfer mode where data can be sent over multiple parallel connections and to multiple data storage nodes to provide a high-performance data transfer. In extended block mode, data may arrive out-of-order. ASCII type files are not supported in extended block mode .
PARAMETERS
attr - The attribute set to modify.
mode - The value of mode attribute.
RETURN VALUE
On success globus_ftp_client_operationattr_set_mode returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_operationattr_set_mode $attr $type ] result
BUGS
None
TODO
None
SEE ALSO
globus_ftp_control_type_t
NAME
globus_ftp_client_operationattr_set_parallelism
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_set_parallelism
attr
parallelism
DESCRIPTION
This command is used to set the parallelism attribute for an FTP client attribute set.
This attribute allows the user to control the level of parallelism to be used on an extended block mode file transfer. Currently, only a "fixed" parallelism level is supported. This is interpreted by the FTP server as the number of parallel data connections to be allowed for each stripe of data. Currently, only the "fixed" parallelism type is.
This attribute is ignored in stream mode.
PARAMETERS
attr - The attribute set to query or modify.
parallelism - The value of parallelism attribute.
RETURN VALUE
On success globus_ftp_client_operationattr_set_parallelism returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_operationattr_set_parallelism $attr $parallelism ] result
BUGS
None
TODO
None
SEE ALSO
globus_gsiftp_control_parallelism_t, globus_ftp_client_operationattr_set_layout, globus_ftp_client_operationattr_set_mode.
NAME
globus_ftp_client_operationattr_set_read_all
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_set_read_all
attr
read_all
script
DESCRIPTION
This command is used to set the read_all attribute for an FTP client attribute set.
This attribute allows the user to pass in a single buffer to receive all of the data for the current transfer. This buffer must be large enough to hold all of the data for the transfer. Only one buffer may be registered with globus_ftp_client_register_read when this attribute is used for a get.
In extended block mode, this attribute will cause data to be stored directly into the buffer from multiple streams without any extra data copies.
If the user sets the script to a non-null value, this script will be called whenever an intermediate sub-section of the data is received into the buffer.
This attribute is ignored for globus_ftp_client_put or globus_ftp_client_third_party_transfer operations.
PARAMETERS
attr - The attribute set to modify.
read_all - The value of read_all attribute.
script - TCL script invoked when the command is completed. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_ftp_client_operationattr_set_read_all returns 0. On error, this command will raise an error and must be caught using the appropriate bgerror command.
EXAMPLE
lassign [ globus_ftp_client_operationattr_set_read_all $attr TRUE { callback callback_arg } ] result
BUGS
None
TODO
None
NAME
globus_ftp_client_operationattr_set_striped
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_set_striped
attr
striped
DESCRIPTION
This command is used to set the striped attribute for an FTP client attribute set.
This attribute allows the user to force the client library to used the FTP commands to do a striped data transfer, even when the user has not requested a specific file layout via the layout attribute. This is useful when transferring files between servers which use the server side processing commands ERET or ESTO to transform data and send it to particular stripes on the destination server.
The layout attribute is used only when the data is being stored the server (on a put or 3rd party transfer). This attribute is ignored for stream mode data transfers.
PARAMETERS
attr - The attribute set to modify.
striped - The value of striped attribute.
RETURN VALUE
On success globus_ftp_client_operationattr_set_striped returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_operationattr_set_striped $attr striped ] result
BUGS
None
TODO
None
SEE ALSO
globus_ftp_client_operationattr_set_parallelism, globus_ftp_client_operationattr_set_layout, globus_ftp_client_operationattr_set_mode.
NAME
globus_ftp_client_operationattr_set_tcp_buffer
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_set_tcp_buffer
attr
tcp_buffer
DESCRIPTION
This command is used to set the TCP buffer attribute for an FTP client attribute set.
This attribute allows the user to control the TCP buffer size used for all data channels used in a file transfer. The size of the TCP buffer can make a significant impact on the performance of a file transfer. The user may set the buffer to either a system-dependent default value, or to a fixed value.
The actual implementation of this attribute is designed to be as widely interoperable as possible. In addition to supporting the SBUF command described in the GridFTP protocol extensions document, it also supports other commands and site commands which are used by other servers to set TCP buffer sizes. These are:
This attribute is affects any type of data transfer done with the FTP client library.
PARAMETERS
attr - The attribute set to modify.
tcp_buffer - The value of tcp_buffer attribute.
RETURN VALUE
On success globus_ftp_client_operationattr_set_tcp_buffer returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_operationattr_set_tcp_buffer $attr $tcp_buffer ] result
BUGS
None
TODO
None
SEE ALSO
globus_gsiftp_control_tcpbuffer_t
NAME
globus_ftp_client_operationattr_set_type
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_operationattr_set_type
attr
type
DESCRIPTION
This command is used to set the file representation type attribute for an FTP client attribute set.
This attribute allows the user to choose the file type used for an FTP file transfer. The file may be transferred as either ASCII or a binary image.
When transferring an ASCII file, the data will be transformed in the following way:
The default type for the ftp client libary is binary.
PARAMETERS
attr - The attribute set to modify.
type - The value of type attribute.
RETURN VALUE
On success globus_ftp_client_operationattr_set_type returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_operationattr_set_type $attr $type ] result
BUGS
None
TODO
None
SEE ALSO
globus_ftp_control_type_t
NAME
globus_ftp_client_partial_get
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_partial_get
handle
url
attr
restart
partial_offset
partial_end_offset
script
DESCRIPTION
This command is used to initiate a "get" file transfer from a FTP server. If this command returns no error, then the user may immediately begin calling globus_ftp_client_read to retrieve the data associated with this URL.
When all of the data associated with this URL is retrieved, and all of the data callbacks have been called, or if the get request is aborted, the script will be invoked with the final status of the get.
PARAMETERS
handle - FTP client handle to use for the get operation.
url - The URL to download. The URL may be FTP or GSIFTP URL.
attr - Attributes for this file transfer.
restart - A restart marker.
partial_offset - Starting offset for a partial file get.
partial_end_offset - Ending offset for a partial file get.
script - TCL script invoked once the "get" is completed. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_ftp_client_partial_get returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
TBD
BUGS
None
TODO
None
SEE ALSO
NAME
globus_ftp_client_partial_put
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_partial_put
handle
url
attr
restart
partial_offset
partial_end_offset
script
DESCRIPTION
This command is used to initiate a "put" file transfer from a FTP server. If this command returns no error, then the user may immediately begin calling globus_ftp_client_write to send the data associated with this URL.
When all of the data associated with this URL is retrieved, and all of the data callbacks have been called, or if the put request is aborted, the script will be invoked with the final status of the put.
PARAMETERS
handle - FTP client handle to use for the put operation.
url - The URL to download. The URL may be FTP or GSIFTP URL.
attr - Attributes for this file transfer.
restart - A restart marker.
partial_offset - Starting offset for a partial file put.
partial_end_offset - Ending offset for a partial file put.
script - TCL script invoked once the "put" is completed. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_ftp_client_partial_put returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
TBD
BUGS
None
TODO
None
SEE ALSO
NAME
globus_ftp_client_partial_third_party_transfer
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_partial_third_party_transfer
handle
source_url
source_attr
dest_url
dest_attr
restart
partial_offset
partial_end_offset
script
DESCRIPTION
This command is used to transfer a file between two FTP servers.
When the transfer is completed or if the transfer is aborted, the script will be invoked with the final status of the transfer.
PARAMETERS
handle - An FTP client handle to use for the transfer operation.
source_url - The URL to transfer. The URL may be an FTP or GSIFTP URL.
source_attr - Attributes for the souce URL.
dest_url - The destination URL for the transfer. The URL may be an FTP or GSIFTP URL.
dest_attr - Attributes for the destination URL.
restart - A restart marker.
partial_offset - Starting offset for a partial file get.
partial_end_offset - Ending offset for a partial file get.
script - TCL script invoked once the "transfer" operation is completed. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_ftp_client_partial_third_party_transfer returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
TBD
BUGS
None
TODO
None
NAME
globus_ftp_client_put
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_put
handle
url
attr
restart
script
DESCRIPTION
This command is used to initiate a "put" file transfer to a FTP server. If this command returns no error, then the user may immediately begin calling globus_ftp_client_write to send the data associated with this URL.
When all of the data associated with this URL is sent, and all of the data callbacks have been called, or if the put request is aborted, the script will be invoked with the final status of the put.
PARAMETERS
handle - FTP client handle to use for the put operation.
url - The URL to store the data to. The URL may be FTP or GSIFTP URL.
attr - Attributes for this file transfer.
restart - A restart marker.
script - TCL script invoked once the "put" is completed. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_ftp_client_put returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_put $handle $url NULL NULL { callback callback_arg } ] result
BUGS
None
TODO
None
SEE ALSO
NAME
globus_ftp_client_register_read
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_register_read
handle
buffer_length
script
DESCRIPTION
This command is used to register a data buffer to handle as a part of the FTP data transfer.
PARAMETERS
handle - FTP client handle which contains state information about the get operation.
buffer_length - The maximum amount of data that can be stored into the buffer.
script - TCL script invoked to perform actual read. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_ftp_client_register_read returns 0. On error, this command will raise an error and must be caught using the appropriate bgerror command.
EXAMPLE
lassign [ globus_ftp_client_register_read $handle $buffer_length { callback callback_arg } ] result
BUGS
None
TODO
None
SEE ALSO
NAME
globus_ftp_client_register_write
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_register_write
handle
buffer
offset
eof
script
DESCRIPTION
This command is used to register a data buffer to handle as a part of the FTP data transfer in the background.
PARAMETERS
handle - FTP client handle which contains state information about the put operation.
buffer - A user-supplied buffer containing the data to write to the server.
offset - The offset of the buffer to be written. In extended-block mode, the data does not need to be sent in order. In stream mode (the default), data must be sent in sequential order. The behavior is undefined if multiple writes overlap.
eof - A variable to indicate the end-of-file.
script - TCL script invoked to perform actual write. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_ftp_client_register_write returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_register_write $handle $buffer $offset $eof { callback $callback_arg } ] result
BUGS
None
TODO
None
NAME
globus_ftp_client_restart_marker_copy
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_restart_marker_copy
new_marker
old_marker
DESCRIPTION
This command is used to create a copy of a restart marker.
PARAMETERS
new_marker - A pointer to a new restart marker.
old_marker - The marker to copy.
RETURN VALUE
On success globus_ftp_client_restart_marker_copy returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_restart_marker_copy $new_marker $old_marker ] result
BUGS
None
TODO
None
SEE ALSO
globus_ftp_client_restart_marker_init, globus_ftp_client_restart_marker_destroy.
NAME
globus_ftp_client_restart_marker_destroy
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_restart_marker_destroy
marker
DESCRIPTION
This command is used to destroy a restart marker.
This marker must be initialized by either calling globus_ftp_client_restart_marker_init or globus_ftp_client_restart_marker_copy.
PARAMETERS
marker - Restart marker.
RETURN VALUE
On success globus_ftp_client_restart_marker_destroy returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_restart_marker_destroy $marker ] result
BUGS
None
TODO
None
SEE ALSO
globus_ftp_client_restart_marker_init, globus_ftp_client_restart_marker_copy.
NAME
globus_ftp_client_restart_marker_from_string
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_restart_marker_from_string
marker
marker_string
DESCRIPTION
This command is used to initializes a new restart, marker, based on the marker_string parameter. The string may be either a single offset for a stream-mode restart marker, or a comma-separated list of start-end ranges.
PARAMETERS
marker - The restart marker to be unitialized.
RETURN VALUE
On success globus_ftp_client_restart_marker_from_string returns 0. On error, this command will raise an error and must be caught using the appropriate bgerror command.
EXAMPLE
lassign [ globus_ftp_client_restart_marker_from_string $marker $marker_string ] result
BUGS
None
TODO
None
NAME
globus_ftp_client_restart_marker_get_total
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_restart_marker_get_total
marker
DESCRIPTION
This command is used to get the total bytes accounted for in restart marker.
If this restart marker contains a stream offset then this value is the same as the offset (not the ASCII offset) that it was set with. If it is a range list, it returns a sum of all the bytes in the ranges.
PARAMETERS
marker - A previously initialized or copied restart marker.
RETURN VALUE
On success globus_ftp_client_restart_marker_get_total returns 0 and the total bytes accounted for in restart marker. On error, this command will raise an error and must be caught using the appropriate bgerror command.
EXAMPLE
lassign [ globus_ftp_client_restart_marker_get_total $marker ] result total_bytes
BUGS
None
TODO
None
NAME
globus_ftp_client_restart_marker_init
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_restart_marker_init
marker
DESCRIPTION
This command is used to initialize a restart marker.
PARAMETERS
marker - New restart marker.
RETURN VALUE
On success globus_ftp_client_restart_marker_init returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_restart_marker_init $marker ] result
BUGS
None
TODO
None
SEE ALSO
NAME
globus_ftp_client_restart_marker_insert_range
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_restart_marker_insert_range
marker
offset
end_offset
DESCRIPTION
This command is used to updates a restart marker with a new byte range, suitable for using to restart an extended block mode transfer. Adjacent ranges within the marker will be combined into a single entry in the marker.
This marker must be initialized by either calling globus_ftp_client_restart_marker_init or globus_ftp_client_restart_marker_copy.
A marker can only hold a range list or a stream offset. Calling this command after calling globus_ftp_client_restart_marker_set_offset will result in a marker suitable only for use restarting an extended block mode transfer.
PARAMETERS
marker - Restart marker.
offset - The starting offset of the range.
end_offset - The ending offset of the range.
RETURN VALUE
On success globus_ftp_client_restart_marker_insert_range returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_restart_marker_insert_range $marker $offset $end_offset ] result
BUGS
None
TODO
None
SEE ALSO
globus_ftp_client_restart_marker_set_offset, globus_ftp_client_operationattr_set_mode.
NAME
globus_ftp_client_restart_marker_set_ascii_offset
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_restart_marker_set_ascii_offset
marker
offset
ascii_offset
DESCRIPTION
This command is used to modify a restart marker to contain a stream offset, suitable for using to restart a steam mode transfer.
The marker must first be initialized by calling globus_ftp_client_restart_marker_init or globus_ftp_client_restart_marker_copy.
A marker can only hold a range list or a stream offset. Calling this function after calling globus_ftp_client_restart_marker_insert_range will delete the ranges associated with the marker, and replace it with a marker suitable only for use restarting a stream mode transfer.
When restarting an ASCII type transfer, use globus_ftp_client_restart_marker_set_ascii_offset to set both the offset used in the local representation of an ACSII file, and the network representation of the ASCII file. For UNIX systems, the former includes counts newlines as one character towards the file offset, and the latter counts them as 2 characters (CRLF).
PARAMETERS
marker - A restart marker.
offset - The local stream offset.
ascii_offset - The network ASCII representation of the offset.
RETURN VALUE
On success globus_ftp_client_restart_marker_set_ascii_offset returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_restart_marker_set_ascii_offset $marker $offset $ascii_offset ] result
BUGS
None
TODO
None
SEE ALSO
globus_ftp_client_restart_marker_insert_range, globus_ftp_client_restart_marker_set_offset, globus_ftp_client_operationattr_set_mode, globus_ftp_client_operationattr_set_type.
NAME
globus_ftp_client_restart_marker_set_offset
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_restart_marker_set_offset
marker
offset
DESCRIPTION
This command is used to modify a restart marker to contain a stream offset, suitable for using to restart a steam mode transfer.
The marker must first be initialized by calling globus_ftp_client_restart_marker_init or globus_ftp_client_restart_marker_copy.
A marker can only hold a range list or a stream offset. Calling this function after calling globus_ftp_client_restart_marker_insert_range will delete the ranges associated with the marker, and replace it with a marker suitable only for use restarting a stream mode transfer.
When restarting an ASCII type transfer, the offset must take into account the additional carriage return characters added to the data stream.
PARAMETERS
marker - A restart marker.
offset - The stream offset.
RETURN VALUE
On success globus_ftp_client_restart_marker_set_offset returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_ftp_client_restart_marker_set_offset $marker $offset ] result
BUGS
None
TODO
None
SEE ALSO
globus_ftp_client_restart_marker_insert_range, globus_ftp_client_operationattr_set_mode, globus_ftp_client_operationattr_set_type.
NAME
globus_ftp_client_restart_marker_to_string
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_restart_marker_to_string
marker
DESCRIPTION
This command is used to create a string representation of a restart marker.
PARAMETERS
marker - An initialized FTP client restart marker.
RETURN VALUE
On success globus_ftp_client_restart_marker_to_string returns 0 and the string representation of a restart marker. On error, this command will raise an error and must be caught using the appropriate bgerror command.
EXAMPLE
lassign [ globus_ftp_client_restart_marker_to_string $marker ] result marker_string
BUGS
None
TODO
None
NAME
globus_ftp_client_rmdir
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_rmdir
handle
url
operation_attr
script
DESCRIPTION
This command is used to remove a directory on an FTP server.
When the response to the "rmdir" request has been received the script will be invoked with the result of the "rmdir" operation.
PARAMETERS
handle - An FTP client handle to use for the rmdir operation.
url - The URL for the directory to be removed. The URL may be a FTP or GSIFTP URL.
attr - Attributes to use for this operation.
script - TCL script invoked when the command is completed. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_ftp_client_rmdir returns 0. On error, this command will raise an error and must be caught using the appropriate bgerror command.
EXAMPLE
lassign [ globus_ftp_client_rmdir $handle $url $operation_attr { callback callback_arg } ] result
BUGS
None
TODO
None
NAME
globus_ftp_client_size
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_size
handle
url
attr
script
DESCRIPTION
This command is used to request the size of a file from an FTP server.
When the filesize request is completed or aborted, the script will be invoked with the final status of the operation. If the callback is returns without an error, the filesize will be stored in the filesize parameter of the callback script.
Note: In ASCII mode, the size will be the size of the file after conversion to ASCII mode. The actual amount of data which is returned in the data callbacks may be less than this amount.
PARAMETERS
handle - An FTP client handle to use for the operation.
url - The URL to list. The URL may be a FTP or GSIFTP URL.
attr - Attributes for this operation.
script - TCL script invoked when the size check is completed. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_ftp_client_size returns 0 and the total size of the file, if it exists. On error, this command will raise an error and must be caught using the appropriate bgerror command.
EXAMPLE
lassign [ globus_ftp_client_size $handle $url $attr { callback callback_arg } ] result
BUGS
None
TODO
None
NAME
globus_ftp_client_third_party_transfer
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_third_party_transfer
handle
source_url
source_attr
dest_url
dest_attr
restart
script
DESCRIPTION
This command is used to transfer a file between two FTP servers.
When the transfer is completed or if the transfer is aborted, the script will be invoked with the final status of the transfer.
PARAMETERS
handle - An FTP client handle to use for the transfer operation.
source_url - The URL to transfer. The URL may be an FTP or GSIFTP URL.
source_attr - Attributes for the souce URL.
dest_url - The destination URL for the transfer. The URL may be an FTP or GSIFTP URL.
dest_attr - Attributes for the destination URL.
restart - A restart marker.
script - TCL script invoked once the "transfer" operation is completed. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_ftp_client_third_party_transfer returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
TBD
BUGS
None
TODO
None
NAME
globus_ftp_client_verbose_list
SYNOPSIS
package require globus_ftp_client
globus_ftp_client_verbose_list
handle
url
operation_attr
script
DESCRIPTION
This command is used to get a file listing from an FTP server.
This function starts a "LIST" transfer from an FTP server. If this function returns no error, then the user may immediately begin calling globus_ftp_client_read to retrieve the data associated with this listing.
When all of the data associated with the listing is retrieved, and all of the data callbacks have been called, or if the list request is aborted, the script will be invoked with the final status of the list.
PARAMETERS
handle - An FTP client handle to use for the list operation.
url - The URL to list. The URL may be a FTP or GSIFTP URL.
attr - Attributes for this file transfer.
script - TCL script invoked when the "list" is completed. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_ftp_client_verbose_list returns 0. On error, this command will raise an error and must be caught using the appropriate bgerror command.
EXAMPLE
lassign [ globus_ftp_client_verbose_list $handle $url $operation_attr { callback callback_arg } ] result
BUGS
None
TODO
None