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

TABLE OF CONTENTS


[Functions] globus_io/globus_io_attr_get_file_type

[top][index]

NAME

globus_io_attr_get_file_type

SYNOPSIS

package require globus_io

globus_io_attr_get_file_type attr

DESCRIPTION

This command is used to query the file-type attribute in the specified attribute set.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_attr_get_file_type $attr ] result file-type

BUGS

None

TODO

None

SEE ALSO

globus_io_fileattr_init


[Functions] globus_io/globus_io_attr_get_secure_authentication_mode

[top][index]

NAME

globus_io_attr_get_secure_authentication_mode

SYNOPSIS

package require globus_io

globus_io_attr_get_secure_authentication_mode attr

DESCRIPTION

This command is used to query the authentication mode attribute in the specified socket attribute set.

PARAMETERS

RETURN VALUE

On success globus_io_attr_get_secure_authentication_mode returns 0 and the values of mode and credential attributes. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_io_attr_get_secure_authentication_mode $attr ] result mode credential

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init, globus_io_secure_authorization_mode_t


[Functions] globus_io/globus_io_attr_get_secure_authorization_mode

[top][index]

NAME

globus_io_attr_get_secure_authorization_mode

SYNOPSIS

package require globus_io

globus_io_attr_get_secure_authorization_mode attr

DESCRIPTION

This command is used to query the authorization mode attribute in the specified socket attribute set.

PARAMETERS

RETURN VALUE

On success globus_io_attr_get_secure_authorization_mode returns 0 and the values of mode and data attributes. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_io_attr_get_secure_authorization_mode $attr ] result mode data

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init, globus_io_secure_authorization_mode_t


[Functions] globus_io/globus_io_attr_get_secure_channel_mode

[top][index]

NAME

globus_io_attr_get_secure_channel_mode

SYNOPSIS

package require globus_io

globus_io_attr_get_secure_channel_mode attr

DESCRIPTION

This command is used to get the channel mode attribute in the specified socket attribute set.

This attribute is used to determine if any data wrapping should be done on the socket connection. This is required to use the data protection attribute.

PARAMETERS

RETURN VALUE

On success globus_io_attr_get_secure_channel_mode returns 0 and the value of the channel-mode attribute. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_io_attr_get_secure_channel_mode $attr ] result channel-mode

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init, globus_io_secure_channel_mode_t


[Functions] globus_io/globus_io_attr_get_secure_delegation_mode

[top][index]

NAME

globus_io_attr_get_secure_delegation_mode

SYNOPSIS

package require globus_io

globus_io_attr_get_secure_delegation_mode attr

DESCRIPTION

This command is used to get the delegation mode attribute in the specified socket attribute set.

This attribute is used to determine if any data delegation should be done on the socket connection.

PARAMETERS

RETURN VALUE

On success globus_io_attr_get_secure_delegation_mode returns 0 and the value of the delegation-mode attribute. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_io_attr_get_secure_delegation_mode $attr ] result delegation-mode

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init, globus_io_secure_delegation_mode_t


[Functions] globus_io/globus_io_attr_get_secure_extension_oids

[top][index]

NAME

globus_io_attr_get_secure_extension_oids

SYNOPSIS

package require globus_io

globus_io_attr_get_secure_extension_oids attr

DESCRIPTION

This command is used to query the extension_oids attribute in the specified attribute set.

PARAMETERS

RETURN VALUE

On success globus_io_attr_get_secure_extension_oids returns 0 and the value of the extension_oids attribute. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

TBD

BUGS

None

TODO

None


[Functions] globus_io/globus_io_attr_get_secure_protection_mode

[top][index]

NAME

globus_io_attr_get_secure_protection_mode

SYNOPSIS

package require globus_io

globus_io_attr_get_secure_protection_mode attr

DESCRIPTION

This command is used to get the protection mode attribute in the specified socket attribute set.

This attribute is used to determine if any data protection should be done on the socket connection.

PARAMETERS

RETURN VALUE

On success globus_io_attr_get_secure_protection_mode returns 0 and the value of the protection-mode attribute. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_io_attr_get_secure_protection_mode $attr ] result protection-mode

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init, globus_io_secure_protection_mode_t


[Functions] globus_io/globus_io_attr_get_secure_proxy_mode

[top][index]

NAME

globus_io_attr_get_secure_proxy_mode

SYNOPSIS

package require globus_io

globus_io_attr_get_secure_proxy_mode attr

DESCRIPTION

This command is used to get the proxy mode attribute in the specified socket attribute set.

This attribute is used to determine if any data proxy should be done on the socket connection.

PARAMETERS

RETURN VALUE

On success globus_io_attr_get_secure_proxy_mode returns 0 and the value of the proxy-mode attribute. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_io_attr_get_secure_proxy_mode $attr ] result proxy-mode

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init, globus_io_secure_proxy_mode_t


[Functions] globus_io/globus_io_attr_get_socket_keepalive

[top][index]

NAME

globus_io_attr_get_socket_keepalive

SYNOPSIS

package require globus_io

globus_io_attr_get_socket_keepalive attr

DESCRIPTION

This command is used to query the keepalive attribute in the specified attribute set.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_attr_get_socket_keepalive $attr ] result keepalive

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init, globus_io_tcpattr_destroy


[Functions] globus_io/globus_io_attr_get_socket_linger

[top][index]

NAME

globus_io_attr_get_socket_linger

SYNOPSIS

package require globus_io

globus_io_attr_get_socket_linger attr

DESCRIPTION

This command is used to query the linger attribute in the specified attribute set.

PARAMETERS

RETURN VALUE

