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

TABLE OF CONTENTS


[Functions] globus_ftp_control/globus_ftp_control_abort

[top][index]

NAME

globus_ftp_control_abort

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_abort handle script

DESCRIPTION

This command is used to send the ABORT message to the FTP server. The ABORT message is sent out-of-band, and terminates any current data transfer in progress.

As a result of the ABORT, the data channels used by this control channel will be closed. The data command callback will be issued with either a completion reply, or a transfer aborted reply. The ABORT callback will also be invoked, with the server's response to the abort command.

Any attempts to register buffers for read or write after an ABORT has been sent will fail with a "no transfer in progress" error.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_abort $handle { response_cb NULL } ] result

BUGS

None

TODO

None


[Functions] globus_ftp_control/globus_ftp_control_auth_info_compare

[top][index]

NAME

globus_ftp_control_auth_info_compare

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_auth_info_compare auth_info_1 auth_info_2

DESCRIPTION

This command is used to compare two authentication information structures and return zero if the two structures are deemed equal and a non-zero value otherwise.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_auth_info_compare $auth_info_1 $auth_info_2 ] result

BUGS

None

TODO

None


[Functions] globus_ftp_control/globus_ftp_control_auth_info_init

[top][index]

NAME

globus_ftp_control_auth_info_init

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_auth_info_init credential_handle encrypt user password account subject

DESCRIPTION

This command is used to initialize a authentication information structure with the values contained in the first to fourth arguments, which may be GLOBUS_NULL. No memory is allocated in this function.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_auth_info_init $gss_c_no_credential $GLOBUS_TRUE ":globus-mapping:" NULL "/DC=org/DC=doegrids/OU=Services/CN=tclproxy.ligo.caltech.edu" ] result auth_info

BUGS

None

TODO

None

SEE ALSO

globus_ftp_control_authenticate


[Functions] globus_ftp_control/globus_ftp_control_authenticate

[top][index]

NAME

globus_ftp_control_authenticate

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_authenticate handle auth_info use_auth script

DESCRIPTION

This command is used to perform the authentication handshake with the FTP server. Depending on which parameters are non-NULL, the authentication may involve GSSAPI credentials, a username, a password, and an account name.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_authenticate $handle $auth_info $GLOBUS_TRUE { auth_response_cb NULL } ] result

BUGS

None

TODO

None

SEE ALSO

globus_ftp_control_auth_info_init


[Functions] globus_ftp_control/globus_ftp_control_command_copy

[top][index]

NAME

globus_ftp_control_command_copy

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_command_copy dest_command src_command

DESCRIPTION

This command is used to create a copy of a command structure.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_command_copy $dest_command $src_command ] result

BUGS

None

TODO

None

SEE ALSO

globus_ftp_control_command_init, globus_ftp_control_command_destroy.


[Functions] globus_ftp_control/globus_ftp_control_command_destroy

[top][index]

NAME

globus_ftp_control_command_destroy

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_command_destroy command

DESCRIPTION

This command is used to free up the memory allocated to the command argument.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_command_destroy $command ] result

BUGS

None

TODO

None

SEE ALSO

globus_ftp_control_command_init, globus_ftp_control_command_copy.


[Functions] globus_ftp_control/globus_ftp_control_command_init

[top][index]

NAME

globus_ftp_control_command_init

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_command_init command raw_command auth_info

DESCRIPTION

This command is used to initialize a command structure based on a null terminated string representing one line of input from the client. The command structure is used as a convience to determine what command the client issued. This function parses a command string sent by a client and populates the command argument appropriatly. In the GSSAPI case it will also decode and unwrap the command before parsing it.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_command_init $command $raw_command $auth_info ] result

BUGS

None

TODO

None

SEE ALSO

globus_ftp_control_command_destroy, globus_ftp_control_command_copy.


[Functions] globus_ftp_control/globus_ftp_control_connect

[top][index]

NAME

globus_ftp_control_connect

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_connect handle host port script

DESCRIPTION

