This module contains the API functions for a user to request a get, put, third-party transfer, or other FTP file operation.
|
Operation complete callback. Every FTP Client operation (get, put, transfer, mkdir, etc) is asynchronous. A callback of this type is passed to each of the operation function calls to let the user know when the operation is complete. The completion callback is called only once per operation, after all other callbacks for the operation have returned.
|
|
Feature Handle. Handle used to associate state with feature operations. |
|
Types for feature existence. FALSE and TRUE are known to be fact that a feature does or does not exist MAYBE means that the feature may exist |
|
Types of features.
|
|
Check for the existence of a file or directory on an FTP server. This function attempts to determine whether the specified URL points to a valid file or directory. The complete_callback will be invoked with the result of the existence check passed as a globus error object, or GLOBUS_SUCCESS.
|
|
Initialize the feature set, to be later used by globus_ftp_client_feat(). Each feature gets initial value GLOBUS_FTP_CLIENT_MAYBE.
|
|
Destroy the feature set.
|
|
Check the features supported by the server (FTP FEAT command). After this procedure completes, the features set (parameter u_features) represents the features supported by the server. Prior to calling this procedure, the structure should have been initialized by globus_ftp_client_features_init(); afterwards, it should be destroyed by globus_ftp_client_features_destroy(). After globus_ftp_client_feat() returns, each feature in the list has one of the values: GLOBUS_FTP_CLIENT_TRUE, GLOBUS_FTP_CLIENT_FALSE, or GLOBUS_FTP_CLIENT_MAYBE. The first two denote the server supporting, or not supporting, the given feature. The last one means that the test has not been performed. This is not necessarily caused by error; there might have been no reason to check for this particular feature.
|
|
Check if the feature is supported by the server. After the function completes, parameter answer contains the state of the server support of the given function. It can have one of the values: GLOBUS_FTP_CLIENT_TRUE, GLOBUS_FTP_CLIENT_FALSE, or GLOBUS_FTP_CLIENT_MAYBE.
|
|
Make a directory on an FTP server. This function starts a mkdir operation on a FTP server. When the response to the mkdir request has been received the complete_callback will be invoked with the result of the mkdir operation.
|
|
Make a directory on an FTP server. This function starts a rmdir operation on a FTP server. When the response to the rmdir request has been received the complete_callback will be invoked with the result of the rmdir operation.
|
|
Delete a file on an FTP server. This function starts a delete operation on a FTP server. Note that this functions will only delete files, not directories. When the response to the delete request has been received the complete_callback will be invoked with the result of the delete operation.
|
|
Get a file listing from an FTP server. This function starts a "NLST" transfer from an FTP server. If this function 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 complete_callback will be invoked with the final status of the list.
|
|
Get a file listing from an FTP server. This function starts a "LIST" transfer from an FTP server. If this function 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 complete_callback will be invoked with the final status of the list.
|
|
Get information about a file or directory from a FTP server. This function requests the STAT listing of a file or directory from an FTP server. When the STAT request is completed or aborted, the complete_callback will be invoked with the final status of the operation. If the callback is returns without an error, the STAT fact string will be stored in the globus_byte_t * pointed to by the stat_buffer parameter to this function.
|
|
Get a machine parseable file listing from an FTP server. This function starts a "MLSD" transfer from an FTP server. If this function 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 complete_callback will be invoked with the final status of the list.
|
|
Get information about a file or directory from a FTP server. This function requests the MLST fact string of a file or directory from an FTP server. When the MLST request is completed or aborted, the complete_callback 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 globus_byte_t * pointed to by the mlst_buffer parameter to this function.
|
|
Move a file on an FTP server. This function starts 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 complete_callback will be invoked with the result of the move operation.
|
|
Change permissions on a file. This function changes file permissions When the response to the move request has been received the complete_callback will be invoked with the result of the operation.
|
|
Get a file from an FTP server. This function starts a "get" file transfer from an FTP server. If this function returns GLOBUS_SUCCESS, 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 complete_callback will be invoked with the final status of the get.
|
|
Get a file from an FTP server. This function starts a "get" file transfer from an FTP server. If this function returns GLOBUS_SUCCESS, 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 complete_callback will be invoked with the final status of the get.
|
|
Get a file from an FTP server with server-side processing. This function starts a "get" file transfer from an FTP server. If this function returns GLOBUS_SUCCESS, 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 complete_callback will be invoked with the final status of the get. This function differs from the globus_ftp_client_get() function 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.
|
|
Store a file on an FTP server. This function starts a "put" file transfer to an FTP server. If this function returns GLOBUS_SUCCESS, then the user may immediately begin calling globus_ftp_client_register_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 complete_callback will be invoked with the final status of the put.
|
|
Store a file on an FTP server. This function starts a "put" file transfer to an FTP server. If this function returns GLOBUS_SUCCESS, then the user may immediately begin calling globus_ftp_client_register_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 complete_callback will be invoked with the final status of the put.
|
|
Store a file on an FTP server with server-side processing. This function starts a "put" file transfer to an FTP server. If this function returns GLOBUS_SUCCESS, then the user may immediately begin calling globus_ftp_client_register_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 complete_callback will be invoked with the final status of the put. This function differs from the globus_ftp_client_put() function 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 alogirhtm string provided by the user. if the server does not understand the requested algorithm, the transfer will fail.
|
|
Transfer a file between two FTP servers. This function starts up a third-party file transfer between FTP server. This function returns immediately. When the transfer is completed or if the transfer is aborted, the complete_callback will be invoked with the final status of the transfer.
|
|
Transfer a file between two FTP servers. This function starts up a third-party file transfer between FTP server. This function returns immediately. When the transfer is completed or if the transfer is aborted, the complete_callback will be invoked with the final status of the transfer.
|
|
Transfer a file between two FTP servers with server-side processing. This function starts up a third-party file transfer between FTP server. This function returns immediately. When the transfer is completed or if the transfer is aborted, the complete_callback will be invoked with the final status of the transfer. This function differes from the globus_ftp_client_third_party_transfer() funciton 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 alogirhtm string provided by the user. if the server does not understand * the requested algorithm, the transfer will fail.
|
|
Get a file's modification time from an FTP server. This function requests the modification time of a file from an FTP server. When the modification time request is completed or aborted, the complete_callback will be invoked with the final status of the operation. If the callback is returns without an error, the modification time will be stored in the globus_abstime_t value pointed to by the modification_time parameter to this function.
|
|
Get a file's size from an FTP server. This function requests the size of a file from an FTP server. When the size request is completed or aborted, the complete_callback will be invoked with the final status of the operation. If the callback is returns without an error, the size will be stored in the globus_off_t value pointed to by the size parameter to this function.
|
|
Get a file's checksum from an FTP server. This function requests the checksum of a file from an FTP server. When the request is completed or aborted, the complete_callback will be invoked with the final status of the operation. If the callback is returns without an error, the checksum will be stored in the char * buffer provided in the 'checksum' parameter to this function. The buffer must be large enough to hold the expected checksum result.
|
|
Abort the operation currently in progress.
|
about globus |
globus toolkit |
dev.globus
Comments? webmaster@globus.org