On success globus_io_attr_get_socket_linger returns 0, the value of the linger attribute and the time (in seconds) to block at close time if linger is true and data is queued in the socket buffer. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_io_attr_get_socket_linger $attr ] result linger linger_time

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init


[Functions] globus_io/globus_io_attr_get_socket_oobinline

[top][index]

NAME

globus_io_attr_get_socket_oobinline

SYNOPSIS

package require globus_io

globus_io_attr_get_socket_oobinline attr

DESCRIPTION

This command is used to query the oobinline attribute in the specified attribute set.

PARAMETERS

RETURN VALUE

On success globus_io_attr_get_socket_oobinline returns 0 and the value of the oobinline attribute. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_io_attr_get_socket_oobinline $attr ] result oobinline

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init


[Functions] globus_io/globus_io_attr_get_socket_rcvbuf

[top][index]

NAME

globus_io_attr_get_socket_rcvbuf

SYNOPSIS

package require globus_io

globus_io_attr_get_socket_rcvbuf attr

DESCRIPTION

This command is used to query the rcvbuf attribute in the specified attribute set.

PARAMETERS

RETURN VALUE

On success globus_io_attr_get_socket_rcvbuf returns 0 and the value of the rcvbuf attribute. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_io_attr_get_socket_rcvbuf $attr ] result rcvbuf

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init


[Functions] globus_io/globus_io_attr_get_socket_reuseaddr

[top][index]

NAME

globus_io_attr_get_socket_reuseaddr

SYNOPSIS

package require globus_io

globus_io_attr_get_socket_reuseaddr attr

DESCRIPTION

This command is used to query the reuseaddr attribute in the specified attribute set.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_attr_get_socket_reuseaddr $attr ] result reuseaddr

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init, globus_io_tcpattr_destroy


[Functions] globus_io/globus_io_attr_get_socket_sndbuf

[top][index]

NAME

globus_io_attr_get_socket_sndbuf

SYNOPSIS

package require globus_io

globus_io_attr_get_socket_sndbuf attr

DESCRIPTION

This command is used to query the sndbuf attribute in the specified attribute set.

PARAMETERS

RETURN VALUE

On success globus_io_attr_get_socket_sndbuf returns 0 and the value of the sndbuf attribute. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_io_attr_get_socket_sndbuf $attr ] result sndbuf

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init


[Functions] globus_io/globus_io_attr_get_tcp_interface

[top][index]

NAME

globus_io_attr_get_tcp_interface

SYNOPSIS

package require globus_io

globus_io_attr_get_tcp_interface attr

DESCRIPTION

This command is used to query the TCP interface attribute in the specified TCP attribute set.

PARAMETERS

RETURN VALUE

On success globus_io_attr_get_tcp_interface returns 0 and the value of the interface attribute. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_io_attr_get_tcp_interface $attr ] result interface

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init


[Functions] globus_io/globus_io_attr_get_tcp_nodelay

[top][index]

NAME

globus_io_attr_get_tcp_nodelay

SYNOPSIS

package require globus_io

globus_io_attr_get_tcp_nodelay attr

DESCRIPTION

This command is used to query the nodelay attribute in the specified attribute set.

PARAMETERS

RETURN VALUE

On success globus_io_attr_get_tcp_nodelay returns 0 and the value of the nodelay attribute. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_io_attr_get_tcp_nodelay $attr ] result nodelay

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init


[Functions] globus_io/globus_io_attr_get_tcp_restrict_port

[top][index]

NAME

globus_io_attr_get_tcp_restrict_port

SYNOPSIS

package require globus_io

globus_io_attr_get_tcp_restrict_port attr

DESCRIPTION

This command is used to query the restrict-port attribute in the specified TCP attribute set.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_attr_get_tcp_restrict_port $attr ] result restrict_port

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init, globus_io_tcpattr_destroy


[Functions] globus_io/globus_io_attr_set_file_type

[top][index]

NAME

globus_io_attr_set_file_type

SYNOPSIS

package require globus_io

globus_io_attr_set_file_type attr file_type

DESCRIPTION

This command is used to set the file type attribute in the specified attribute set. This attribute is used to choose whether the file is opened in text or binary mode on systems where those are different. This attribute may not be applied to an existing file handle.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_attr_set_file_type $attr $file_type ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_fileattr_init


[Functions] globus_io/globus_io_attr_set_secure_authentication_mode

[top][index]

NAME

globus_io_attr_set_secure_authentication_mode

SYNOPSIS

package require globus_io

globus_io_attr_set_secure_authentication_mode attr mode credential

DESCRIPTION

This command is used to set the authentication mode attribute in the specified socket attribute set.

This attribute is used to determine whether or not to call the GSSAPI security context establishment functions once a socket connection is established.

If the authentication_mode value is GLOBUS_IO_SECURE_AUTHENTICATION_MODE_NONE, then the channel mode, delegation mode, protection mode, and authorization mode will all be reset to disable all security on the socket attribute set.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_attr_set_secure_authentication_mode $attr $GLOBUS_IO_SECURE_AUTHENTICATION_MODE_GSSAPI $gss_c_no_credential ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init, globus_io_secure_authorization_mode_t


[Functions] globus_io/globus_io_attr_set_secure_authorization_mode

[top][index]

NAME

globus_io_attr_set_secure_authorization_mode

SYNOPSIS

package require globus_io

globus_io_attr_set_secure_authorization_mode attr mode data

DESCRIPTION

This command is used to set the authorization-mode attribute in the specified socket attribute set.

This attribute is used to determine what security identities to authorize as the peer to the security handshake done when making an authenticated connection.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_attr_set_secure_authorization_mode $attr $GLOBUS_IO_SECURE_AUTHORIZATION_MODE_SELF $auth_data ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init, globus_io_secure_authorization_mode_t