This command is used to initiate an FTP control connection. It creates the socket to the FTP server. When the connection is made to the server, and the server's identification string is received, the script will be invoked.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_connect $handle $host $port { connect_response_cb NULL } ] result

BUGS

None

TODO

None


[Functions] globus_ftp_control/globus_ftp_control_create_data_info

[top][index]

NAME

globus_ftp_control_create_data_info

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_create_data_info handle buffer length offset eof script

DESCRIPTION

This command is used to create a globus_ftp_control_data_write_info_t structure.

This command populates a globus_ftp_control_data_callback_t structure with valid information. This structure provides the user a way to register several data writes with a single callback. This is quite useful to the writter of enqueue functions. It allows a single call to globus_ftp_control_data_write to be broken up into many writes, potentially on different stripes, and for a single callback to be called when all are finished.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_create_data_info $handle $buffer $length $offset $eof { create_data_info_cb NULL } ] result

BUGS

None

TODO

None


[Functions] globus_ftp_control/globus_ftp_control_data_add_channels

[top][index]

NAME

globus_ftp_control_data_add_channels

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_data_add_channels handle num_channels stripe_ndx

DESCRIPTION

This command is used to open additional data channels (connections) to the host identified by the stripe parameter.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_data_add_channels $handle $num_channels $stripe_ndx ] result

BUGS

None

TODO

None


[Functions] globus_ftp_control/globus_ftp_control_data_connect_read

[top][index]

NAME

globus_ftp_control_data_connect_read

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_data_connect_read handle script

DESCRIPTION

This command is used to create an incoming FTP data connection.

This command will register a globus_io_{accept, connect}. Further accepts/connects are done by registering a new accept/connect in the current accept/connect callback. A call to either globus_ftp_control_local_pasv() or globus_ftp_control_local_port() needs to precede this calling this command. This command may be followed by a globus_ftp_data_read.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_data_connect_read $handle { connect_read_data_cb NULL } ] result

BUGS

None

TODO

None

SEE ALSO

globus_ftp_control_data_connect_write


[Functions] globus_ftp_control/globus_ftp_control_data_connect_write

[top][index]

NAME

globus_ftp_control_data_connect_write

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_data_connect_write handle script

DESCRIPTION

This command is used to create an outgoing FTP data connection.

This command will register a globus_io_{accept, connect}. Further accepts/connects are done by registering a new accept/connect in the current accept/connect callback. A call to either globus_ftp_control_local_pasv() or globus_ftp_control_local_port() needs to precede this calling this command. This command may be followed by a globus_ftp_data_read.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_data_connect_write $handle { connect_write_data_cb NULL } ] result

BUGS

None

TODO

None

SEE ALSO

globus_ftp_control_data_connect_read


[Functions] globus_ftp_control/globus_ftp_control_data_force_close

[top][index]

NAME

globus_ftp_control_data_force_close

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_data_force_close handle script

DESCRIPTION

This command is used to force an imediate close of all data connections.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_data_force_close $handle { close_cb NULL } ] result

BUGS

None

TODO

None


[Functions] globus_ftp_control/globus_ftp_control_data_get_remote_hosts

[top][index]

NAME

globus_ftp_control_data_get_remote_hosts

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_data_get_remote_hosts handle address

DESCRIPTION

This command is used to query the number of remote hosts.

PARAMETERS

RETURN VALUE

On success globus_ftp_control_data_get_remote_hosts returns 0 and the number of remote address. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_ftp_control_data_get_remote_hosts $handle $address ] result addr_count

BUGS

None

TODO

None


[Functions] globus_ftp_control/globus_ftp_control_data_get_total_data_channels

[top][index]

NAME

globus_ftp_control_data_get_total_data_channels

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_data_get_total_data_channels handle stripe_ndx

DESCRIPTION

This command is used to return the total number of data channels used so far in the current transfer on the given stripe.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_data_get_total_data_channels $handle $stripe_ndx ] result num_channels

BUGS

None

TODO

None


[Functions] globus_ftp_control/globus_ftp_control_data_query_channels

[top][index]

