Generated from ./../../../tcl/swig/globus_gass_copy.i with ROBODoc v4.99.6 on Mon Jun 05 10:37:52 2006

TABLE OF CONTENTS


[Functions] globus_gass_copy/globus_gass_copy_attr_init

[top][index]

NAME

globus_gass_copy_attr_init

SYNOPSIS

package require globus_gass_copy

globus_gass_copy_attr_init attr

DESCRIPTION

This command is used to initialize an attribute structure.

The command can be used to pass the globus_gass_copy library information about how a transfer should be performed. It must first be initialized by calling this command. Then any or all of the following functions may be called to set attributes associated with a particular protocol: globus_gass_copy_attr_set_ftp, globus_gass_copy_attr_set_gass, globus_gass_copy_attr_set_io. Any comamnd which takes attr as an argument will also accept NULL, in which case the appropriate set of default attributes will be used.

RETURN VALUE

On success globus_gass_copy_attr_init returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gass_copy_attr_init $attr ] result

BUGS

None

TODO

None

SEE ALSO

globus_gass_copy_attr_set_ftp, globus_gass_copy_attr_set_gass, globus_gass_copy_attr_set_io, globus_gass_copy_get_url_mode


[Functions] globus_gass_copy/globus_gass_copy_attr_set_ftp

[top][index]

NAME

globus_gass_copy_set_ftp

SYNOPSIS

package require globus_gass_copy

globus_gass_copy_set_ftp globus_gass_copy_attr ftp_attr

DESCRIPTION

This command is used to set the attributes for ftp/gsiftp transfers.

In order to specify attributes for ftp/gsiftp transfers, ftp_attr should be initialized and its values set using the appropriate globus_ftp_client_operationattr_* commands. The globus_ftp_client_operationattr_t * can then be passed to the globus_gass_copy_attr via this command.

RETURN VALUE

On success globus_gass_copy_set_ftp returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gass_copy_set_ftp $globus_gass_copy_attr $ftp_attr ] result

BUGS

None

TODO

None

SEE ALSO

globus_gass_copy_attr_init, globus_gass_copy_attr_set_gass, globus_gass_copy_attr_set_io, globus_gass_copy_get_url_mode


[Functions] globus_gass_copy/globus_gass_copy_attr_set_gass

[top][index]

NAME

globus_gass_copy_set_gass

SYNOPSIS

package require globus_gass_copy

globus_gass_copy_set_gass globus_gass_copy_attr globus_gass_transfer_requestattr

DESCRIPTION

This command is used to set the attributes for http/https transfers.

In order to specify attributes for http/https transfers, globus_gass_transfer_requestattr should be initialized and its values set using the appropriate globus_gass_transfer_requestattr_* command. The globus_gass_transfer_requestattr can then be passed to the globus_gass_copy_attr via this command.

RETURN VALUE

On success globus_gass_copy_set_gass returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gass_copy_set_gass $globus_gass_copy_attr $globus_gass_transfer_requestattr ] result

BUGS

None

TODO

None

SEE ALSO

globus_gass_copy_attr_init, globus_gass_copy_attr_set_io, globus_gass_copy_attr_set_ftp, globus_gass_copy_get_url_mode


[Functions] globus_gass_copy/globus_gass_copy_attr_set_io

[top][index]

NAME

globus_gass_copy_set_io

SYNOPSIS

package require globus_gass_copy

globus_gass_copy_set_io globus_gass_copy_attr io_attr

DESCRIPTION

This command is used to set the attributes for file transfers.

In order to specify attributes for file transfers, io_attr should be initialized and its values set using the appropriate globus_io_attr_* command. The io_attr can then be passed to the globus_gass_copy_attr via this command.

RETURN VALUE

On success globus_gass_copy_set_io returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gass_copy_set_io $globus_gass_copy_attr $io_attr ] result

BUGS

None

TODO

None

SEE ALSO

globus_gass_copy_attr_init, globus_gass_copy_attr_set_gass, globus_gass_copy_attr_set_ftp, globus_gass_copy_get_url_mode


[Functions] globus_gass_copy/globus_gass_copy_cache_url_state

[top][index]

NAME

globus_gass_copy_cache_url_state

SYNOPSIS

package require globus_gass_copy

globus_gass_copy_cache_url_state handle url

DESCRIPTION

This command is used to explicitly cache connections to URL server. When an URL is cached, the connection to the URL server will not be closed after a file transfer completes.

RETURN VALUE