[Functions] globus_io/globus_io_attr_set_secure_channel_mode

[top][index]

NAME

globus_io_attr_set_secure_channel_mode

SYNOPSIS

package require globus_io

globus_io_attr_set_secure_channel_mode attr mode

DESCRIPTION

This command is used to set the channel mode attribute in the specified socket attribute set.

This attribute is used to determine if any data wrapping should be done on the socket connection. This is required to use the data protection attribute.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_attr_set_secure_channel_mode $attr $GLOBUS_IO_SECURE_CHANNEL_MODE_GSI_WRAP ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init, globus_io_secure_channel_mode_t


[Functions] globus_io/globus_io_attr_set_secure_delegation_mode

[top][index]

NAME

globus_io_attr_set_secure_delegation_mode

SYNOPSIS

package require globus_io

globus_io_attr_set_secure_delegation_mode attr delegation-mode

DESCRIPTION

This command is used to set the delegation mode attribute in the specified socket attribute set.

This attribute is used to determine whether the process's credentials should be delegated to the other side of the connection.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_attr_set_secure_delegation_mode $attr $GLOBUS_IO_SECURE_DELEGATION_MODE_NONE ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init, globus_io_secure_delegation_mode_t


[Functions] globus_io/globus_io_attr_set_secure_extension_oids

[top][index]

NAME

globus_io_attr_set_secure_extension_oids

SYNOPSIS

package require globus_io

globus_io_attr_set_secure_extension_oids attr extension_oids

DESCRIPTION

This command is used to set the extension OID (Object Identifiers) attribute in the specified attribute set.

PARAMETERS

RETURN VALUE

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

EXAMPLE

TBD

BUGS

None

TODO

None


[Functions] globus_io/globus_io_attr_set_secure_protection_mode

[top][index]

NAME

globus_io_attr_set_secure_protection_mode

SYNOPSIS

package require globus_io

globus_io_attr_set_secure_protection_mode attr protection-mode

DESCRIPTION

This command is used to set the protection mode attribute in the specified socket attribute set.

This attribute is used to determine if any data protection should be done on the socket connection.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_attr_set_secure_protection_mode $attr $GLOBUS_IO_SECURE_PROTECTION_MODE_PRIVATE ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init, globus_io_secure_protection_mode_t


[Functions] globus_io/globus_io_attr_set_secure_proxy_mode

[top][index]

NAME

globus_io_attr_set_secure_proxy_mode

SYNOPSIS

package require globus_io

globus_io_attr_set_secure_proxy_mode attr proxy-mode

DESCRIPTION

This command is used to set the proxy mode attribute in the specified socket attribute set.

This attribute is used to determine whether the process should accept limited proxy certificates for authentication.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_attr_set_secure_proxy_mode $attr $GLOBUS_IO_SECURE_PROXY_MODE_LIMITED ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init, globus_io_secure_proxy_mode_t


[Functions] globus_io/globus_io_attr_set_socket_keepalive

[top][index]

NAME

globus_io_attr_set_socket_keepalive

SYNOPSIS

package require globus_io

globus_io_attr_set_socket_keepalive attr keepalive

DESCRIPTION

This command is used to set the keepalive attribute in the specified attribute set. This attribute is used to determine whether or not to periodically send "keepalive" messages on a connected socket handle. This may enable earlier detection of broken connections.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_attr_set_socket_keepalive $attr 1 ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init, globus_io_tcpattr_destroy


[Functions] globus_io/globus_io_attr_set_socket_linger

[top][index]

NAME

globus_io_attr_set_socket_linger

SYNOPSIS

package require globus_io

globus_io_attr_set_socket_linger attr linger linger_time

DESCRIPTION

This command is used to set the linger attribute in the specified attribute set. This attribute is used to determine what to do when data is in the socket's buffer when the socket is closed. If linger is set to true, then the close operation will block until the socket buffers are empty, or the linger_time has expired.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_attr_set_socket_linger $attr 1 60 ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init


[Functions] globus_io/globus_io_attr_set_socket_oobinline

[top][index]

NAME

globus_io_attr_set_socket_oobinline

SYNOPSIS

package require globus_io

globus_io_attr_set_socket_oobinline attr oobinline

DESCRIPTION

This command is used to set the oobinline attribute in the specified attribute set. This attribute is used to choose whether out-of-band data is received in the normal data queue, or must be received specially by calling globus_io_recv or globus_io_register_recv with the MSG_OOB flag set to true.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_attr_set_socket_oobinline $attr true ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init


[Functions] globus_io/globus_io_attr_set_socket_rcvbuf

[top][index]

NAME

globus_io_attr_set_socket_rcvbuf

SYNOPSIS

package require globus_io

globus_io_attr_set_socket_rcvbuf attr rcvbuf

DESCRIPTION

This command is used to set the rcvbuf attribute in the specified attribute set. This attribute is used to choose the size of the send buffer for the socket handle this attribute is applied to. The send buffer is often used by the operating system to choose the appropriate TCP window size.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_attr_set_socket_rcvbuf $attr 2048 ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init


[Functions] globus_io/globus_io_attr_set_socket_reuseaddr

[top][index]

NAME

globus_io_attr_set_socket_reuseaddr

SYNOPSIS

package require globus_io

globus_io_attr_set_socket_reuseaddr attr reuseaddr

DESCRIPTION

This command is used to set the reuse-addr attribute in the specified attribute set.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_attr_set_socket_reuseaddr $attr 1 ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init, globus_io_tcpattr_destroy


[Functions] globus_io/globus_io_attr_set_socket_sndbuf

[top][index]

NAME