NAME

globus_ftp_control_data_query_channels

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_data_query_channels handle stripe_ndx

DESCRIPTION

This command is used to return the number of currently open channels for the host identified by the stripe parameter.

This number may be less then the level of parallelism specified in local_parallelism, due to the possibility that some channels have not yet connected.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_data_query_channels $handle $stripe_ndx ] result num_channels

BUGS

None

TODO

None


[Functions] globus_ftp_control/globus_ftp_control_data_read

[top][index]

NAME

globus_ftp_control_data_read

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_data_read handle buffer_length script

DESCRIPTION

This command is used to read data from data connection(s) and put them in the supplied buffer.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_data_read $handle $buffer_length { data_read_cb NULL } ] result

BUGS

None

TODO

None


[Functions] globus_ftp_control/globus_ftp_control_data_read_all

[top][index]

NAME

globus_ftp_control_data_read_all

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_data_read_all handle buffer_length script

DESCRIPTION

This command is used to read data from data connection(s) and put them in the supplied buffer.

PARAMETERS

RETURN VALUE

On success globus_ftp_control_data_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_control_data_read_all $handle $buffer_length { data_read_cb NULL } ] result

BUGS

None

TODO

None


[Functions] globus_ftp_control/globus_ftp_control_data_remove_channels

[top][index]

NAME

globus_ftp_control_data_remove_channels

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_data_remove_channels handle num_channels stripe_ndx

DESCRIPTION

This command is used to remove data channels (connections) to the host identified by the stripe parameter.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_data_remove_channels $handle $num_channels $stripe_ndx ] result

BUGS

None

TODO

None


[Functions] globus_ftp_control/globus_ftp_control_data_send_eof

[top][index]

NAME

globus_ftp_control_data_send_eof

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_data_send_eof handle count array_size eof_message script

DESCRIPTION

This command is used to send an EOF message to each stripe along an open data connection.

An EOF message must be sent to all receiving hosts in a transfer. The message contains the total number of data connections used by each stripe. Many stripes may be sending to a single receiver but only one eof message may be sent. The count parameter allows the user to pass in the total number of data connections used by all other hosts. The local values are added to the passed in values and then sent to the receiver.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_data_send_eof $handle [ list 1 2 ] 2 { data_send_eof_cb NULL } ] result

BUGS

None

TODO

None


[Functions] globus_ftp_control/globus_ftp_control_data_set_interface

[top][index]

NAME

globus_ftp_control_data_set_interface

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_data_set_interface handle interface_addr

DESCRIPTION

This command is used to create an outgoing FTP data connection.

This command sets the interface that will be used to send and receive information along the data channel.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_data_set_interface $handle "131.215.114.146" ] result

BUGS

None

TODO

None


[Functions] globus_ftp_control/globus_ftp_control_data_write

[top][index]

NAME

globus_ftp_control_data_write

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_data_write handle buffer offset eof script

DESCRIPTION

This command is used to write data from the supplied buffer to data connection(s).

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_connect $handle $buffer $offset $eof { data_write_cb NULL } ] result

BUGS

None

TODO

None


[Functions] globus_ftp_control/globus_ftp_control_data_write_stripe

[top][index]

NAME

globus_ftp_control_data_write_stripe

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_data_write_stripe handle buffer offset eof stripe_ndx script

DESCRIPTION

This command is used to write FTP data to a particular stripe.

This command allows the user to write to a specified stripe. The stripe index relates to the order passsed into local_spor(). This command differs from globus_ftp_control_data_write in that no enqueue function is needed since the user specifies the stripe on which data is written. In order to use this command the user must have a valid pointer to a globus_ftp_control_data_write_info_t structure. The data_info structure can be obtained by a call to globus_ftp_control_create_data_info. Many calls to this command can be made, but only a single user callback occurs per creation of a globus_ftp_control_data_write_info_t structure.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_data_write_stripe $handle $buffer $offset $eof $stripe_ndx { data_write_stripe_cb NULL } ] result

BUGS

None

TODO

None