On success globus_gass_copy_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_gass_copy_cache_url_state $handle $url ] result

BUGS

None

TODO

None

SEE ALSO

globus_gass_copy_flush_url_state


[Functions] globus_gass_copy/globus_gass_copy_flush_url_state

[top][index]

NAME

globus_gass_copy_flush_url_state

SYNOPSIS

package require globus_gass_copy

globus_gass_copy_flush_url_state handle url

DESCRIPTION

This command is used to explicitly remove a cached connection to an FTP or GSIFTP server. If an idle connection to an FTP server exists, it will be closed.

RETURN VALUE

On success globus_gass_copy_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_gass_copy_flush_url_state $handle $url ] result

BUGS

None

TODO

None

SEE ALSO

globus_gass_copy_cache_url_state


[Functions] globus_gass_copy/globus_gass_copy_get_buffer_length

[top][index]

NAME

globus_gass_copy_get_buffer_length

SYNOPSIS

package require globus_gass_copy

globus_gass_copy_get_buffer_length handle

DESCRIPTION

This command is used to get the size of the buffer being used for doing transfers.

This command allows the user to get the size of the buffer that is being used for doing transfers.

RETURN VALUE

On success, globus_gass_copy_get_buffer_length returns 0 and the length, in bytes, of the buffer. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gass_copy_get_buffer_length $handle ] result length

BUGS

None

TODO

None

SEE ALSO

globus_gass_copy_handle_init, globus_gass_copy_handle_destroy, globus_gass_copy_set_buffer_length


[Functions] globus_gass_copy/globus_gass_copy_get_no_third_party_transfers

[top][index]

NAME

globus_gass_copy_get_no_third_party_transfers

SYNOPSIS

package require globus_gass_copy

globus_gass_copy_get_no_third_party_transfers handle

DESCRIPTION

This command is used to query if third-party transfers are turned on or off.

This command allows the user to see if third-party transfers are turned on or off for ftp to ftp transfers associated with a particular handle. This is often desired if one of the servers involved in the transfer does not allow third-party transfers.

RETURN VALUE

On success, globus_gass_copy_get_no_third_party_transfers returns 0 and third-party transfers flag. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gass_copy_get_no_third_party_transfers $handle ] result no_third_party_transfers

BUGS

None

TODO

None

SEE ALSO

globus_gass_copy_handle_init, globus_gass_copy_handle_destroy, globus_gass_copy_set_no_third_party_transfers


[Functions] globus_gass_copy/globus_gass_copy_get_partial_offsets

[top][index]

NAME

globus_gass_copy_get_partial_offsets

SYNOPSIS

package require globus_gass_copy

globus_gass_copy_get_partial_offsets handle

DESCRIPTION

This command is used to get the offsets being used for doing partial transfers.

This command allows the user to get the offsets that are being used for doing partial transfers. An offset of -1 means partial transfers are disabled.

RETURN VALUE

On success, globus_gass_copy_get_partial_offsets returns 0, the starting and ending offsets. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gass_copy_get_partial_offsets $handle ] result starting_offset ending_offset

BUGS

None

TODO

None

SEE ALSO

globus_gass_copy_handle_init, globus_gass_copy_handle_destroy, globus_gass_copy_set_partial_offsets


[Functions] globus_gass_copy/globus_gass_copy_get_status

[top][index]

NAME

globus_gass_copy_get_status

SYNOPSIS

package require globus_gass_copy

globus_gass_copy_get_status handle

DESCRIPTION

This command is used to get the status code of the current transfer.

Get the status of the last transfer to be initiated using the given handle. Only one transfer can be active on a handle at a given time, therefore new transfers may only be initiated when the current status is one of the following: GLOBUS_GASS_COPY_STATUS_NONE, GLOBUS_GASS_COPY_STATUS_DONE_SUCCESS, GLOBUS_GASS_COPY_STATUS_DONE_FAILURE, GLOBUS_GASS_COPY_STATUS_DONE_CANCELLED

RETURN VALUE

On success globus_gass_copy_get_status returns 0 and transfer status. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gass_copy_get_status $handle ] result transfer_status

BUGS

None

TODO

None

SEE ALSO

globus_gass_copy_get_status_string


[Functions] globus_gass_copy/globus_gass_copy_get_status_string

[top][index]

NAME

globus_gass_copy_get_status_string

SYNOPSIS

package require globus_gass_copy

globus_gass_copy_get_status_string handle

DESCRIPTION

This command is used to get the status string of the current transfer.