globus_io_attr_set_socket_sndbuf

SYNOPSIS

package require globus_io

globus_io_attr_set_socket_sndbuf attr sndbuf

DESCRIPTION

This command is used to set the sndbuf attribute in the specified attribute set. This attribute is used to choose the size of the send buffer for the socket handle this attribute is applied to. The send buffer is often used by the operating system to choose the appropriate TCP window size.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_attr_set_socket_sndbuf $attr 2048 ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init


[Functions] globus_io/globus_io_attr_set_tcp_interface

[top][index]

NAME

globus_io_attr_set_tcp_interface

SYNOPSIS

package require globus_io

globus_io_attr_set_tcp_interface attr interface

DESCRIPTION

This command is used to set the TCP interface attribute in the specified TCP attribute set. This attribute is used to determine whether to bind TCP sockets to a particular interface. This attribute must be set before calling globus_io_tcp_create_listener or globus_io_tcp_connect.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_attr_set_tcp_interface $attr 127.0.0.1 ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init


[Functions] globus_io/globus_io_attr_set_tcp_nodelay

[top][index]

NAME

globus_io_attr_set_tcp_nodelay

SYNOPSIS

package require globus_io

globus_io_attr_set_tcp_nodelay attr nodelay

DESCRIPTION

This command is used to set the nodelay attribute in the specified TCP attribute set. This attribute is used to determine whether or not to disable Nagle's algorithm. If set to true, the socket will send packets as soon as possible with no unnecessary delays introduced.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_attr_set_tcp_nodelay $attr true ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init


[Functions] globus_io/globus_io_attr_set_tcp_restrict_port

[top][index]

NAME

globus_io_attr_set_tcp_restrict_port

SYNOPSIS

package require globus_io

globus_io_attr_set_tcp_restrict_port attr restrict_port

DESCRIPTION

This command is used to set the restrict-port attribute in the specified TCP attribute set.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_attr_set_tcp_restrict_port $attr 1 ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init, globus_io_tcpattr_destroy


[Functions] globus_io/globus_io_cancel

[top][index]

NAME

globus_io_cancel

SYNOPSIS

package require globus_io

globus_io_cancel handle perform_callbacks

DESCRIPTION

This command is used to cancel any outstanding operation registered with the specified handle. This is a blocking form of globus_io_register_cancel(). This function blocks until the cancellation is completely processed.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_cancel $handle true ] result

BUGS

Cancel may succeed without cancelling anything, or causing any callbacks to be invoked. There currently is no way to cancel specific registered callbacks without cancelling every registered operation.

TODO

None

SEE ALSO

globus_io_register_cancel, globus_io_register_close, globus_io_close.


[Functions] globus_io/globus_io_close

[top][index]

NAME

globus_io_close

SYNOPSIS

package require globus_io

globus_io_close handle

DESCRIPTION

This command is used to close the file or connection associated with a handle. No further operations may be done on this handle. Any outstanding requests on this handle will be cancelled (globus_io_cancel will be called with perform_callbacks set to true). This may be called for any handle type. This function blocks until any cancelled callbacks have been dispatched and have either reached their thread conversion point or completed.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_close $handle ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_register_close, globus_io_register_cancel, globus_io_cancel.


[Types] globus_io/globus_io_file_create_mode_t

[top][index]

NAME

globus_io_file_create_mode_t

DESCRIPTION

Open mode to pass to the globus_io_file_open() call.

ATTRIBUTES


[Types] globus_io/globus_io_file_flag_t

[top][index]

NAME

globus_io_file_flag_t

DESCRIPTION

Flags to pass to the globus_io_file_open call.

ATTRIBUTES


[Functions] globus_io/globus_io_file_open

[top][index]

NAME

globus_io_file_open

SYNOPSIS

package require globus_io

globus_io_file_open path flags mode attr handle

DESCRIPTION

This command is used to initialize a Globus I/O handle by opening a file.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_open $path $flags $mode $attr $handle ] result

BUGS

None

TODO

None


[Functions] globus_io/globus_io_file_seek

[top][index]

NAME

globus_io_file_seek

SYNOPSIS

package require globus_io

globus_io_file_seek handle offset whence

DESCRIPTION

This command is used to seek to a new position on an open file.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_file_seek $handle $offset $whence ] result

BUGS

None

TODO

None


[Types] globus_io/globus_io_file_type_t

[top][index]

NAME

globus_io_file_type_t

DESCRIPTION

Values for the Globus I/O file_type file attribute.

ATTRIBUTES


[Functions] globus_io/globus_io_fileattr_destroy

[top][index]

NAME

globus_io_fileattr_destroy

SYNOPSIS

package require globus_io

globus_io_fileattr_destroy attr

DESCRIPTION

This command is used to destroy a previously allocated file attribute structure.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_fileattr_destroy $attr ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_fileattr_init


[Functions] globus_io/globus_io_fileattr_init

[top][index]

NAME

globus_io_fileattr_init

SYNOPSIS

package require globus_io

globus_io_fileattr_init attr

DESCRIPTION

This command is used to initialize a file attribute structure.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_fileattr_init $attr ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_fileattr_destroy


[Functions] globus_io/globus_io_get_handle_type

[top][index]

NAME

globus_io_get_handle_type

SYNOPSIS

package require globus_io

globus_io_get_handle_type handle

DESCRIPTION

This command is used to return the type of the handle. The type will be one of those enumerated in globus_io_handle_type_t. Globus I/O functions do not support all operations on all handle types. This may be called for any handle type.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_get_handle_type $handle ] handle_type

BUGS

None

TODO

None

SEE ALSO

globus_io_file_open, globus_io_tcp_connect, globus_io_tcp_accept, globus_io_tcp_create_listener, globus_io_tcp_listen


