.TH "globus_gass_copy.h" 3 "Mon Apr 30 2012" "Version 8.4" "globus gass copy" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_gass_copy.h \- 
.SH SYNOPSIS
.br
.PP
.SS "Data Structures"

.in +1c
.ti -1c
.RI "struct \fBglobus_gass_copy_glob_stat_t\fP"
.br
.RI "\fIGlob expanded entry information\&. \fP"
.in -1c
.SS "Defines"

.in +1c
.ti -1c
.RI "#define \fBGLOBUS_GASS_COPY_MODULE\fP   (&globus_i_gass_copy_module)"
.br
.in -1c
.SS "Typedefs"

.in +1c
.ti -1c
.RI "typedef void(* \fBglobus_gass_copy_performance_cb_t\fP )(void *user_arg, globus_gass_copy_handle_t *handle, globus_off_t total_bytes, float instantaneous_throughput, float avg_throughput)"
.br
.ti -1c
.RI "typedef void(* \fBglobus_gass_copy_glob_entry_cb_t\fP )(const char *url, const \fBglobus_gass_copy_glob_stat_t\fP *info_stat, void *user_arg)"
.br
.in -1c
.SS "Enumerations"

.in +1c
.ti -1c
.RI "enum \fBglobus_gass_copy_glob_entry_t\fP "
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "globus_result_t \fBglobus_gass_copy_glob_expand_url\fP (globus_gass_copy_handle_t *handle, const char *url, globus_gass_copy_attr_t *attr, \fBglobus_gass_copy_glob_entry_cb_t\fP entry_cb, void *user_arg)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_gass_copy_mkdir\fP (globus_gass_copy_handle_t *handle, char *url, globus_gass_copy_attr_t *attr)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Header file for the gass copy library\&. 


.SH "Define Documentation"
.PP 
.SS "#define \fBGLOBUS_GASS_COPY_MODULE\fP   (&globus_i_gass_copy_module)"
.PP
Module descriptor\&. Globus GASS Copy uses standard Globus module activation and deactivation\&. Before any Globus GASS Copy functions are called, the following function must be called:
.PP
.PP
.nf
      globus_module_activate(GLOBUS_GASS_COPY_MODULE)
.fi
.PP
.PP
This function returns GLOBUS_SUCCESS if Globus GASS Copy was successfully initialized, and you are therefore allowed to subsequently call Globus GASS Copy functions\&. Otherwise, an error code is returned, and Globus GASS Copy functions should not be subsequently called\&. This function may be called multiple times\&.
.PP
To deactivate Globus GASS Copy, the following function must be called:
.PP
.PP
.nf
    globus_module_deactivate(GLOBUS_GASS_COPY_MODULE)
.fi
.PP
.PP
This function should be called once for each time Globus GASS Copy was activated\&. 
.SH "Typedef Documentation"
.PP 
.SS "typedef void(* \fBglobus_gass_copy_performance_cb_t\fP)(void *user_arg, globus_gass_copy_handle_t *handle, globus_off_t total_bytes, float instantaneous_throughput, float avg_throughput)"
.PP
Gass copy transfer performance callback\&. This callback is registered with 'globus_gass_copy_register_performance_cb' It will be called during a transfer to supply performance information on current transfer\&. Its frequency will be at most one per second, but it is possible to receive no callbacks\&. This is possible in very short transfers and in ftp transfers in which the server does not provide performance information\&.
.PP
\fBParameters:\fP
.RS 4
\fIhandle\fP the gass copy handle this transfer is occurring on
.br
\fIuser_arg\fP a user pointer registered with 'globus_gass_copy_register_performance_cb'
.br
\fItotal_bytes\fP the total number of bytes transfer so far
.br
\fIinstantaneous_throughput\fP instantaneous rate of transfer (since last callback or start) (bytes / sec)
.br
\fIavg_throughput\fP the avg thoughput calculated since the start of the transfer (bytes / sec)
.RE
.PP
\fBReturns:\fP
.RS 4
.IP "\(bu" 2
n/a 
.PP
.RE
.PP