Get the status of the last transfer to be initiated using the given handle. Only one transfer can be active on a handle at a given time, therefore new transfers may only be initiated when the current status is one of the following: GLOBUS_GASS_COPY_STATUS_NONE, GLOBUS_GASS_COPY_STATUS_DONE_SUCCESS, GLOBUS_GASS_COPY_STATUS_DONE_FAILURE, GLOBUS_GASS_COPY_STATUS_DONE_CANCELLED

RETURN VALUE

On success globus_gass_copy_get_status returns 0 and transfer status. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gass_copy_get_status_string $handle ] result transfer_status

BUGS

None

TODO

None

SEE ALSO

globus_gass_copy_get_status


[Functions] globus_gass_copy/globus_gass_copy_get_url_mode

[top][index]

NAME

globus_gass_copy_get_url_mode

SYNOPSIS

package require globus_gass_copy

globus_gass_copy_get_url_mode url

DESCRIPTION

This command is used to classify the URL schema into the transfer method that will be used to do the actual tranfer.

This command enables the user to determine what protocol will be used to transfer data to/from a particular url. This information can then be used to specify the appropriate attributes when initiating a transfer.

RETURN VALUE

On success globus_gass_copy_get_url_mode returns 0 and url_mode. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gass_copy_get_url_mode $url ] result url_mode

BUGS

None

TODO

None

SEE ALSO

globus_gass_copy_attr_init, globus_gass_copy_attr_set_io, globus_gass_copy_attr_set_ftp, globus_gass_copy_get_set_gass


[Functions] globus_gass_copy/globus_gass_copy_get_user_pointer

[top][index]

NAME

globus_gass_copy_get_user_pointer

SYNOPSIS

package require globus_gass_copy

globus_gass_copy_get_user_pointer handle

DESCRIPTION

This command is used to get the pointer in the handle that points to user-allocated memory.

RETURN VALUE

On success globus_gass_copy_get_user_pointer returns 0 and the user-specified pointer in the handle structure. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gass_copy_get_user_pointer $handle ] result user_pointer

BUGS

None

TODO

None

SEE ALSO

globus_gass_copy_set_user_pointer


[Functions] globus_gass_copy/globus_gass_copy_glob_expand_url

[top][index]

NAME

globus_gass_copy_glob_expand_url

SYNOPSIS

package require globus_gass_copy

globus_gass_copy_glob_expand_url handle url attr script

DESCRIPTION

This command is used to expand wildcards in a globbed URL, and invokes the script on each one.

RETURN VALUE

On success globus_gass_copy_glob_expand_url returns 0. On error, this command will raise an error and must be caught using the appropriate bgerror command.

EXAMPLE

lassign [ globus_gass_copy_glob_expand_url $handle $url $attr { entry_callback user_arg } ] result

BUGS

None

TODO

None

SEE ALSO

None


[Functions] globus_gass_copy/globus_gass_copy_handle_destroy

[top][index]

NAME

globus_gass_copy_handle_destroy

SYNOPSIS

package require globus_gass_copy

globus_gass_copy_handle_destroy handle

DESCRIPTION

This command is used to destroy a GASS Copy handle, which was initialized using globus_gass_copy_handle_init, that will no longer be used for doing transfers. Once the handle is detroyed, no further transfers should be associated with it.

RETURN VALUE

On success globus_gass_copy_handle_destroy returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gass_copy_handle_destroy $handle ] result

BUGS

None

TODO

None

SEE ALSO

globus_gass_copy_handle_init, globus_ftp_client_handle_destroy


[Functions] globus_gass_copy/globus_gass_copy_handle_init

[top][index]

NAME

globus_gass_copy_handle_init

SYNOPSIS

package require globus_gass_copy

globus_gass_copy_handle_init handle attr

DESCRIPTION

This command is used to initialize a GASS Copy handle.

A globus_gass_copy_handle must be initialized before any transfers may be associated with it. This function initializes a globus_gass_copy_handle to be used for doing transfers, this includes initializing a globus_ftp_client_handle which will be used for doing any FTP/GSIFTP transfers. The same handle may be used to perform multiple, consecutive transfers. However, there can only be one transfer associated with a particular handle at any given time. After all transfers to be associated with this handle have completed, the handle should be destroyed by calling globus_gass_copy_handle_destroy.

RETURN VALUE

On success globus_gass_copy_handle_init returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gass_copy_handle_init $handle NULL ] result

BUGS

None

TODO

None

SEE ALSO