[Functions] globus_io/globus_io_handle_get_user_pointer

[top][index]

NAME

globus_io_handle_get_user_pointer

SYNOPSIS

package require globus_io

globus_io_handle_get_user_pointer handle

DESCRIPTION

This command is used to return the user-specified pointer in the handle structure. This may be called for any handle type.

PARAMETERS

RETURN VALUE

On success globus_io_handle_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_io_handle_get_user_pointer $handle ] result user-pointer

BUGS

None

TODO

None


[Functions] globus_io/globus_io_handle_set_user_pointer

[top][index]

NAME

globus_io_handle_set_user_pointer

SYNOPSIS

package require globus_io

globus_io_handle_set_user_pointer handle

DESCRIPTION

This command is used to set the user-specified pointer in the handle structure to user_pointer. This may be called for any handle type.

PARAMETERS

RETURN VALUE

On success globus_io_handle_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_io_handle_set_user_pointer $handle $user-pointer] result

BUGS

None

TODO

None


[Types] globus_io/globus_io_handle_type_t

[top][index]

NAME

globus_io_handle_type_t

DESCRIPTION

A file or socket handle.

Globus I/O uses the abstraction of a handle to act as a common data type for multiple I/O media. Currently, Globus I/O provides interfaces to the BSD socket library and the POSIX file I/O library using handles instead of file descriptors or win32 file or HANDLE objects.

A handle is created by calling one of the following functions: globus_io_file_open, globus_io_tcp_create_listener, globus_io_tcp_accept, globus_io_tcp_register_accept, or globus_io_tcp_connect.

Attributes may be bound to a handle at creation time. These provide an interface to socket options, file access options, and security.

ATTRIBUTES


[Functions] globus_io/globus_io_read

[top][index]

NAME

globus_io_read

SYNOPSIS

package require globus_io

globus_io_read handle buffer_length waitforbytes

DESCRIPTION

This command is used to script the reading of a block of data from a handle in a blocking mode.

PARAMETERS

RETURN VALUE

On success globus_io_read returns 0 and a block of data. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_io_read $handle $buffer_length $waitforbytes ] status buffer

BUGS

None

TODO

None

SEE ALSO

globus_io_try_read, globus_io_register_read


[Functions] globus_io/globus_io_register_cancel

[top][index]

NAME

globus_io_register_cancel

SYNOPSIS

package require globus_io

globus_io_register_cancel handle perform_callbacks script

DESCRIPTION

This command is used to cancel any outstanding operation registered with the specified handle. If perform_callbacks is set to TRUE, then any callbacks associated with the registered operation will be called with the result argument indicating that the operation was cancelled. Additionally, the callback function will be called, with arg set to the value of callback_arg, once all outstanding callbacks have been invoked and either completed or reached their conversion point.

If perform_callbacks is not set to TRUE, callbacks will not be performed and callback and callback_arg arg ignored. This may be called for any handle type.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_register_cancel $handle TRUE [ subst { callback callback_arg } ] ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_cancel, globus_io_close, globus_io_register_close


[Functions] globus_io/globus_io_register_close

[top][index]

NAME

globus_io_register_close

SYNOPSIS

package require globus_io

globus_io_register_close handle callback_script

DESCRIPTION

This command is used to asynchronously close the file or connection described by handle. As soon as the operation completes, the callback script is called.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_register_close $handle [ subst { callback callback_arg } ] ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_register_cancel, globus_io_cancel, globus_io_close


[Functions] globus_io/globus_io_register_read

[top][index]

NAME

globus_io_register_read

SYNOPSIS

package require globus_io

globus_io_register_read handle buffer_length waitforbytes script

DESCRIPTION

This command is used to script the reading of a block of data in the background.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_register_read $handle $buffer_length $waitforbytes [ subst { callback callback_arg } ] ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_read, globus_io_try_read


[Functions] globus_io/globus_io_register_send

[top][index]

NAME

globus_io_register_send

SYNOPSIS

package require globus_io

globus_io_register_send handle buffer flags script

DESCRIPTION

This command is used to script the sending of a block of data on the handle in the background.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_register_send $handle $buffer $flags [ subst { callback $callback_arg } ] ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_write, globus_io_try_write


[Functions] globus_io/globus_io_register_write

[top][index]

NAME

globus_io_register_write

SYNOPSIS

package require globus_io

globus_io_register_write handle buffer script

DESCRIPTION

This command is used to script the writing of a block of data on the handle in the background.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_register_write $handle $buffer [ subst { callback $callback_arg } ] ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_write, globus_io_try_write


[Functions] globus_io/globus_io_register_writev

[top][index]

NAME

globus_io_register_writev

SYNOPSIS

package require globus_io

globus_io_register_writev handle list_of_buffer waitforbytes data_descriptor callback_script

DESCRIPTION

This command is used to script the writing of a block of data to multiple non-contiguous data buffers at once in the background.

PARAMETERS

EXAMPLE

