17 #ifndef GLOBUS_GASS_COPY_H
18 #define GLOBUS_GASS_COPY_H
25 #ifndef GLOBUS_GLOBAL_DOCUMENT_SET
54 #include "globus_gass_transfer.h"
55 #include "globus_ftp_client.h"
56 #include "globus_io.h"
93 #define GLOBUS_GASS_COPY_MODULE (&globus_i_gass_copy_module)
96 globus_module_descriptor_t globus_i_gass_copy_module;
98 #define _GASCSL(s) globus_common_i18n_get_string( \
99 GLOBUS_GASS_COPY_MODULE, \
103 typedef struct globus_gass_copy_state_s globus_gass_copy_state_t;
105 typedef struct globus_gass_copy_perf_info_s globus_gass_copy_perf_info_t;
142 globus_off_t total_bytes,
143 float instantaneous_throughput,
144 float avg_throughput);
156 globus_object_t * error);
164 GLOBUS_GASS_COPY_STATUS_NONE,
165 GLOBUS_GASS_COPY_STATUS_PENDING,
166 GLOBUS_GASS_COPY_STATUS_INITIAL,
167 GLOBUS_GASS_COPY_STATUS_SOURCE_READY,
168 GLOBUS_GASS_COPY_STATUS_TRANSFER_IN_PROGRESS,
169 GLOBUS_GASS_COPY_STATUS_READ_COMPLETE,
170 GLOBUS_GASS_COPY_STATUS_WRITE_COMPLETE,
171 GLOBUS_GASS_COPY_STATUS_DONE,
172 GLOBUS_GASS_COPY_STATUS_FAILURE,
173 GLOBUS_GASS_COPY_STATUS_CANCEL,
174 GLOBUS_GASS_COPY_STATUS_DONE_SUCCESS,
175 GLOBUS_GASS_COPY_STATUS_DONE_FAILURE,
176 GLOBUS_GASS_COPY_STATUS_DONE_CANCELLED
185 GLOBUS_GASS_COPY_URL_MODE_UNSUPPORTED,
186 GLOBUS_GASS_COPY_URL_MODE_FTP,
187 GLOBUS_GASS_COPY_URL_MODE_GASS,
188 GLOBUS_GASS_COPY_URL_MODE_IO
263 globus_ftp_client_handle_t ftp_handle;
274 globus_off_t partial_end_offset;
275 globus_off_t partial_bytes_remaining;
297 globus_ftp_client_operationattr_t * ftp_attr;
298 globus_io_attr_t * io;
299 globus_gass_transfer_requestattr_t * gass_requestattr;
311 globus_ftp_client_handleattr_t * ftp_attr;
325 globus_gass_copy_handleattr_init(
329 globus_gass_copy_handleattr_destroy(
333 globus_gass_copy_handleattr_set_ftp_attr(
335 globus_ftp_client_handleattr_t * ftp_attr);
354 globus_bool_t no_third_party_transfers);
360 globus_bool_t * no_third_party_transfers);
366 globus_off_t * offset,
367 globus_off_t * end_offset);
374 globus_off_t end_offset);
380 globus_bool_t send_allo);
390 globus_bool_t always_stat);
401 globus_gass_copy_get_ftp_handle(
403 globus_ftp_client_handle_t * ftp_handle);
414 globus_ftp_client_operationattr_t * ftp_attr);
419 globus_io_attr_t * io_attr);
424 globus_gass_transfer_requestattr_t * gass_attr);
442 globus_io_handle_t * dest_handle);
447 globus_io_handle_t * source_handle,
462 void * callback_arg);
469 globus_io_handle_t * dest_handle,
471 void * callback_arg);
476 globus_io_handle_t * source_handle,
480 void * callback_arg);
505 void * cancel_callback_arg);
548 globus_gass_copy_attr_set_tcpbuffer(
550 globus_ftp_control_tcpbuffer_t * tcpbuffer_info);
554 globus_gass_copy_attr_set_parallelism(
556 globus_ftp_control_parallelism_t * parallelism_info);
560 globus_gass_copy_attr_set_striping(
562 globus_ftp_control_striping_t * striping_info);
566 globus_gass_copy_attr_set_authorization(
568 globus_io_authorization_t * authorization_info);
572 globus_gass_copy_attr_set_secure_channel(
574 globus_io_secure_channel_t * secure_channel_info);
582 GLOBUS_GASS_COPY_GLOB_ENTRY_UNKNOWN,
583 GLOBUS_GASS_COPY_GLOB_ENTRY_FILE,
584 GLOBUS_GASS_COPY_GLOB_ENTRY_DIR,
585 GLOBUS_GASS_COPY_GLOB_ENTRY_OTHER
722 globus_gass_copy_cksm(
728 const char * algorithm,
732 globus_gass_copy_cksm_async(
738 const char * algorithm,
741 void * callback_arg);
744 globus_gass_copy_stat(
globus_bool_t external_third_party
Definition: globus_gass_copy.h:223
globus_gass_copy_status_t
Status States.
Definition: globus_gass_copy.h:162
globus_result_t globus_gass_copy_attr_set_gass(globus_gass_copy_attr_t *attr, globus_gass_transfer_requestattr_t *gass_attr)
Set the http/https attributes.
Definition: globus_gass_copy.c:995
globus_off_t partial_offset
Definition: globus_gass_copy.h:273
globus_result_t globus_gass_copy_set_buffer_length(globus_gass_copy_handle_t *handle, int length)
Set the size of the buffer to be used for doing transfers.
Definition: globus_gass_copy.c:513
globus_gass_copy_glob_entry_t type
Definition: globus_gass_copy.h:596
void(* globus_gass_copy_performance_cb_t)(void *user_arg, globus_gass_copy_handle_t *handle, globus_off_t total_bytes, float instantaneous_throughput, float avg_throughput)
Performance Callback.
Definition: globus_gass_copy.h:139
globus_result_t globus_gass_copy_flush_url_state(globus_gass_copy_handle_t *handle, char *url)
Remove an FTP or GridFTP cached connection.
Definition: globus_gass_copy.c:5823
Handle Attributes.
Definition: globus_gass_copy.h:309
const char * globus_gass_copy_get_status_string(globus_gass_copy_handle_t *handle)
Get the status string of a transfer.
Definition: globus_gass_copy.c:1650
globus_gass_copy_callback_t user_callback
Definition: globus_gass_copy.h:228
void(* globus_gass_copy_callback_t)(void *callback_arg, globus_gass_copy_handle_t *handle, globus_object_t *error)
Copy Callback.
Definition: globus_gass_copy.h:153
globus_bool_t no_third_party_transfers
Definition: globus_gass_copy.h:261
globus_result_t globus_gass_copy_set_no_third_party_transfers(globus_gass_copy_handle_t *handle, globus_bool_t no_third_party_transfers)
Enable/Disable third-party transfers.
Definition: globus_gass_copy.c:596
globus_result_t globus_gass_copy_get_url_mode(char *url, globus_gass_copy_url_mode_t *mode)
Get URL scheme.
Definition: globus_gass_copy.c:1042
globus_result_t globus_gass_copy_get_status(globus_gass_copy_handle_t *handle, globus_gass_copy_status_t *status)
Get the status code of a transfer.
Definition: globus_gass_copy.c:1576
Glob expanded entry information.
Definition: globus_gass_copy.h:592
void * callback_arg
Definition: globus_gass_copy.h:233
char * unique_id
Definition: globus_gass_copy.h:603
globus_result_t globus_gass_copy_handle_to_url(globus_gass_copy_handle_t *handle, globus_io_handle_t *source_handle, char *dest_url, globus_gass_copy_attr_t *dest_attr)
Blocking transfer from an IO handle to an URL.
Definition: globus_gass_copy.c:4908
struct globus_gass_copy_attr_s globus_gass_copy_attr_t
Attributes.
Attributes.
Definition: globus_gass_copy.h:295
globus_result_t globus_gass_copy_register_performance_cb(globus_gass_copy_handle_t *handle, globus_gass_copy_performance_cb_t callback, void *user_arg)
Register a performance information callback.
Definition: globus_gass_copy.c:1119
globus_result_t globus_gass_copy_url_to_handle(globus_gass_copy_handle_t *handle, char *source_url, globus_gass_copy_attr_t *source_attr, globus_io_handle_t *dest_handle)
Blocking Transfer from an URL to an IO handle.
Definition: globus_gass_copy.c:4776
globus_result_t globus_gass_copy_get_no_third_party_transfers(globus_gass_copy_handle_t *handle, globus_bool_t *no_third_party_transfers)
Query third-party transfer status.
Definition: globus_gass_copy.c:653
globus_gass_copy_glob_entry_t
Definition: globus_gass_copy.h:581
globus_result_t globus_gass_copy_cancel(globus_gass_copy_handle_t *handle, globus_gass_copy_callback_t cancel_callback, void *cancel_callback_arg)
Cancel a transfer.
Definition: globus_gass_copy.c:5940
globus_bool_t always_stat_on_expand
Definition: globus_gass_copy.h:285
globus_result_t globus_gass_copy_get_buffer_length(globus_gass_copy_handle_t *handle, int *length)
Get the size of the transfer buffer.
Definition: globus_gass_copy.c:553
void(* globus_gass_copy_glob_entry_cb_t)(const char *url, const globus_gass_copy_glob_stat_t *info_stat, void *user_arg)
Gass copy glob entry callback.
Definition: globus_gass_copy.h:647
globus_result_t globus_gass_copy_set_stat_on_expand(globus_gass_copy_handle_t *handle, globus_bool_t always_stat)
Make globus_gass_copy_expand_url() always send stat info.
Definition: globus_gass_copy.c:696
globus_result_t globus_gass_copy_handle_destroy(globus_gass_copy_handle_t *handle)
Destroy a GASS Copy handle.
Definition: globus_gass_copy.c:369
globus_object_t * err
Definition: globus_gass_copy.h:248
globus_result_t globus_gass_copy_url_to_url(globus_gass_copy_handle_t *handle, char *source_url, globus_gass_copy_attr_t *source_attr, char *dest_url, globus_gass_copy_attr_t *dest_attr)
Blocking Transfer between URLs.
Definition: globus_gass_copy.c:4641
globus_gass_copy_state_t * state
Definition: globus_gass_copy.h:206
int buffer_length
Definition: globus_gass_copy.h:253
Copy Handle.
Definition: globus_gass_copy.h:195
globus_result_t globus_gass_copy_get_user_pointer(globus_gass_copy_handle_t *handle, void **user_data)
Get the user pointer in a handle.
Definition: globus_gass_copy.c:5912
globus_result_t globus_gass_copy_attr_init(globus_gass_copy_attr_t *attr)
Initialize an attribute structure.
Definition: globus_gass_copy.c:848
globus_result_t globus_gass_copy_set_partial_offsets(globus_gass_copy_handle_t *handle, globus_off_t offset, globus_off_t end_offset)
Set partial file offsets.
Definition: globus_gass_copy.c:725
globus_result_t globus_gass_copy_set_allocate(globus_gass_copy_handle_t *handle, globus_bool_t send_allo)
Set allo on or off.
Definition: globus_gass_copy.c:682
int mode
Definition: globus_gass_copy.h:613
struct globus_gass_copy_handleattr_s globus_gass_copy_handleattr_t
Handle Attributes.
globus_result_t globus_gass_copy_get_partial_offsets(globus_gass_copy_handle_t *handle, globus_off_t *offset, globus_off_t *end_offset)
Get partial transfer offsets.
Definition: globus_gass_copy.c:771
globus_bool_t send_allo
Definition: globus_gass_copy.h:280
globus_gass_copy_url_mode_t
URL Modes.
Definition: globus_gass_copy.h:183
globus_gass_copy_callback_t user_cancel_callback
Definition: globus_gass_copy.h:238
globus_result_t globus_gass_copy_handle_init(globus_gass_copy_handle_t *handle, globus_gass_copy_handleattr_t *handle_attr)
Initialize a GASS Copy handle.
Definition: globus_gass_copy.c:292
globus_result_t globus_gass_copy_register_url_to_handle(globus_gass_copy_handle_t *handle, char *source_url, globus_gass_copy_attr_t *source_attr, globus_io_handle_t *dest_handle, globus_gass_copy_callback_t callback_func, void *callback_arg)
Nonblocking transfer from an URL to an IO handle.
Definition: globus_gass_copy.c:5455
globus_result_t globus_gass_copy_cache_url_state(globus_gass_copy_handle_t *handle, char *url)
Cache connections to an FTP or GridFTP server.
Definition: globus_gass_copy.c:5753
globus_result_t globus_gass_copy_attr_set_ftp(globus_gass_copy_attr_t *attr, globus_ftp_client_operationattr_t *ftp_attr)
Set the attributes for ftp/gsiftp transfers.
Definition: globus_gass_copy.c:897
globus_result_t globus_gass_copy_glob_expand_url(globus_gass_copy_handle_t *handle, const char *url, globus_gass_copy_attr_t *attr, globus_gass_copy_glob_entry_cb_t entry_cb, void *user_arg)
Expand globbed url.
Definition: globus_gass_copy_glob.c:135
globus_off_t size
Definition: globus_gass_copy.h:623
globus_result_t globus_gass_copy_set_user_pointer(globus_gass_copy_handle_t *handle, void *user_data)
Set the user pointer in a handle.
Definition: globus_gass_copy.c:5884
char * symlink_target
Definition: globus_gass_copy.h:608
globus_result_t globus_gass_copy_attr_set_io(globus_gass_copy_attr_t *attr, globus_io_attr_t *io_attr)
Set file transfers attributes.
Definition: globus_gass_copy.c:946
globus_ftp_client_handle_t ftp_handle_2
Definition: globus_gass_copy.h:267
globus_result_t globus_gass_copy_mkdir(globus_gass_copy_handle_t *handle, char *url, globus_gass_copy_attr_t *attr)
Make directory.
Definition: globus_gass_copy_glob.c:1768
globus_gass_copy_status_t status
Definition: globus_gass_copy.h:200
void * user_pointer
Definition: globus_gass_copy.h:211
globus_gass_copy_perf_info_t * performance
Definition: globus_gass_copy.h:217
globus_result_t globus_gass_copy_register_url_to_url(globus_gass_copy_handle_t *handle, char *source_url, globus_gass_copy_attr_t *dest_attr, char *dest_url, globus_gass_copy_attr_t *source_attr, globus_gass_copy_callback_t callback_func, void *callback_arg)
Definition: globus_gass_copy.c:5055
void * cancel_callback_arg
Definition: globus_gass_copy.h:243
globus_result_t globus_gass_copy_register_handle_to_url(globus_gass_copy_handle_t *handle, globus_io_handle_t *source_handle, char *dest_url, globus_gass_copy_attr_t *dest_attr, globus_gass_copy_callback_t callback_func, void *callback_arg)
Definition: globus_gass_copy.c:5615
int mdtm
Definition: globus_gass_copy.h:618