[Functions] globus_ftp_control/globus_ftp_control_force_close

[top][index]

NAME

globus_ftp_control_force_close

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_force_close handle script

DESCRIPTION

This command is used to force a close of the control connection without waiting for outstanding commands to complete and without sending QUIT.

This command is used to close the control channel to the FTP server. Once the final response callback passed to this function is invoked, the control handle can no longer be used for any gsiftp control operations.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_force_close $handle { response_cb NULL } ] result

BUGS

None

TODO

None


[Functions] globus_ftp_control/globus_ftp_control_get_dcau

[top][index]

NAME

globus_ftp_control_get_dcau

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_get_dcau handle

DESCRIPTION

This command is used to query the FTP control handle with the data channel authentication information.

PARAMETERS

RETURN VALUE

On success globus_ftp_control_get_dcau returns 0 and the data channel authentication information. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_ftp_control_get_dcau $handle ] result dcau

BUGS

None

TODO

None

SEE ALSO

globus_ftp_control_local_dcau


[Functions] globus_ftp_control/globus_ftp_control_get_mode

[top][index]

NAME

globus_ftp_control_get_mode

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_get_mode handle

DESCRIPTION

This command is used to query the mode information from the FTP control handle.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_get_mode $handle ] result mode

BUGS

None

TODO

None

SEE ALSO

globus_ftp_control_local_mode


[Functions] globus_ftp_control/globus_ftp_control_get_parallelism

[top][index]

NAME

globus_ftp_control_get_parallelism

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_get_parallelism handle

DESCRIPTION

This command is used to query the parallelism information in a FTP control handle.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_get_parallelism $handle ] result parallelism

BUGS

None

TODO

None

SEE ALSO

globus_ftp_control_local_parallelism.


[Functions] globus_ftp_control/globus_ftp_control_get_pbsz

[top][index]

NAME

globus_ftp_control_get_pbsz

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_get_pbsz handle

DESCRIPTION

This command is used to query the FTP control handle for the protection buffer size information.

This command queries the handle to determine the protection buffer size which is used by this handle. This value is used to determine how much data will be sent in each packet during a protected data transfer.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_get_pbsz $handle ] result bufsize

BUGS

None

TODO

None


[Functions] globus_ftp_control/globus_ftp_control_get_prot

[top][index]

NAME

globus_ftp_control_get_prot

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_get_prot handle

DESCRIPTION

This command is used to query the FTP control handle with the protection information on the structure of the data being sent on the data channel.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_get_prot $handle ] result protection

BUGS

None

TODO

None

SEE ALSO

globus_ftp_control_local_prot


[Functions] globus_ftp_control/globus_ftp_control_get_spor

[top][index]

NAME

globus_ftp_control_get_spor

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_get_spor handle addresses

DESCRIPTION

This command is used to query the number of host/port addresses returned by a SPAS on the remote host into the local FTP control handle.

If there are any outstanding data connections at this point, they are closed.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_get_spor $handle $addresses ] result

BUGS

None

TODO

None

SEE ALSO

globus_ftp_control_local_spor


[Functions] globus_ftp_control/globus_ftp_control_get_stripe_count

[top][index]

NAME

globus_ftp_control_get_stripe_count

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_get_stripe_count handle

DESCRIPTION

This command is used to query stripe counts.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_get_stripe_count $handle ] result stripe_count

BUGS

None

TODO

None


[Functions] globus_ftp_control/globus_ftp_control_get_type

[top][index]

NAME

globus_ftp_control_get_type

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_get_type handle

DESCRIPTION

This command is used to query the type information from the FTP control handle.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_get_type $handle ] result type

BUGS

None

TODO

None

SEE ALSO

globus_ftp_control_local_type


[Functions] globus_ftp_control/globus_ftp_control_handle_destroy

[top][index]

NAME

globus_ftp_control_handle_destroy

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_handle_destroy handle

DESCRIPTION

This command is used to free up all dynamicly allocated memory associated with a given Globus FTP handle. It will also remove the handle from a list used by the module activation/deactivation functions. This command should only be called after a call to either globus_ftp_control_force_close or globus_ftp_control_quit.