lassign [ globus_io_register_writev $handle [list $buffer1 $buffer2] [ subst { callback $callback_arg } ] ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_writev


[Types] globus_io/globus_io_secure_authentication_mode_t

[top][index]

NAME

globus_io_secure_authentication_mode_t

DESCRIPTION

Globus I/O GSI authentication modes.

ATTRIBUTES


[Functions] globus_io/globus_io_secure_authorization_data_destroy

[top][index]

NAME

globus_io_secure_authorization_data_destroy

SYNOPSIS

package require globus_io

globus_io_secure_authorization_data_destroy data

DESCRIPTION

This command is used to free a data structure to hold authorization-mode specific data.

This function must be after the data structure is no longer being used to free memory allocated by setting it's member data.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_secure_authorization_data_destroy $data ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_secure_authorization_data_initialize, globus_io_secure_authorization_data_get_callback, globus_io_secure_authorization_data_set_callback, globus_io_secure_authorization_data_get_identity, globus_io_secure_authorization_data_set_identity


[Functions] globus_io/globus_io_secure_authorization_data_get_callback

[top][index]

NAME

globus_io_secure_authorization_data_get_callback

SYNOPSIS

package require globus_io

globus_io_secure_authorization_data_get_callback data

DESCRIPTION

This command is used to query the callback and callback-arg members of the authorization-mode specific data structure.

This member is set by a call to the function globus_io_secure_authorization_data_set_callback.

PARAMETERS

RETURN VALUE

On success globus_io_secure_authorization_data_get_callback returns 0 and the current values of the callback and callback-arg in the data structure. On error, this command will raise an error and must be caught using the appropriate bgerror command.

EXAMPLE

TCL sample script to illustrate how to use this command.

BUGS

None

TODO

None

SEE ALSO

globus_io_secure_authorization_data_initialize, globus_io_secure_authorization_data_destroy, globus_io_secure_authorization_data_get_callback, globus_io_secure_authorization_data_set_identity, globus_io_secure_authorization_data_get_identity,


[Functions] globus_io/globus_io_secure_authorization_data_get_identity

[top][index]

NAME

globus_io_secure_authorization_data_get_identity

SYNOPSIS

package require globus_io

globus_io_secure_authorization_data_get_identity data

DESCRIPTION

This command is used to query the "identity" member of the authorization-mode specific data structure.

This member is set by a call to globus_io_secure_authorization_mode_set_identity.

PARAMETERS

RETURN VALUE

On success globus_io_secure_authorization_data_set_identity returns 0 and the identity string set in the data structure. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_io_secure_authorization_data_get_identity $data ] result identity

BUGS

None

TODO

None

SEE ALSO

globus_io_secure_authorization_data_initialize, globus_io_secure_authorization_data_destroy, globus_io_secure_authorization_data_get_callback, globus_io_secure_authorization_data_set_callback, globus_io_secure_authorization_data_set_identity,


[Functions] globus_io/globus_io_secure_authorization_data_initialize

[top][index]

NAME

globus_io_secure_authorization_data_initialize

SYNOPSIS

package require globus_io

globus_io_secure_authorization_data_initialize data

DESCRIPTION

This command is used to initialize a data structure to hold authorization-mode specific data.

This function must be called before any of the data accessors for this structure can be used.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_secure_authorization_data_initialize $data ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_secure_authorization_data_destroy, globus_io_secure_authorization_data_get_callback, globus_io_secure_authorization_data_set_callback, globus_io_secure_authorization_data_get_identity, globus_io_secure_authorization_data_set_identity


[Functions] globus_io/globus_io_secure_authorization_data_set_callback

[top][index]

NAME

globus_io_secure_authorization_data_set_callback

SYNOPSIS

package require globus_io

globus_io_secure_authorization_data_set_callback data callback callback_arg

DESCRIPTION

This command is used to set the callback and callback_arg members of the authorization-mode specific data structure.

This member is used when setting the authorization-mode attribute of a TCP attribute set to GLOBUS_IO_SECURE_AUTHORIZATION_MODE_CALLBACK in a call to globus_io_attr_set_secure_authorization_mode.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_secure_authorization_data_set_callback $data { callback_proc callback_arg } ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_secure_authorization_data_initialize, globus_io_secure_authorization_data_destroy, globus_io_secure_authorization_data_get_callback, globus_io_secure_authorization_data_set_identity, globus_io_secure_authorization_data_get_identity,


[Functions] globus_io/globus_io_secure_authorization_data_set_identity

[top][index]

NAME

globus_io_secure_authorization_data_set_identity

SYNOPSIS

package require globus_io

globus_io_secure_authorization_data_set_identity data identity

DESCRIPTION

This command is used to set the "identity" member of the authorization-mode specific data structure.

This member should be set to a string containing the security distinguished name of the peer which you will authorize for this connection. The identity is only when the authorization-mode attribute is set to GLOBUS_IO_SECURE_AUTHORIZATION_MODE_IDENTITY.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_secure_authorization_data_set_identity $data "/DC=org/DC=doegrids/OU=People/CN=Michael Samidi 288621/CN=2095438022" ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_secure_authorization_data_initialize, globus_io_secure_authorization_data_destroy, globus_io_secure_authorization_data_get_callback, globus_io_secure_authorization_data_set_callback, globus_io_secure_authorization_data_get_identity,


[Types] globus_io/globus_io_secure_authorization_mode_t

[top][index]

NAME

globus_io_secure_authorization_mode_t

DESCRIPTION

Globus I/O GSI authorization modes.

ATTRIBUTES


[Types] globus_io/globus_io_secure_channel_mode_t

[top][index]

NAME

globus_io_secure_channel_mode_t

DESCRIPTION

Globus I/O GSI channel modes.

ATTRIBUTES


[Types] globus_io/globus_io_secure_delegation_mode_t

[top][index]

NAME

globus_io_secure_delegation_mode_t

DESCRIPTION

Globus I/O GSI delegation modes.

ATTRIBUTES


[Types] globus_io/globus_io_secure_protection_mode_t

[top][index]

NAME

globus_io_secure_protection_mode_t

DESCRIPTION

Globus I/O GSI protection levels.

ATTRIBUTES


[Types] globus_io/globus_io_secure_proxy_mode_t

[top][index]

NAME

globus_io_secure_proxy_mode_t

DESCRIPTION