globus_gass_copy_handle_destroy, globus_gass_copy_handleattr_init, globus_ftp_client_handle_init


[Functions] globus_gass_copy/globus_gass_copy_handle_to_url

[top][index]

NAME

globus_gass_copy_handle_to_url

SYNOPSIS

package require globus_gass_copy

globus_gass_copy_handle_to_url handle source_handle dest_url dest_attr

DESCRIPTION

This command is used to transfer data from an I/O handle to destination URL in blocking mode.

RETURN VALUE

On success globus_gass_copy_handle_to_url returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gass_copy_handle_to_url $handle $source_io_handle $dest_url $dest_attr ] result

BUGS

None

TODO

None

SEE ALSO

globus_gass_copy_url_to_handle, globus_gass_copy_url_to_url


[Functions] globus_gass_copy/globus_gass_copy_mkdir

[top][index]

NAME

globus_gass_copy_mkdir

SYNOPSIS

package require globus_gass_copy

globus_gass_copy_mkdir handle url attr

DESCRIPTION

This command is used to create a directory given a FTP or file URL.

RETURN VALUE

On success globus_gass_copy_mkdir returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gass_copy_mkdir $handle $url $attr ] result

BUGS

None

TODO

None

SEE ALSO

None


[Functions] globus_gass_copy/globus_gass_copy_register_handle_to_url

[top][index]

NAME

globus_gass_copy_register_handle_to_url

SYNOPSIS

package require globus_gass_copy

globus_gass_copy_register_handle_to_url handle source_handle dest_url dest_attr script

DESCRIPTION

This command is used to transfer data from source I/O handle to destination URL in asynchronous mode. When the transfer is completed or if the transfer is aborted, the script will be invoked with the final status of the transfer.

RETURN VALUE

On success globus_gass_copy_register_handle_to_url returns 0. On error, this command will raise an error and must be caught using the appropriate bgerror command.

EXAMPLE

lassign [ globus_gass_copy_register_handle_to_url $handle $source_handle $dest_url $dest_attr { callback_script user_arg } ] result

BUGS

None

TODO

None

SEE ALSO

globus_gass_copy_register_url_to_url, globus_gass_copy_register_url_to_handle


[Functions] globus_gass_copy/globus_gass_copy_register_performance_cb

[top][index]

NAME

globus_gass_copy_register_performance_cb

SYNOPSIS

package require globus_gass_copy

globus_gass_copy_register_performance_cb handle script

DESCRIPTION

This command is used to register a performance information callback.

RETURN VALUE

On success globus_gass_copy_register_performance_cb returns 0. On error, this command will raise an error and must be caught using the appropriate bgerror command.

EXAMPLE

lassign [ globus_gass_copy_register_performance_cb $handle { callback_script user_arg } ] result

BUGS

None

TODO

None

SEE ALSO

None


[Functions] globus_gass_copy/globus_gass_copy_register_url_to_handle

[top][index]

NAME

globus_gass_copy_register_url_to_handle

SYNOPSIS

package require globus_gass_copy

globus_gass_copy_register_url_to_handle gass_copy_handle source_url source_attr dest_handle script

DESCRIPTION

This command is used to transfer data from source URL to destination I/O handle in asynchronous mode. When the transfer is completed or if the transfer is aborted, the script will be invoked with the final status of the transfer.

RETURN VALUE

On success globus_gass_copy_register_url_to_handle returns 0. On error, this command will raise an error and must be caught using the appropriate bgerror command.

EXAMPLE

lassign [ globus_gass_copy_register_url_to_handle $handle $source_url NULL $dest_handle { callback_script user_arg } ] result

BUGS

None

TODO

None

SEE ALSO

globus_gass_copy_register_url_to_url, globus_gass_copy_register_handle_to_url


[Functions] globus_gass_copy/globus_gass_copy_register_url_to_url

[top][index]

NAME

globus_gass_copy_register_url_to_url

SYNOPSIS

package require globus_gass_copy

globus_gass_copy_register_url_to_url handle source_url source_attr dest_url dest_attr script

DESCRIPTION

This command is used to transfer data from source URL to destination URL in asynchronous mode. When the transfer is completed or if the transfer is aborted, the script will be invoked with the final status of the transfer.

RETURN VALUE

On success globus_gass_copy_register_url_to_url returns 0. On error, this command will raise an error and must be caught using the appropriate bgerror command.

EXAMPLE

lassign [ globus_gass_copy_register_url_to_url $handle $source_url NULL $dest_url NULL { callback_script user_arg } ] result