.SS "typedef void(* \fBglobus_gass_copy_glob_entry_cb_t\fP)(const char *url, const \fBglobus_gass_copy_glob_stat_t\fP *info_stat, void *user_arg)"
.PP
Gass copy glob entry callback\&. This callback is passed as a parameter to \fBglobus_gass_copy_glob_expand_url()\fP\&. It is called once for each entry that the original expands to\&.
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP The full url to the expanded entry\&. A directory entry will end in a forward slash '/'\&.
.br
\fIstat\fP A pointer to a \fBglobus_gass_copy_glob_stat_t\fP containing information about the entry\&.
.br
\fIuser_arg\fP The user_arg passed to globus_gass_copy_glob_expand()
.RE
.PP
\fBSee also:\fP
.RS 4
\fBglobus_gass_copy_glob_stat_t\fP, \fBglobus_gass_copy_glob_expand_url\fP 
.RE
.PP

.SH "Enumeration Type Documentation"
.PP 
.SS "enum \fBglobus_gass_copy_glob_entry_t\fP"
.PP
globbed entry types 
.SH "Function Documentation"
.PP 
.SS "globus_result_t \fBglobus_gass_copy_glob_expand_url\fP (globus_gass_copy_handle_t *handle, const char *url, globus_gass_copy_attr_t *attr, \fBglobus_gass_copy_glob_entry_cb_t\fPentry_cb, void *user_arg)"
.PP
Expand globbed url\&. This function expands wildcards in a globbed url, and calls entry_cb() on each one\&.
.PP
\fBParameters:\fP
.RS 4
\fIhandle\fP A gass copy handle to use for the operation\&.
.br
\fIurl\fP The URL to expand\&. The URL may be an ftp, gsiftp or file URL\&. Wildcard characters supported are '?' '*' '[ ]' in the filename portion of the url\&.
.br
\fIattr\fP Gass copy attributes for this operation\&.
.br
\fIentry_cb\fP Function to call with information about each entry
.br
\fIuser_arg\fP An argument to pass to entry_cb()
.RE
.PP
\fBReturns:\fP
.RS 4
This function returns an error when any of these conditions are true:
.IP "\(bu" 2
handle is GLOBUS_NULL
.IP "\(bu" 2
url is GLOBUS_NULL
.IP "\(bu" 2
url cannot be parsed
.IP "\(bu" 2
url is not a ftp, gsiftp or file url 
.PP
.RE
.PP

.PP
References globus_gass_copy_glob_expand_url(), GLOBUS_GASS_COPY_MODULE, globus_gass_copy_glob_stat_t::mdtm, globus_gass_copy_glob_stat_t::mode, globus_gass_copy_glob_stat_t::size, globus_gass_copy_glob_stat_t::symlink_target, globus_gass_copy_glob_stat_t::type, and globus_gass_copy_glob_stat_t::unique_id\&.
.SS "globus_result_t \fBglobus_gass_copy_mkdir\fP (globus_gass_copy_handle_t *handle, char *url, globus_gass_copy_attr_t *attr)"
.PP
Make directory\&. This function creates a directory given a ftp or file url\&.
.PP
\fBParameters:\fP
.RS 4
\fIhandle\fP A gass copy handle to use for the mkdir operation\&. 
.br
\fIurl\fP The URL for the directory to create\&. The URL may be an ftp, gsiftp or file URL\&. 
.br
\fIattr\fP Gass copy attributes for this operation\&.
.RE
.PP
\fBReturns:\fP
.RS 4
This function returns an error when any of these conditions are true:
.IP "\(bu" 2
handle is GLOBUS_NULL
.IP "\(bu" 2
url is GLOBUS_NULL
.IP "\(bu" 2
url cannot be parsed
.IP "\(bu" 2
url is not a ftp, gsiftp or file url
.IP "\(bu" 2
the directory could not be created 
.PP
.RE
.PP

.PP
References globus_gass_copy_get_url_mode(), globus_gass_copy_mkdir(), and GLOBUS_GASS_COPY_MODULE\&.
.SH "Author"
.PP 
Generated automatically by Doxygen for globus gass copy from the source code\&.