Globus I/O GSI proxy modes.

ATTRIBUTES


[Functions] globus_io/globus_io_send

[top][index]

NAME

globus_io_send

SYNOPSIS

package require globus_io

globus_io_send handle buffer flags

DESCRIPTION

This command is used to perform a blocking send operation on the handle. This will block until the contents of buffer are written to the network, or an error occurs.

PARAMETERS

RESULT On success globus_io_send returns 0 and number of bytes sent. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_io_send $handle $buffer $flags ] status nbytes_sent

BUGS

In the case of an error during a protected data transfer, the value pointed to by nbytes_sent is not necesarily reliable.

TODO

None

SEE ALSO

globus_io_register_write, globus_io_try_write


[Types] globus_io/globus_io_send_flags_t

[top][index]

NAME

globus_io_send_flags_t

DESCRIPTION

Use this to send a TCP message out of band (Urgent data flag set).

ATTRIBUTES


[Functions] globus_io/globus_io_tcp_accept

[top][index]

NAME

globus_io_tcp_accept

SYNOPSIS

package require globus_io

globus_io_tcp_accept listener_handle attr new_handle

DESCRIPTION

This command is used to perform blocking TCP connection establishment on the specified host/port pair.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_tcp_accept $listener_handle $attr $new_handle ] result

BUGS

None

TODO

None


[Functions] globus_io/globus_io_tcp_connect

[top][index]

NAME

globus_io_tcp_connect

SYNOPSIS

package require globus_io

globus_io_tcp_connect host port attr handle

DESCRIPTION

This command is used to perform blocking TCP connection establishment on the specified host/port pair.

PARAMETERS

RETURN VALUE

On success globus_io_tcp_connect returns 0 and the Globus I/O handle to be initialized when the connection is completed. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_io_tcp_connect $host $port $attr $handle ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_tcp_register_connect


[Functions] globus_io/globus_io_tcp_create_listener

[top][index]

NAME

globus_io_tcp_create_listener

SYNOPSIS

package require globus_io

globus_io_tcp_create_listener port backlog attr handle

DESCRIPTION

This command is used to create a socket handle capable of accepting new TCP connections from other hosts or processes.

In order to actively listen for connections, you must call globus_io_tcp_register_listen or globus_io_tcp_listen with the new handle returned by this function.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_tcp_create_listener 0 -1 $attr $handle ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_tcp_register_listen, globus_io_tcp_listen, globus_io_tcp_register_accept, globus_io_tcp_accept


[Functions] globus_io/globus_io_tcp_get_attr

[top][index]

NAME

globus_io_tcp_get_attr

SYNOPSIS

package require globus_io

globus_io_tcp_get_attr handle attr

DESCRIPTION

This command is used to extract the TCP attributes from a Globus I/O handle.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_tcp_get_attr $handle $attr ] result

BUGS

None

TODO

None


[Functions] globus_io/globus_io_tcp_get_delegated_credential

[top][index]

NAME

globus_io_tcp_get_delegated_credential

SYNOPSIS

package require globus_io

globus_io_tcp_get_delegated_credential handle cred

DESCRIPTION

This command is used to retrieve the delegated credential from a a secure TCP connection. If the TCP handle is set to GLOBUS_IO_SECURE_AUTHENTICATION_MODE_NONE or the client did not delegate a credential, the cred value will be set to NULL.

PARAMETERS

RETURN VALUE

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

EXAMPLE

TBD

BUGS

None

TODO

None


[Functions] globus_io/globus_io_tcp_get_local_address

[top][index]

NAME

globus_io_tcp_get_local_address

SYNOPSIS

package require globus_io

globus_io_tcp_get_local_address handle

DESCRIPTION

This command is used to get the IP address associated with a connected TCP socket.

PARAMETERS

RETURN VALUE

This function will return the IP address of the socket associated with this handle. The handle must be already connected, or an error will be returned.

EXAMPLE

lassign [ globus_io_tcp_get_local_address handle ] result ipstring port

BUGS

None


[Functions] globus_io/globus_io_tcp_get_remote_address

[top][index]

NAME

globus_io_tcp_get_remote_address

SYNOPSIS

package require globus_io

globus_io_tcp_get_remote_address handle

DESCRIPTION

This command is used to get the IP address associated with the peer of a connected TCP socket.

PARAMETERS

RETURN VALUE

This function will return the IP address of the peer of the socket associated with this handle. The handle must be already connected, or an error will be returned.

EXAMPLE

lassign [ globus_io_tcp_get_remote_address handle ] result ipstring port

BUGS

None


[Functions] globus_io/globus_io_tcp_get_security_context

[top][index]

NAME

globus_io_tcp_get_security_context

SYNOPSIS

package require globus_io

globus_io_tcp_get_security_context handle context

DESCRIPTION

This command is used to extract the security context from a Globus I/O handle.

PARAMETERS

RETURN VALUE

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

EXAMPLE

TBD

BUGS

None

TODO

None


[Functions] globus_io/globus_io_tcp_listen

[top][index]

NAME

globus_io_tcp_listen

SYNOPSIS

package require globus_io

globus_io_tcp_listen listener_handle

DESCRIPTION

This command will block until a client connection is pending on the listener_handle. Once this function returns, the user application can call globus_io_tcp_register_accept or globus_io_tcp_accept to create a newly connected handle.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_tcp_listen $listener_handle ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_tcp_register_listen, globus_io_tcp_register_accept, globus_io_tcp_accept.


[Functions] globus_io/globus_io_tcp_register_accept

[top][index]

NAME

globus_io_tcp_register_accept

SYNOPSIS

package require globus_io

globus_io_tcp_register_accept listener_handle attr new_handle script