BUGS

None

TODO

None

SEE ALSO

globus_gass_copy_register_url_to_handle, globus_gass_copy_register_handle_to_url


[Functions] globus_gass_copy/globus_gass_copy_set_buffer_length

[top][index]

NAME

globus_gass_copy_set_buffer_length

SYNOPSIS

package require globus_gass_copy

globus_gass_copy_set_buffer_length handle length

DESCRIPTION

This command is used to set the size of the buffer to be used for doing transfers.

This command allows the user to set the size of the buffer that will be used for doing transfers, if this command is not called the buffer size will default to 1M.

RETURN VALUE

On success, globus_gass_copy_set_buffer_length returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gass_copy_set_buffer_length $handle 4096 ] result

BUGS

None

TODO

None

SEE ALSO

globus_gass_copy_handle_init, globus_gass_copy_handle_destroy, globus_gass_copy_get_buffer_length


[Functions] globus_gass_copy/globus_gass_copy_set_no_third_party_transfers

[top][index]

NAME

globus_gass_copy_set_no_third_party_transfers

SYNOPSIS

package require globus_gass_copy

globus_gass_copy_set_no_third_party_transfers handle no_third_party_transfers

DESCRIPTION

This command is used to turn third-party transfers on or off. (They are on by default.)

This command allows the user to turn third-party transfers on or off for ftp to ftp transfers associated with a particular handle. This is often desired if one of the servers involved in the transfer does not allow third-party transfers.

RETURN VALUE

On success, globus_gass_copy_set_no_third_party_transfers returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gass_copy_set_no_third_party_transfers $handle $GLOBUS_FALSE ] result

BUGS

None

TODO

None

SEE ALSO

globus_gass_copy_handle_init, globus_gass_copy_handle_destroy, globus_gass_copy_get_no_third_party_transfers


[Functions] globus_gass_copy/globus_gass_copy_set_partial_offsets

[top][index]

NAME

globus_gass_copy_set_partial_offsets

SYNOPSIS

package require globus_gass_copy

globus_gass_copy_set_partial_offsets handle start_offset end_offset

DESCRIPTION

This command is used to set the offsets to be used for doing partial transfers.

This command allows the user to set the offsets that will be used for doing partial transfers. An offset of -1 will disable partial transfers. An end_offset of -1 means EOF.

RETURN VALUE

On success, globus_gass_copy_set_partial_offsets returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gass_copy_set_partial_offsets $handle 512 1024 ] result

BUGS

None

TODO

None

SEE ALSO

globus_gass_copy_handle_init, globus_gass_copy_handle_destroy, globus_gass_copy_get_partial_offsets


[Functions] globus_gass_copy/globus_gass_copy_set_user_pointer

[top][index]

NAME

globus_gass_copy_set_user_pointer

SYNOPSIS

package require globus_gass_copy

globus_gass_copy_set_user_pointer handle user_pointer

DESCRIPTION

This command is used to set a pointer in the handle to point at user-allocated memory.

RETURN VALUE

On success globus_gass_copy_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_gass_copy_set_user_pointer $handle $user_pointer ] result

BUGS

None

TODO

None

SEE ALSO

globus_gass_copy_get_user_pointer


[Functions] globus_gass_copy/globus_gass_copy_url_to_handle

[top][index]

NAME

globus_gass_copy_url_to_handle

SYNOPSIS

package require globus_gass_copy

globus_gass_copy_url_to_handle handle source_url source_attr dest_handle

DESCRIPTION

This command is used to transfer data from source URL to an I/O handle in blocking mode.

RETURN VALUE

On success globus_gass_copy_url_to_handle returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gass_copy_url_to_handle $handle $source_url NULL $dest_io_handle ] result

BUGS

None

TODO

None

SEE ALSO

globus_gass_copy_url_to_url, globus_gass_copy_handle_to_url


[Functions] globus_gass_copy/globus_gass_copy_url_to_url

[top][index]

NAME

globus_gass_copy_url_to_url

SYNOPSIS

package require globus_gass_copy

globus_gass_copy_url_to_url handle source_url source_attr dest_url dest_attr

DESCRIPTION

This command is used to transfer data from source URL to destination URL in blocking mode.

RETURN VALUE

On success globus_gass_copy_url_to_url returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gass_copy_url_to_url $handle $source_url NULL $dest_url NULL ] result

BUGS

None

TODO

None

SEE ALSO

globus_gass_copy_url_to_handle, globus_gass_copy_handle_to_url