PARAMETERS

RETURN VALUE

On success globus_ftp_control_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_control_handle_destroy $handle ] result

BUGS

None

TODO

None

SEE ALSO

globus_ftp_control_handle_init.


[Functions] globus_ftp_control/globus_ftp_control_handle_init

[top][index]

NAME

globus_ftp_control_handle_init

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_handle_init handle

DESCRIPTION

This command is used to set up (i.e. intialize all mutexes and variables) a Globus FTP handle. It will also enter the handle in a list used by the module activation/deactivation functions.

PARAMETERS

RETURN VALUE

On success globus_ftp_control_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_control_handle_init $handle ] result

BUGS

None

TODO

None

SEE ALSO

globus_ftp_control_handle_destroy.


[Functions] globus_ftp_control/globus_ftp_control_local_dcau

[top][index]

NAME

globus_ftp_control_local_dcau

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_local_dcau handle dcau delegated_credential_handle

DESCRIPTION

This command is used to update the FTP control handle with the given data channel authentication information.

If authentication is set to GLOBUS_FTP_CONTROL_DCAU_NONE, then protection will also be disabled for this control handle.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_local_dcau $handle $dcau $gss_c_no_credential ] result

BUGS

None

TODO

None

SEE ALSO

globus_ftp_control_get_dcau


[Functions] globus_ftp_control/globus_ftp_control_local_layout

[top][index]

NAME

globus_ftp_control_local_layout

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_local_layout handle layout data_size

DESCRIPTION

This command is used to update the FTP control handle with the layout and the size of the data sent over the data channel.

PARAMETERS

RETURN VALUE

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

EXAMPLE

set layout [ new_globus_ftp_control_layout_t ]

lassign [ globus_ftp_control_local_layout $handle $layout 1028 ] result

    

delete_globus_ftp_control_layout_t $layout

BUGS

None

TODO

None


[Functions] globus_ftp_control/globus_ftp_control_local_mode

[top][index]

NAME

globus_ftp_control_local_mode

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_local_mode handle mode

DESCRIPTION

This command is used to update the FTP control handle with the given mode information.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_local_mode $handle $GLOBUS_FTP_CONTROL_MODE_STREAM ] result

BUGS

None

TODO

None

SEE ALSO

globus_ftp_control_get_mode


[Functions] globus_ftp_control/globus_ftp_control_local_parallelism

[top][index]

NAME

globus_ftp_control_local_parallelism

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_local_parallelism handle parallelism

DESCRIPTION

This command is used to set the parallelism information in a FTP control handle.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_local_parallelism $handle $parallelism ] result

BUGS

None

TODO

None

SEE ALSO

globus_ftp_control_get_parallelism.


[Functions] globus_ftp_control/globus_ftp_control_local_pasv

[top][index]

NAME

globus_ftp_control_local_pasv

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_local_pasv handle address

DESCRIPTION

This command is used to create a local listening socket, bind it and return the address the socket is listening to.

If there is a existing data connection it is closed.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_local_pasv $handle $address ] result

BUGS

None

TODO

None


[Functions] globus_ftp_control/globus_ftp_control_local_pbsz

[top][index]

NAME

globus_ftp_control_local_pbsz

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_local_pbsz handle bufsize

DESCRIPTION

This command is used to update the FTP control handle with the given protection buffer size information.

This command sets protection buffer size to be used by this handle. This value is used to determine how much data will be sent in each packet during a protected data transfer.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_ftp_control_local_pbsz $handle 256 ] result

BUGS

None

TODO

None


[Functions] globus_ftp_control/globus_ftp_control_local_port

[top][index]

NAME

globus_ftp_control_local_port

SYNOPSIS

package require globus_ftp_control

globus_ftp_control_local_port handle address

DESCRIPTION

This command is used to insert the host/port information returned by a PASV on the remote host into the local FTP control handle.

If there is a existing data connection it is closed.

PARAMETERS