DESCRIPTION

This command is used to post asynchronous server-side TCP connection establishment.

Once the connection has been accepted, the script will be called, with the callback_arg and a newly created, connected, handle argument passed to the script.

PARAMETERS

RETURN VALUE

On success globus_io_tcp_register_accept returns 0 and the new Globus I/O handle to be initialized when the connection is completed. On error, this command will raise an error and must be caught using the appropriate bgerror command.

EXAMPLE

lassign [ globus_io_tcp_register_accept $listener_handle $attr $new_handle [ subst { callback callback_arg } ] ] result

BUGS

None

TODO

None


[Functions] globus_io/globus_io_tcp_register_connect

[top][index]

NAME

globus_io_tcp_register_connect

SYNOPSIS

package require globus_io

globus_io_tcp_register_connect host port attr script

DESCRIPTION

This command is used to connect a TCP socket on the specified host/port pair. The connection will be started and a callback will be invoked when the connection is established.

PARAMETERS

RETURN VALUE

On success globus_io_tcp_register_connect returns 0 and when the operation is completed successfully the TCP connection handle will be initialized returned as part of callback script argument. On error, this command will raise an error and must be caught using the appropriate bgerror command.

EXAMPLE

lassign [ globus_io_tcp_register_connect $host $port $attr [ subst { callback_script callback_arg } ] ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_tcp_connect


[Functions] globus_io/globus_io_tcp_register_listen

[top][index]

NAME

globus_io_tcp_register_listen

SYNOPSIS

package require globus_io

globus_io_tcp_register_listen handle script

DESCRIPTION

This command is used to post asynchronous wait until a client connection is pending.

This function will invoke the script when the Globus I/O handle has a connection pending. Calls to this function or globus_io_tcp_listen must be made before each call to globus_io_tcp_accept or globus_io_tcp_register_accept.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_tcp_register_listen $handle [ subst { callback callback_arg } ] ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_tcp_listen, globus_io_tcp_register_accept, globus_io_tcp_accept.


[Functions] globus_io/globus_io_tcpattr_destroy

[top][index]

NAME

globus_io_tcpattr_destroy

SYNOPSIS

package require globus_io

globus_io_tcpattr_destroy attr

DESCRIPTION

This command is used to destroy a previously allocated TCP attribute structure.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_tcpattr_destroy $attr ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_init


[Functions] globus_io/globus_io_tcpattr_init

[top][index]

NAME

globus_io_tcpattr_init

SYNOPSIS

package require globus_io

globus_io_tcpattr_init attr

DESCRIPTION

This command is used to initialize a TCP attribute structure.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_tcpattr_init $attr ] result

BUGS

None

TODO

None

SEE ALSO

globus_io_tcpattr_destroy


[Functions] globus_io/globus_io_try_read

[top][index]

NAME

globus_io_try_read

SYNOPSIS

package require globus_io

globus_io_try_read handle buffer_length

DESCRIPTION

This command is used to read whatever data is immediately available up to buffer_length from a handle in a blocking mode.

PARAMETERS

RETURN VALUE

On success globus_io_read returns 0 and a block of data. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_io_try_read $handle $buffer_length ] status buffer

BUGS

None

TODO

None

SEE ALSO

globus_io_read, globus_io_register_read


[Functions] globus_io/globus_io_try_send

[top][index]

NAME

globus_io_try_send

SYNOPSIS

package require globus_io

globus_io_try_send handle buffer flags

DESCRIPTION

This command is used to perform nonblocking TCP or file send whatever data can immediately processed by the operating system.

PARAMETERS

RESULT On success globus_io_try_send returns 0 and number of bytes sent. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_io_try_send $handle $buffer $flags ] status nbytes_sent

BUGS

This function will always return 0 bytes written for TCP connections which are configured to use GSSAPI or SSL data wrapping.

TODO

None

SEE ALSO

globus_io_write, globus_io_register_write


[Functions] globus_io/globus_io_try_write

[top][index]

NAME

globus_io_try_write

SYNOPSIS

package require globus_io

globus_io_try_write handle buffer

DESCRIPTION

This command is used to write as much as data it can from buffer, in a blocking mode.

PARAMETERS

RESULT On success globus_io_try_write returns 0 and number of bytes written. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_io_try_write $handle $buffer ] status nbytes_written

BUGS

None

TODO

None

SEE ALSO

globus_io_write, globus_io_register_write


[Types] globus_io/globus_io_whence_t

[top][index]

NAME

globus_io_whence_t

DESCRIPTION

Type for the "whence" parameter of globus_io_file_seek.

This value is used to interpret the "offset" parameter of globus_io_file_seek.

ATTRIBUTES


[Functions] globus_io/globus_io_write

[top][index]

NAME

globus_io_write

SYNOPSIS

package require globus_io

globus_io_write handle buffer

DESCRIPTION

This command is used to script the writing of a block of data in blocking mode.

PARAMETERS

RESULT On success globus_io_write returns 0 and number of bytes written. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_io_write $handle $buffer ] status nbytes_written

BUGS

None

TODO

None

SEE ALSO

globus_io_try_write, globus_io_register_write


[Functions] globus_io/globus_io_writev

[top][index]

NAME

globus_io_writev

SYNOPSIS

package require globus_io

globus_io_writev handle list_of_buffers

DESCRIPTION

This command is used to script the writing of a block of data to several memory addresses at once.

PARAMETERS

RETURN VALUE

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

EXAMPLE

lassign [ globus_io_writev $handle [list $buf1 $buf2] ] status nbytes

BUGS

None

TODO

None

SEE ALSO

globus_io_write, globus_io_try_write, globus_io_register_write