NAME
globus_xio_attr_cntl
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
cmd
var_args
DESCRIPTION
This command provides a means to access the attr structure. What exactly this command does is determined by the value in the parameter cmd and the value of the parameter driver. When the driver parameter is NULL it indicates that this command applies to general globus_xio values. If it is not NULL it indicates that the command will effect driver specific values. Each driver is responsible for defining its own enumeration of values for cmd and the var_args associated with that command.
driver - This parameter indicates which driver the user would like to perform the requested operation. If this parameter is NULL this request will be scoped to general attribute functions.
cmd - An enum that determines what specific operation the user is requesting. Each driver will determine the value for this enumeration.
var_args - These values are associated with the cmd values defined by the driver.
RETURN VALUE
On success globus_xio_attr_cntl returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
TBD
BUGS
None
TODO
TCL sample script to illustrate how to use this command.
More explanation about cmd and var args.
SEE ALSO
globus_xio_attr_init, globus_xio_attr_copy, globus_xio_attr_destroy
ATTRIBUTES
GLOBUS_XIO_FILE_GET_FLAGS
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_FILE_GET_FLAGS
DESCRIPTION
Get the file open flags.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and the current flags.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_FILE_GET_HANDLE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_FILE_GET_HANDLE
DESCRIPTION
Get the file handle in use or in attr.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and the file handle. If none is set, GLOBUS_XIO_TCP_INVALID_HANDLE will be set.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_FILE_GET_MODE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_FILE_GET_MODE
DESCRIPTION
Get the file create mode.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and the current mode.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_FILE_GET_TRUNC_OFFSET
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_FILE_GET_TRUNC_OFFSET
DESCRIPTION
Get the file truncate offset.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and the offset.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_FILE_SET_FLAGS
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_FILE_SET_FLAGS
flags
DESCRIPTION
Set the file open flags. The default flags specify to create the file if it doesn't exist, open it for reading and writing, and interpret it as a binary file.
PARAMETERS
flags - A bitwise OR of all the flags desired
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
SEE ALSO
ATTRIBUTES
GLOBUS_XIO_FILE_SET_HANDLE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_FILE_SET_HANDLE
handle
DESCRIPTION
Set the file handle to use. Do not open a new file, use this preopened handle instead.
PARAMETERS
handle - Use this handle for the file. Note: close() will not be called on this handle.
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_FILE_SET_MODE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_FILE_SET_MODE
mode
DESCRIPTION
Set the file create mode (default mode is 0644). Use this to set the permissions a non-existent file.
PARAMETERS
mode - A bitwise OR of all the modes desired
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
SEE ALSO
ATTRIBUTES
GLOBUS_XIO_FILE_SET_TRUNC_OFFSET
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_FILE_SET_TRUNC_OFFSET
offset
DESCRIPTION
Set the file truncate offset. Use this in conjunction with the GLOBUS_XIO_FILE_TRUNC flag to truncate a file to a non-zero offset. If the file was larger than offset bytes, the extra data is lost. If the file was shorter or non-existent, it is extended and the extended part reads as zeros. (default is 0)
PARAMETERS
offset - The desired size of the file.
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
SEE ALSO
globus_xio_file_flag_t/GLOBUS_XIO_FILE_TRUNC
ATTRIBUTES
GLOBUS_XIO_GSI_FORCE_SERVER_MODE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_GSI_FORCE_SERVER_MODE
server_mode
DESCRIPTION
Force the server mode setting. This explicitly sets the directionality of context establishment and delegation.
PARAMETERS
server_mode - The server mode.
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_GET_AUTHORIZATION_MODE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_GSI_GET_AUTHORIZATION_MODE
DESCRIPTION
Get the authorization mode.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and the authorization mode currently in effect.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_GET_BUFFER_SIZE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_GSI_GET_BUFFER_SIZE
DESCRIPTION
Get the read buffer size. The read buffer is used for buffering wrapped data, is initialized with a default size of 128K and scaled dynamically to always be able to fit whole tokens.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and the buffer size currently in use.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_GET_CREDENTIAL
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_GSI_GET_CREDENTIAL
DESCRIPTION
Get the credential to be used
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and a credential if a credential was explicitly set prior to this call. It will not return any credential automatically acquired during context initizalization.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_GET_DELEGATION_MODE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_GSI_GET_DELEGATION_MODE
DESCRIPTION
Get the delegation mode. Note that: changing the delegation mode changes the req_flags.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and the delegation mode currently in effect.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_GET_GSSAPI_REQ_FLAGS
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_GSI_GET_GSSAPI_REQ_FLAGS
DESCRIPTION
Get the GSSAPI req_flags to be used
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and the req_flags currently in effect.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_GET_PROTECTION_LEVEL
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_GSI_GET_PROTECTION_LEVEL
DESCRIPTION
Get the protection level
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and the current protection level.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_GET_PROXY_MODE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_GSI_GET_PROXY_MODE
DESCRIPTION
Get the proxy mode. Note that changing the proxy mode changes the req_flags.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and the proxy mode currently in effect.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_GET_TARGET_NAME
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_GSI_GET_TARGET_NAME
DESCRIPTION
Get the expected peer name.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and the expected peer name.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_GET_WRAP_MODE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_GSI_GET_WRAP_MODE
DESCRIPTION
Get the wrapping mode. This mode determines whether tokens will be wrapped with a Globus IO style header or not.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and the wrapping mode currently in use.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_SET_ANON
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_GSI_SET_ANON
anon_mode
DESCRIPTION
Do anonymous authentication. Note that: changing the SSL compatibility mode changes the req_flags and the wrapping mode.
PARAMETERS
anon_mode - The ssl compatibility mode to use.
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_SET_AUTHORIZATION_MODE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_GSI_SET_AUTHORIZATION_MODE
authz_mode
DESCRIPTION
Set the authorization mode.
PARAMETERS
authz_mode - The authorization mode to set
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_SET_BUFFER_SIZE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_GSI_SET_BUFFER_SIZE
buffer_size
DESCRIPTION
Set the read buffer size. The read buffer is used for buffering wrapped data, is initialized with a default size of 128K and scaled dynamically to always be able to fit whole tokens.
PARAMETERS
buffer_size - The size of the read buffer.
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_SET_CREDENTIAL
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_GSI_SET_CREDENTIAL
credential
DESCRIPTION
Set the credential to be used.
PARAMETERS
credential - The credential to set. The credential structure needs to remain valid for the lifetime of any XIO data structure it is used by.
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_SET_DELEGATION_MODE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_GSI_SET_DELEGATION_MODE
delegation_mode
DESCRIPTION
Set the delegation mode. Note that: changing the delegation mode changes the req_flags.
PARAMETERS
delegation_mode - The delegation mode to set.
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_SET_GSSAPI_REQ_FLAGS
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_GSI_SET_GSSAPI_REQ_FLAGS
req_flags
DESCRIPTION
Set the GSSAPI req_flags to be used.
PARAMETERS
req_flags - The req_flags to set.
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_SET_PROTECTION_LEVEL
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_GSI_SET_PROTECTION_LEVEL
protection_level
DESCRIPTION
Set the protection level. Note: changing the proxy mode changes the req_flags
PARAMETERS
protection_level - The protection level to set.
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_SET_PROXY_MODE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_GSI_SET_PROXY_MODE
proxy_mode
DESCRIPTION
Set the proxy mode. Note that changing the proxy mode changes the req_flags.
PARAMETERS
proxy_mode - The proxy mode to set
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_SET_SSL_COMPATIBLE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_GSI_SET_SSL_COMPATIBLE
ssl_mode
DESCRIPTION
Make the wire protocol SSL compatible. This implies no wrapping of security tokens and no delegation. Note that: changing the SSL compatibility mode changes the req_flags.
PARAMETERS
ssl_mode - The ssl compatibility mode to use.
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_SET_TARGET_NAME
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_GSI_SET_TARGET_NAME
target_name
DESCRIPTION
Set the expected peer name.
PARAMETERS
target_name - The expected peer name.
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_SET_WRAP_MODE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_GSI_SET_WRAP_MODE
wrap_mode
DESCRIPTION
Set the wrapping mode. This mode determines whether tokens will be wrapped with a Globus IO style header or not.
PARAMETERS
wrap_mode - The wrapping mode to use.
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_GET_BACKLOG
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_GET_BACKLOG
DESCRIPTION
Get the listener backlog on an attr.
PARAMETERS
Parameters
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and the listener backlog.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_GET_CONNECT_RANGE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_GET_CONNECT_RANGE
DESCRIPTION
Get the TCP source port range on an attr.
PARAMETERS
connector_min_port_out - The lower bound will be stored here.
connector_max_port_out - The upper bound will be stored here.
RETURN VALUE
On success globus_xio_attr_cntl returns 0, connector_min_port_out and connector_max_port_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_GET_HANDLE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_GET_HANDLE
DESCRIPTION
Get the TCP socket handle on an attr, handle, or server.
PARAMETERS
handle_out - The TCP socket will be stored here. If none is set, GLOBUS_XIO_TCP_INVALID_HANDLE will be set.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and handle.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_GET_INTERFACE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_GET_INTERFACE
DESCRIPTION
Get the interface on the attr.
PARAMETERS
interface_out - A pointer to the interface will be stored here. If one is set, NULL will be passed back. Otherwise, the interface will be duplicated with strdup() and the user should call free() on it.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and interface_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_GET_KEEPALIVE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_GET_KEEPALIVE
DESCRIPTION
Get the TCP keepalive flag.
PARAMETERS
keepalive_out - The TCP keepalive flag will be stored here.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and keepalive_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_GET_LINGER
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_GET_LINGER
DESCRIPTION
Get the TCP linger flag and time.
PARAMETERS
linger_out - The linger flag will be stored here.
linger_time_out - The linger time will be set here.
RETURN VALUE
On success globus_xio_attr_cntl returns 0, linger_out and linger_time_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_GET_LISTEN_RANGE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_GET_LISTEN_RANGE
DESCRIPTION
Get the TCP port range on an attr.
PARAMETERS
listener_min_port_out - The lower bound will be stored here.
listener_max_port_out - The upper bound will be stored here.
RETURN VALUE
On success globus_xio_attr_cntl returns 0, listener_min_port_out and listener_max_port_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_GET_NO_IPV6
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_GET_NO_IPV6
DESCRIPTION
Get the no IPV6 flag on an attr.
PARAMETERS
no_ipv6_out - The no IPV6 flag will be stored here.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and no_ipv6_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_GET_NODELAY
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_GET_NODELAY
DESCRIPTION
Get the TCP nodelay flag.
PARAMETERS
nodelay_out - The no delay flag will be stored here.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and nodelay_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_GET_OOBINLINE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_GET_OOBINLINE
DESCRIPTION
Get the oobinline flag.
PARAMETERS
oobinline_out - The oobinline flag will be stored here.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and oobinline_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_GET_PORT
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_GET_PORT
DESCRIPTION
Get the TCP port number to bind to.
PARAMETERS
Parameters
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and the port number.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_GET_RCVBUF
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_GET_RCVBUF
DESCRIPTION
Get the TCP receive buffer size on the attr or handle.
PARAMETERS
rcvbuf_out - The receive buffer size will be stored here.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and rcvbuf_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_GET_RESTRICT_PORT
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_GET_RESTRICT_PORT
DESCRIPTION
Get the restrict port flag.
PARAMETERS
restrict_port_out - The restrict port flag will be stored here.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and restrict_port_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_GET_REUSEADDR
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_GET_REUSEADDR
DESCRIPTION
Get the reuseaddr flag on an attr.
PARAMETERS
resuseaddr_out - The reuseaddr flag will be stored here.
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_GET_SERVICE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_GET_SERVICE
DESCRIPTION
Get the TCP service name to bind to.
PARAMETERS
Parameters
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and the service name.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_GET_SNDBUF
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_GET_SNDBUF
DESCRIPTION
Get the TCP send buffer size on the attr or handle.
PARAMETERS
sndbuf_out - The send buffer size will be stored here.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and sndbuf_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_SET_BACKLOG
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_SET_BACKLOG
listener_backlog
DESCRIPTION
Set the listener backlog on a server. Used only on attrs for globus_xio_server_create(). The default backlog is -1 (system maximum).
PARAMETERS
This indicates the maximum length of the system's queue of pending connections. Any connection attempts when the queue is full will fail. If backlog is equal to -1, then the system-specific maximum queue length will be used.
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_SET_CONNECT_RANGE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_SET_CONNECT_RANGE
connector_min_port
connector_max_port
DESCRIPTION
Set the TCP port range to confine the server to. Used only on attrs for globus_xio_register_open(). It overrides the range set in the GLOBUS_TCP_SOURCE_RANGE env variable. If 'restrict port' is true, the connecting socket's local port will be constrained to the range specified.
PARAMETERS
connector_min_port - The lower bound on the listener port. (default 0 -- no bound).
connector_max_port - The upper bound on the listener port. (default 0 -- no bound)
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_SET_HANDLE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_SET_HANDLE
handle
DESCRIPTION
Set the TCP socket to use for a handle or server. Used only on attrs for globus_xio_server_create() or globus_xio_register_open().
PARAMETERS
handle - Use this handle (fd or SOCKET) for the listener or connection. Note: close() will not be called on this handle.
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_SET_INTERFACE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_SET_INTERFACE
interface
DESCRIPTION
Set the interface to bind a listener or connection to. Used only on attrs for globus_xio_server_create() or globus_xio_register_open.
PARAMETERS
interface - The interface to be used. Can be a hostname or numeric IP.
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_SET_KEEPALIVE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_SET_KEEPALIVE
keepalive
DESCRIPTION
Enable TCP keepalive. Used on attrs for globus_xio_server_create(), globus_xio_register_open() and with globus_xio_handle_cntl() to determine whether or not to periodically send "keepalive" messages on a connected socket handle. This may enable earlier detection of broken connections.
PARAMETERS
keepalive - GLOBUS_TRUE to enable, GLOBUS_FALSE to disable (default).
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_SET_LINGER
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_SET_LINGER
linger
linger_time
DESCRIPTION
Set TCP linger. Used on attrs for globus_xio_server_create(), globus_xio_register_open() and with globus_xio_handle_cntl() 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. If this is enabled, any data remaining after the linger time has expired, will be discarded. If this is disabled, close finishes immediately, but the OS will still attempt to transmit the remaining data.
PARAMETERS
linger - GLOBUS_TRUE to enable, GLOBUS_FALSE to disable (default).
linger_time - The time (in seconds) to block at close time if linger is true and data is queued in the socket buffer.
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_SET_LISTEN_RANGE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_SET_LISTEN_RANGE
listener_min_port
listener_max_port
DESCRIPTION
Set the TCP port range to confine the server to. Used only on attrs for globus_xio_server_create() where no specific service or port has been set. It overrides the range set in the GLOBUS_TCP_PORT_RANGE env variable. If 'restrict port' is true, the server's listening port will be constrained to the range specified.
PARAMETERS
listener_min_port - The lower bound on the listener port. (default 0 -- no bound).
listener_max_port - The upper bound on the listener port. (default 0 -- no bound)
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_SET_NO_IPV6
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_SET_NO_IPV6
no_ipv6
DESCRIPTION
Restrict to IPV4 only. Used only on attrs for globus_xio_server_create() or globus_xio_register_open(). Disallow IPV6 sockets from being used (default is to use either IPV4 or IPV6).
PARAMETERS
no_ipv6 - GLOBUS_TRUE to disallow ipv6, GLOBUS_FALSE to allow (default).
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_SET_NODELAY
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_SET_NODELAY
nodelay
DESCRIPTION
Disable Nagle's algorithm. Used on attrs for globus_xio_server_create(), globus_xio_register_open() and with globus_xio_handle_cntl() to determine whether or not to disable Nagle's algorithm. If set to GLOBUS_TRUE, the socket will send packets as soon as possible with no unnecessary delays introduced.
PARAMETERS
nodelay - GLOBUS_TRUE to disable nagle, GLOBUS_FALSE to enable (default).
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_SET_OOBINLINE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_SET_OOBINLINE
oobinline
DESCRIPTION
Receive out of band data (TCP urgent data) in normal stream. Used on attrs for globus_xio_server_create(), globus_xio_register_open() and with globus_xio_handle_cntl() to choose whether out-of-band data is received in the normal data queue. (Currently, there is no other way to receive OOB data).
PARAMETERS
oobinline - GLOBUS_TRUE to enable, GLOBUS_FALSE to disable (default).
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_SET_PORT
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_SET_PORT
listener_port
DESCRIPTION
Set the TCP port number to bind to. Used only on attrs for globus_xio_server_create(). The default port number is 0 (system assigned)
PARAMETERS
listener_port - The port number to use when setting up the listener. If the service name is also set, this will only be used if that can't be resolved.
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_SET_RCVBUF
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_SET_RCVBUF
rcvbuf
DESCRIPTION
Set the TCP socket receive buffer size. Used on attrs for globus_xio_server_create(), globus_xio_register_open() and with globus_xio_handle_cntl() to set the size of the receive buffer used on the socket. The receive buffer size is often used by the operating system to choose the appropriate TCP window size.
PARAMETERS
rcvbuf - The receive buffer size in bytes. (default is system specific).
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_SET_RESTRICT_PORT
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_SET_RESTRICT_PORT
restrict_port
DESCRIPTION
Enable or disable the listener or connector range constraints. Used only on attrs for globus_xio_server_create() or globus_xio_register_open(). This enables or ignores the port range found in the attr or in then env. By default, those ranges are enabled.
PARAMETERS
restrict_port - GLOBUS_TRUE to enable (default), GLOBUS_FALSE to disable.
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
SEE ALSO
globus_xio_attr_cntl/GLOBUS_XIO_TCP_SET_LISTEN_RANGE, globus_xio_attr_cntl/GLOBUS_XIO_TCP_SET_CONNECT_RANGE.
ATTRIBUTES
GLOBUS_XIO_TCP_SET_REUSEADDR
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_SET_REUSEADDR
reuseaddr
DESCRIPTION
Reuse addr when binding. Used only on attrs for globus_xio_server_create() or globus_xio_register_open() to determine whether or not to allow reuse of addresses when binding a socket to a port number.
PARAMETERS
resuseaddr - GLOBUS_TRUE to allow, GLOBUS_FALSE to disallow (default).
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_SET_SERVICE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_SET_SERVICE
service_name
DESCRIPTION
Set the tcp service name to bind to. Used only on attrs for globus_xio_server_create().
PARAMETERS
service_name - The service name to use when setting up the listener. If the service name cannot be resolved, the port (if one is set) will be used instead.
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_SET_SNDBUF
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_TCP_SET_SNDBUF
sndbuf
DESCRIPTION
Set the TCP socket send buffer size. Used on attrs for globus_xio_server_create(), globus_xio_register_open() and with globus_xio_handle_cntl() to set the size of the send buffer used on the socket.
PARAMETERS
sndbuf - The send buffer size in bytes to use. (default is system specific).
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_UDP_GET_HANDLE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_UDP_GET_HANDLE
DESCRIPTION
Get the socket handle on an attr or handle.
PARAMETERS
handle_out - The UDP socket will be stored here. If none is set, GLOBUS_XIO_UDP_INVALID_HANDLE will be set.
RETURN VALUE
On success globus_xio_server_cntl returns 0 and handle_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_UDP_GET_INTERFACE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_UDP_GET_INTERFACE
DESCRIPTION
Get the interface on the attr.
PARAMETERS
interface_out - A pointer to the interface will be stored here. If one is set, NULL will be passed back. Otherwise, the interface will be duplicated with strdup() and the user should call free() on it.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and interface_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_UDP_GET_LISTEN_RANGE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_UDP_GET_LISTEN_RANGE
DESCRIPTION
Get the UDP port range on an attr.
PARAMETERS
listener_min_port_out - The lower bound will be stored here.
listener_max_port_out - The upper bound will be stored here.
RETURN VALUE
On success globus_xio_attr_cntl returns 0, listener_min_port_out and listener_max_port_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_UDP_GET_NO_IPV6
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_UDP_GET_NO_IPV6
DESCRIPTION
Get the no IPV6 flag on an attr.
PARAMETERS
no_ipv6_out - The no IPV6 flag will be stored here.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and no_ipv6_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_UDP_GET_PORT
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_UDP_GET_PORT
DESCRIPTION
The port number to listen on.
PARAMETERS
listener_port_out - The port will be stored here.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and the port number.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_UDP_GET_RCVBUF
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_UDP_GET_RCVBUF
DESCRIPTION
Get the UDP receive buffer size on the attr or handle.
PARAMETERS
rcvbuf_out - The receive buffer size will be stored here.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and rcvbuf_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_UDP_GET_RESTRICT_PORT
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_UDP_GET_RESTRICT_PORT
DESCRIPTION
Get the restrict port flag.
PARAMETERS
restrict_port_out - The restrict port flag will be stored here.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and restrict_port_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_UDP_GET_REUSEADDR
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_UDP_GET_REUSEADDR
DESCRIPTION
Get the reuseaddr flag on an attr.
PARAMETERS
resuseaddr_out - The reuseaddr flag will be stored here.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and reuseaddr_out flag.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_UDP_GET_SERVICE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_UDP_GET_SERVICE
DESCRIPTION
Get the service name to listen on.
PARAMETERS
service_name_out - A pointer to the service name will be stored here. If none is set, NULL will be passed back. Otherwise, the name will be duplicated with strdup() and the user should call free() on it.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and the service name.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_UDP_GET_SNDBUF
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_UDP_GET_SNDBUF
DESCRIPTION
Get the send buffer size on the attr or handle.
PARAMETERS
sndbuf_out - The send buffer size will be stored here.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and sndbuf_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_UDP_SET_HANDLE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_UDP_SET_HANDLE
handle
DESCRIPTION
Set the UDP socket to use.
PARAMETERS
handle - Use this handle (fd or SOCKET). Note: close() will not be called on this handle.
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_UDP_SET_INTERFACE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_UDP_SET_INTERFACE
interface
DESCRIPTION
Set the interface to bind the socket to.
PARAMETERS
interface - The interface to be used. Can be a hostname or numeric IP.
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_UDP_SET_LISTEN_RANGE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_UDP_SET_LISTEN_RANGE
listener_min_port
listener_max_port
DESCRIPTION
Set the port range to confine the listener to. Used only where no specific service or port has been set. It overrides the range set in the GLOBUS_UDP_PORT_RANGE env variable. If 'restrict port' is true, the listening port will be constrained to the range specified.
PARAMETERS
listener_min_port - The lower bound on the listener port. (default 0 -- no bound).
listener_max_port - The upper bound on the listener port. (default 0 -- no bound)
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_UDP_SET_NO_IPV6
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_UDP_SET_NO_IPV6
no_ipv6
DESCRIPTION
Restrict to IPV4 only. Disallow IPV6 sockets from being used (default is to use either IPV4 or IPV6).
PARAMETERS
no_ipv6 - GLOBUS_TRUE to disallow IPV6, GLOBUS_FALSE to allow (default).
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_UDP_SET_PORT
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_UDP_SET_PORT
listener_port
DESCRIPTION
Set the port number to listen on. The default is 0 (system assigned).
PARAMETERS
listener_port - The port number to use when setting up the listener. If the service name is also set, this will only be used if that can't be resolved.
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_UDP_SET_RCVBUF
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_UDP_SET_RCVBUF
rcvbuf
DESCRIPTION
Set the socket receive buffer size. Used to set the size of the receive buffer used on the socket.
PARAMETERS
rcvbuf - The receive buffer size in bytes. (default is system specific).
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_UDP_SET_RESTRICT_PORT
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_UDP_SET_RESTRICT_PORT
restrict_port
DESCRIPTION
Enable or disable the listener range constraints. This enables or ignores the port range found in the attr or in then env. By default, those ranges are enabled.
PARAMETERS
restrict_port - GLOBUS_TRUE to enable (default), GLOBUS_FALSE to disable.
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
SEE ALSO
ATTRIBUTES
GLOBUS_XIO_UDP_SET_REUSEADDR
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_UDP_SET_REUSEADDR
reuseaddr
DESCRIPTION
Reuse addr when binding. Used to determine whether or not to allow reuse of addresses when binding a socket to a port number.
PARAMETERS
resuseaddr - GLOBUS_TRUE to allow, GLOBUS_FALSE to disallow (default).
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_UDP_SET_SERVICE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_UDP_SET_SERVICE
service_name
DESCRIPTION
Set the UDP service name to listen on.
PARAMETERS
service_name - The service name to use when setting up the listener. If the service name cannot be resolved, the port (if one is set) will be used instead.
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_UDP_SET_SNDBUF
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
attr
driver
GLOBUS_XIO_UDP_SET_SNDBUF
sndbuf
DESCRIPTION
Set the socket send buffer size. Used to set the size of the send buffer used on the socket.
PARAMETERS
sndbuf - The send buffer size in bytes to use. (default is system specific).
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
NAME
globus_xio_attr_copy
SYNOPSIS
package require globus_xio
globus_xio_attr_copy
src
DESCRIPTION
This command is used to copy an attribute structure.
RETURN VALUE
On success globus_xio_attr_copy returns 0 and the target attribute structure. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_xio_attr_copy $src ] result dst
BUGS
None
TODO
TCL sample script to illustrate how to use this command.
SEE ALSO
globus_xio_attr_init, globus_xio_attr_cntl, globus_xio_attr_destroy
NAME
globus_xio_attr_destroy
SYNOPSIS
package require globus_xio
globus_xio_attr_destroy
attr
DESCRIPTION
This command is used to clean up resources associated with an attribute
RETURN VALUE
On success globus_xio_attr_destroy returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_xio_attr_destroy $attr ] result
BUGS
None
TODO
TCL sample script to illustrate how to use this command.
SEE ALSO
globus_xio_attr_init, globus_xio_attr_cntl, globus_xio_attr_copy
NAME
globus_xio_attr_init
SYNOPSIS
package require globus_xio
globus_xio_attr_init
DESCRIPTION
This command is used to initialize Globus XIO driver attribute. Upon return from this command, attr will be initialized. This attribute must be destroyed in order to free resources associated with it.
RETURN VALUE
On success globus_xio_attr_init returns 0 and the driver attribute. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_xio_attr_init ] result driver_attr
BUGS
None
TODO
TCL sample script to illustrate how to use this command.
SEE ALSO
globus_xio_attr_cntl, globus_xio_attr_copy, globus_xio_attr_destroy
NAME
globus_xio_close
SYNOPSIS
package require globus_xio
globus_xio_close
handle
attr
DESCRIPTION
This command is used to close the handle in blocking mode.
attr - Globus XIO attributes as returned by globus_xio_attr_cnt.l It can be NULL.
RETURN VALUE
On success globus_xio_close returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_xio_close $handle $attr ] result
BUGS
None
TODO
None
SEE ALSO
NAME
globus_xio_data_descriptor_cntl
SYNOPSIS
package require globus_xio
globus_xio_data_descriptor_cntl
data_desc
driver
cmd
var_args
DESCRIPTION
This command allows the user to comunicate directly with a driver in association with a data descriptor. The driver defines what operations can be performed.
driver - This parameter indicates which driver the user would like to perform the requested operation. If this parameter is NULL this request will be scoped to all drivers.
cmd - An enum that determines what specific operation the user is requesting. Each driver will determine the value for this enumeration.
var_args - These values are associated with the cmd values defined by the driver.
RETURN VALUE
On success globus_xio_data_descriptor_cntl returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
TBD
BUGS
None
TODO
TCL sample script to illustrate how to use this command.
SEE ALSO
globus_xio_data_descriptor_init, globus_xio_data_descriptor_destroy
ATTRIBUTES
GLOBUS_XIO_TCP_GET_SEND_FLAGS
SYNOPSIS
package require globus_xio
globus_xio_data_descriptor_cntl
dd
driver
GLOBUS_XIO_TCP_GET_SEND_FLAGS
DESCRIPTION
Get TCP send flags.
PARAMETERS
send_flags_out - The flags to use will be stored here.
RETURN VALUE
On success globus_xio_data_descriptor_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_SET_SEND_FLAGS
SYNOPSIS
package require globus_xio
globus_xio_data_descriptor_cntl
dd
driver
GLOBUS_XIO_TCP_SET_SEND_FLAGS
send_flags
DESCRIPTION
Set TCP send flags. Used only for data descriptors to write calls.
PARAMETERS
send_flags - The flags to use when sending data.
RETURN VALUE
On success globus_xio_data_descriptor_cntl returns 0.
EXAMPLE
TBD
SEE ALSO
globus_xio/globus_xio_tcp_send_flags_t
ATTRIBUTES
GLOBUS_XIO_UDP_GET_CONTACT
SYNOPSIS
package require globus_xio
globus_xio_data_descriptor_cntl
dd
driver
GLOBUS_XIO_UDP_GET_CONTACT
DESCRIPTION
Get the contact string associated with a handle or data descriptor. Use with globus_xio_handle_cntl() to get a contact string for the UDP listener. Use with globus_xio_data_descriptor_cntl() to get the sender's contact string from a data descriptor passed to globus_xio_register_read().
PARAMETERS
contact_string_out - A pointer to a contact string will be stored here. The user should free() it when done with it. It will be in the format: <hostname>:<port>
RETURN VALUE
On success globus_xio_data_descriptor_cntl returns 0 and the contact_string_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_UDP_GET_NUMERIC_CONTACT
SYNOPSIS
package require globus_xio
globus_xio_data_descriptor_cntl
dd
driver
GLOBUS_XIO_UDP_GET_NUMERIC_CONTACT
DESCRIPTION
Get the contact string associated with a handle or data descriptor. Use with globus_xio_handle_cntl() to get a contact string for the UDP listener. Use with globus_xio_data_descriptor_cntl() to get the sender's contact string from a data descriptor passed to globus_xio_register_read().
PARAMETERS
contact_string_out - A pointer to a contact string will be stored here. The user should free() it when done with it. It will be in the format: <ip>:<port>.
RETURN VALUE
On success globus_xio_data_descriptor_cntl returns 0 and the contact_string_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_UDP_SET_CONTACT
SYNOPSIS
package require globus_xio
globus_xio_data_descriptor_cntl
handle
driver
GLOBUS_XIO_UDP_SET_CONTACT
contact_string
DESCRIPTION
Set the destination contact. Use on a data descriptor passed to globus_xio_register_write() to specify the recipient of the data. This is necessary with unconnected handles or to send to recipients other than the connected one.
PARAMETERS
contact_string - A pointer to a contact string of the format <hostname/ip>:<port/service>
RETURN VALUE
On success globus_xio_data_descriptor_cntl returns 0.
EXAMPLE
TBD
NAME
globus_xio_data_descriptor_destroy
SYNOPSIS
package require globus_xio
globus_xio_data_descriptor_destroy
data_desc
DESCRIPTION
This command is used to destroy a data descriptor.
RETURN VALUE
On success globus_xio_data_descriptor_destroy returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_xio_data_descriptor_destroy $data_desc ] result
BUGS
None
TODO
TCL sample script to illustrate how to use this command.
SEE ALSO
globus_xio_data_descriptor_init, globus_xio_data_descriptor_cntl
NAME
globus_xio_data_descriptor_init
SYNOPSIS
package require globus_xio
globus_xio_data_descriptor_init
handle
DESCRIPTION
This command is used to initialize a data descriptor.
RETURN VALUE
On success globus_xio_data_descriptor_init returns 0 and data descriptor used with the handle. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_xio_data_descriptor_init $handle ] result data_desc
BUGS
None
TODO
TCL sample script to illustrate how to use this command.
SEE ALSO
globus_xio_data_descriptor_destroy, globus_xio_data_descriptor_cntl
NAME
globus_xio_driver_load
SYNOPSIS
package require globus_xio
globus_xio_driver_load
driver_name
DESCRIPTION
This command is used to load a driver. In order to successfully use this command the user must know the name of all the drivers he/she wishes to load. Those drivers are "file", "gsi", "http", "mode_e", "tcp" or "udp".
RETURN VALUE
On success globus_xio_driver_load returns 0 and a driver object that can be pushed onto stack by calling globus_xio_stack_push_driver. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_xio_driver_load $driver_name ] result driver_object
BUGS
None
TODO
None
SEE ALSO
NAME
globus_xio_driver_unload
SYNOPSIS
package require globus_xio
globus_xio_driver_unload
driver_object
DESCRIPTION
This command is used to unload the driver_object.
RETURN VALUE
On success globus_xio_driver_unload returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_xio_driver_unload $driver_object ] result
BUGS
None
TODO
None
SEE ALSO
NAME
globus_xio_file_flag_t
DESCRIPTION
File driver open flags. OR together all the flags you want.
ATTRIBUTES
o GLOBUS_XIO_FILE_CREAT = O_CREAT - Create a new file if it doesn't exist (default).
o GLOBUS_XIO_FILE_EXCL = O_EXCL - Fail if file already exists.
o GLOBUS_XIO_FILE_RDONLY = O_RDONLY - Open for read only.
o GLOBUS_XIO_FILE_WRONLY = O_WRONLY - Open for write only.
o GLOBUS_XIO_FILE_RDWR = O_RDWR - Open for reading and writing (default).
o GLOBUS_XIO_FILE_TRUNC = O_TRUNC - Truncate file. See also globus_xio_attr_cntl/GLOBUS_XIO_FILE_SET_TRUNC_OFFSET.
o GLOBUS_XIO_FILE_APPEND = O_APPEND - Open file for appending.
o GLOBUS_XIO_FILE_BINARY = 0 - File is binary (default).
o GLOBUS_XIO_FILE_TEXT = 0 - File is text.
SEE ALSO
globus_xio_attr_cntl/GLOBUS_XIO_FILE_SET_FLAGS, globus_xio_attr_cntl/GLOBUS_XIO_FILE_SET_TRUNC_OFFSET
NAME
globus_xio_file_mode_t
DESCRIPTION
File driver create mode. OR these modes together to get the mode you want.
ATTRIBUTES
o GLOBUS_XIO_FILE_IRWXU - User read, write, and execute.
o GLOBUS_XIO_FILE_IRUSR - User read.
o GLOBUS_XIO_FILE_IWUSR - User write.
o GLOBUS_XIO_FILE_IXUSR - User execute.
o GLOBUS_XIO_FILE_IRWXG - Group read, write, and execute.
o GLOBUS_XIO_FILE_IRGRP - Group read.
o GLOBUS_XIO_FILE_IWGRP - Group write.
o GLOBUS_XIO_FILE_IXGRP - Group execute.
o GLOBUS_XIO_FILE_IRWXO - Others read, write, and execute.
o GLOBUS_XIO_FILE_IROTH - Others read.
o GLOBUS_XIO_FILE_IWOTH - Others write.
o GLOBUS_XIO_FILE_IXOTH - Others execute.
SEE ALSO
NAME
globus_xio_file_whence_t
DESCRIPTION
File driver seek options.
ATTRIBUTES
o GLOBUS_XIO_FILE_SEEK_SET = SEEK_SET - Set the file pointer at the specified offset.
o GLOBUS_XIO_FILE_SEEK_CUR = SEEK_CUR - Set the file pointer at current position + offset.
o GLOBUS_XIO_FILE_SEEK_END = SEEK_END - Set the file pointer at size of file + offest.
SEE ALSO
NAME
globus_xio_gsi_authorization_mode_t
DESCRIPTION
Globus XIO GSI authorization modes.
ATTRIBUTES
o GLOBUS_XIO_GSI_NO_AUTHORIZATION - Do not perform any authorization. This will cause a error when used in conjunction with delegation on the init/client side.
o GLOBUS_XIO_GSI_SELF_AUTHORIZATION - Authorize the peer if the peer has the same identity as ourselves.
o GLOBUS_XIO_GSI_IDENTITY_AUTHORIZATION - Authorize the peer if the peer identity matches the identity set in the target name. o GLOBUS_XIO_GSI_HOST_AUTHORIZATION - Authorize the peer if the identity of the peer matches the identity of the peer hostname.
SEE ALSO
globus_xio_attr_cntl/GLOBUS_XIO_GSI_SET_AUTHORIZATION_MODE, globus_xio_attr_cntl/GLOBUS_XIO_GSI_GET_AUTHORIZATION_MODE.
NAME
globus_xio_gsi_delegation_mode_t
DESCRIPTION
Globus XIO GSI delegation modes.
ATTRIBUTES
o GLOBUS_XIO_GSI_DELEGATION_MODE_NONE - No delegation.
o GLOBUS_XIO_GSI_DELEGATION_MODE_LIMITED - Delegate a limited proxy.
o GLOBUS_XIO_GSI_DELEGATION_MODE_FULL - Delegate a full proxy.
SEE ALSO
globus_xio_attr_cntl/GLOBUS_XIO_GSI_SET_DELEGATION_MODE, globus_xio_attr_cntl/GLOBUS_XIO_GSI_GET_DELEGATION_MODE.
NAME
globus_xio_gsi_protection_level_t
DESCRIPTION
Globus XIO GSI protection levels.
ATTRIBUTES
o GLOBUS_XIO_GSI_PROTECTION_LEVEL_NONE - No security.
o GLOBUS_XIO_GSI_PROTECTION_LEVEL_INTEGRITY - Messages are signed.
o GLOBUS_XIO_GSI_PROTECTION_LEVEL_PRIVACY - Messages are signed and encrypted.
SEE ALSO
globus_xio_attr_cntl/GLOBUS_XIO_GSI_SET_PROTECTION_LEVEL, globus_xio_attr_cntl/GLOBUS_XIO_GSI_GET_PROTECTION_LEVEL.
NAME
globus_xio_gsi_proxy_mode_t
DESCRIPTION
Globus XIO GSI proxy modes.
ATTRIBUTES
o GLOBUS_XIO_GSI_PROXY_MODE_FULL - Accept only full proxies.
o GLOBUS_XIO_GSI_PROXY_MODE_LIMITED - Accept full proxies and limited proxies if they are the only limited proxy in the cert chain.
o GLOBUS_XIO_GSI_PROXY_MODE_MANY - Accept both full and limited proxies unconditionally.
SEE ALSO
globus_xio_attr_cntl/GLOBUS_XIO_GSI_SET_PROXY_MODE, globus_xio_attr_cntl/GLOBUS_XIO_GSI_GET_PROXY_MODE.
NAME
globus_xio_handle_cntl
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
cmd
...
DESCRIPTION
This command allows the user to comunicate directly with a driver in association with a handle object. The driver defines what operations can be performed.
driver - This parameter indicates which driver the user would like to perform the requested operation. If this parameter is NULL this request will be scoped to general attribute functions.
cmd - An enum that determines what specific operation the user is requesting. Each driver will determine the value for this enumeration.
var args - These values are associated with the cmd values defined by the driver.
RETURN VALUE
On success globus_xio_handle_cntl returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
TBD
BUGS
None
TODO
TCL sample script to illustrate how to use this command.
SEE ALSO
ATTRIBUTES
GLOBUS_XIO_FILE_GET_HANDLE
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_FILE_GET_HANDLE
DESCRIPTION
Get the file handle in use or in attr.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and the file handle. If none is set, GLOBUS_XIO_TCP_INVALID_HANDLE will be set.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_FILE_SEEK
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_FILE_SEEK
whence
DESCRIPTION
Reposition read/write file offset.
PARAMETERS
whence - Specify how offset should be interpreted.
RETURN VALUE
On success globus_xio_attr_cntl returns 0 and the actual file offset.
EXAMPLE
TBD
SEE ALSO
ATTRIBUTES
GLOBUS_XIO_GSI_ACCEPT_DELEGATION
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_GSI_ACCEPT_DELEGATION
restriction_oids
restriction_buffers
time_req
DESCRIPTION
Accept delegation-at-any-time process.
restriction_buffers - The corresponding bodies for the X.509 extensions.
time_req - The lifetime of the delegated credential.
RETURN VALUE
On success globus_xio_handle_cntl returns 0 and the delegated GSS credential.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_GET_CONTEXT
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_GSI_GET_CONTEXT
DESCRIPTION
Get the GSS context.
RETURN VALUE
On success globus_xio_handle_cntl returns 0 and the GSS context.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_GET_CREDENTIAL
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_GSI_GET_CREDENTIAL
DESCRIPTION
Get the credential to be used
RETURN VALUE
On success globus_xio_handle_cntl returns 0 and a credential if a credential was explicitly set prior to this call. It will not return any credential automatically acquired during context initizalization.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_GET_DELEGATED_CRED
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_GSI_GET_DELEGATED_CRED
DESCRIPTION
Get the delegated credential.
RETURN VALUE
On success globus_xio_handle_cntl returns 0 and the delegated credential.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_GET_LOCAL_NAME
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_GSI_GET_LOCAL_NAME
DESCRIPTION
Get the GSS name associated with the local credentials.
RETURN VALUE
On success globus_xio_handle_cntl returns 0 and the GSS name of the local credentials.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_GET_PEER_NAME
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_GSI_GET_PEER_NAME
DESCRIPTION
Get the name of the peer.
RETURN VALUE
On success globus_xio_handle_cntl returns 0 and the GSS name of the peer.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_INIT_DELEGATION
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_GSI_INIT_DELEGATION
credential
restriction_oids
restriction_buffers
time_req
DESCRIPTION
Initialize delegation-at-any-time process
restriction_oids - The OIDS for X.509 extensions to embed in the delegated credential.
restriction_buffers - The corresponding bodies for the X.509 extensions.
time_req - The lifetime of the delegated credential.
RETURN VALUE
On success globus_xio_handle_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_REGISTER_ACCEPT_DELEGATION
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_GSI_REGISTER_ACCEPT_DELEGATION
restriction_oids
restriction_buffers
time_req
script
DESCRIPTION
Accept non-blocking delegation-at-any-time process.
restriction_oids - The OIDS for X.509 extensions to embed in the delegated credential.
restriction_buffers - The corresponding bodies for the X.509 extensions.
time_req - The lifetime of the delegated credential.
script - TCL script invoked once the operation completes. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_xio_handle_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_REGISTER_INIT_DELEGATION
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_GSI_REGISTER_INIT_DELEGATION
credential
restriction_oids
restriction_buffers
time_req
script
DESCRIPTION
Initialize non-blocking delegation-at-any-time process.
restriction_oids - The OIDS for X.509 extensions to embed in the delegated credential.
restriction_buffers - The corresponding bodies for the X.509 extensions.
time_req - The lifetime of the delegated credential.
script - TCL script invoked once the operation completes. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_xio_handle_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_GSI_SET_CREDENTIAL
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_GSI_SET_CREDENTIAL
credential
DESCRIPTION
Set the credential to be used. Note: If this is called with the handle_cntl, there must be no outstanding operations on the handle.
PARAMETERS
credential - The credential to set. The credential structure needs to remain valid for the lifetime of any XIO data structure it is used by.
RETURN VALUE
On success globus_xio_handle_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_GET_CONTACT
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_TCP_GET_CONTACT
DESCRIPTION
Get the contact string associated with a handle or data descriptor. Use with globus_xio_handle_cntl() to get a contact string for the UDP listener. Use with globus_xio_data_descriptor_cntl() to get the sender's contact string from a data descriptor passed to globus_xio_register_read().
PARAMETERS
contact_string_out - A pointer to a contact string will be stored here. The user should free() it when done with it. It will be in the format: <hostname>:<port>
RETURN VALUE
On success globus_xio_handle_cntl returns 0 and the contact_string_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_GET_HANDLE
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_TCP_GET_HANDLE
DESCRIPTION
Get the TCP socket handle on an attr, handle, or server.
PARAMETERS
handle_out - The TCP socket will be stored here. If none is set, GLOBUS_XIO_TCP_INVALID_HANDLE will be set.
RETURN VALUE
On success globus_xio_handle_cntl returns 0 and handle.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_GET_KEEPALIVE
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_TCP_GET_KEEPALIVE
DESCRIPTION
Get the TCP keepalive flag.
PARAMETERS
keepalive_out - The TCP keepalive flag will be stored here.
RETURN VALUE
On success globus_xio_handle_cntl returns 0 and keepalive_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_GET_LINGER
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_TCP_GET_LINGER
DESCRIPTION
Get the TCP linger flag and time.
PARAMETERS
linger_out - The linger flag will be stored here.
linger_time_out - The linger time will be set here.
RETURN VALUE
On success globus_xio_handle_cntl returns 0, linger_out and linger_time_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_GET_LOCAL_CONTACT
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_TCP_GET_LOCAL_CONTACT
DESCRIPTION
Get local socket info.
PARAMETERS
contact_string_out - A pointer to a contact string for the local end of a connected socket or listener will be stored here. The user should free() it when done with it. It will be in the format: <hostname>:<port>
RETURN VALUE
On success globus_xio_handle_cntl returns 0 and the contact_string_out.
EXAMPLE
TBD
SEE ALSO
ATTRIBUTES
GLOBUS_XIO_TCP_GET_LOCAL_NUMERIC_CONTACT
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_TCP_GET_LOCAL_NUMERIC_CONTACT
DESCRIPTION
Get local socket info.
PARAMETERS
contact_string_out - A pointer to a contact string for the local end of a connected socket or listener will be stored here. The user should free() it when done with it. It will be in the format: <ip>:<port>
RETURN VALUE
On success globus_xio_handle_cntl returns 0 and the contact_string_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_GET_NODELAY
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_TCP_GET_NODELAY
DESCRIPTION
Get the TCP nodelay flag.
PARAMETERS
nodelay_out - The no delay flag will be stored here.
RETURN VALUE
On success globus_xio_handle_cntl returns 0 and nodelay_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_GET_OOBINLINE
SYNOPSIS
package require globus_xio
globus_xio_attr_cntl
handle
driver
GLOBUS_XIO_TCP_GET_OOBINLINE
DESCRIPTION
Get the oobinline flag.
PARAMETERS
oobinline_out - The oobinline flag will be stored here.
RETURN VALUE
On success globus_xio_handle_cntl returns 0 and oobinline_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_GET_RCVBUF
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_TCP_GET_RCVBUF
DESCRIPTION
Get the TCP receive buffer size on the attr or handle.
PARAMETERS
rcvbuf_out - The receive buffer size will be stored here.
RETURN VALUE
On success globus_xio_handle_cntl returns 0 and rcvbuf_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_GET_REMOTE_CONTACT
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_TCP_GET_REMOTE_CONTACT
DESCRIPTION
Get remote socket info.
PARAMETERS
contact_string_out - A pointer to a contact string for the remote end of a connected socket will be stored here. The user should free() it when done with it. It will be in the format: <hostname>:<port>.
RETURN VALUE
On success globus_xio_handle_cntl returns 0 and the contact_string_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_GET_REMOTE_NUMERIC_CONTACT
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_TCP_GET_REMOTE_NUMERIC_CONTACT
DESCRIPTION
Get remote socket info.
PARAMETERS
contact_string_out - A pointer to a contact string for the remote end of a connected socket will be stored here. The user should free() it when done with it. It will be in the format: <ip>:<port>.
RETURN VALUE
On success globus_xio_handle_cntl returns 0 and the contact_string_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_GET_SNDBUF
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_TCP_GET_SNDBUF
DESCRIPTION
Get the TCP send buffer size on the attr or handle.
PARAMETERS
sndbuf_out - The send buffer size will be stored here.
RETURN VALUE
On success globus_xio_handle_cntl returns 0 and sndbuf_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_SET_KEEPALIVE
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_TCP_SET_KEEPALIVE
keepalive
DESCRIPTION
Enable TCP keepalive. Used on attrs for globus_xio_server_create(), globus_xio_register_open() and with globus_xio_handle_cntl() to determine whether or not to periodically send "keepalive" messages on a connected socket handle. This may enable earlier detection of broken connections.
PARAMETERS
keepalive - GLOBUS_TRUE to enable, GLOBUS_FALSE to disable (default).
RETURN VALUE
On success globus_xio_handle_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_SET_LINGER
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_TCP_SET_LINGER
linger
linger_time
DESCRIPTION
Set TCP linger. Used on attrs for globus_xio_server_create(), globus_xio_register_open() and with globus_xio_handle_cntl() 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. If this is enabled, any data remaining after the linger time has expired, will be discarded. If this is disabled, close finishes immediately, but the OS will still attempt to transmit the remaining data.
PARAMETERS
linger - GLOBUS_TRUE to enable, GLOBUS_FALSE to disable (default).
linger_time - The time (in seconds) to block at close time if linger is true and data is queued in the socket buffer.
RETURN VALUE
On success globus_xio_handle_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_SET_NODELAY
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_TCP_SET_NODELAY
nodelay
DESCRIPTION
Disable Nagle's algorithm. Used on attrs for globus_xio_server_create(), globus_xio_register_open() and with globus_xio_handle_cntl() to determine whether or not to disable Nagle's algorithm. If set to GLOBUS_TRUE, the socket will send packets as soon as possible with no unnecessary delays introduced.
PARAMETERS
nodelay - GLOBUS_TRUE to disable nagle, GLOBUS_FALSE to enable (default).
RETURN VALUE
On success globus_xio_handle_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_SET_OOBINLINE
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_TCP_SET_OOBINLINE
oobinline
DESCRIPTION
Receive out of band data (TCP urgent data) in normal stream. Used on attrs for globus_xio_server_create(), globus_xio_register_open() and with globus_xio_handle_cntl() to choose whether out-of-band data is received in the normal data queue. (Currently, there is no other way to receive OOB data).
PARAMETERS
oobinline - GLOBUS_TRUE to enable, GLOBUS_FALSE to disable (default).
RETURN VALUE
On success globus_xio_attr_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_SET_RCVBUF
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_TCP_SET_RCVBUF
rcvbuf
DESCRIPTION
Set the TCP socket receive buffer size. Used on attrs for globus_xio_server_create(), globus_xio_register_open() and with globus_xio_handle_cntl() to set the size of the receive buffer used on the socket. The receive buffer size is often used by the operating system to choose the appropriate TCP window size.
PARAMETERS
rcvbuf - The receive buffer size in bytes. (default is system specific).
RETURN VALUE
On success globus_xio_handle_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_SET_SNDBUF
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_TCP_SET_SNDBUF
sndbuf
DESCRIPTION
Set the TCP socket send buffer size. Used on attrs for globus_xio_server_create(), globus_xio_register_open() and with globus_xio_handle_cntl() to set the size of the send buffer used on the socket.
PARAMETERS
sndbuf - The send buffer size in bytes to use. (default is system specific).
RETURN VALUE
On success globus_xio_handle_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_UDP_CONNECT
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_UDP_CONNECT
contact_string
DESCRIPTION
Set the default destination contact. Connecting a handle to a specific contact blocks packets from any other contact. It also sets the default destination of all outgoing packets so, using GLOBUS_XIO_UDP_SET_CONTACT is unnecessary.
PARAMETERS
contact_string - A pointer to a contact string of the format <hostname/ip>:<port/service>
RETURN VALUE
On success globus_xio_handle_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_UDP_GET_HANDLE
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_UDP_GET_HANDLE
DESCRIPTION
Get the socket handle on an attr or handle.
PARAMETERS
handle_out - The UDP socket will be stored here. If none is set, GLOBUS_XIO_UDP_INVALID_HANDLE will be set.
RETURN VALUE
On success globus_xio_handle_cntl returns 0 and handle_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_UDP_GET_NUMERIC_CONTACT
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_UDP_GET_NUMERIC_CONTACT
DESCRIPTION
Get the contact string associated with a handle or data descriptor. Use with globus_xio_handle_cntl() to get a contact string for the UDP listener. Use with globus_xio_data_descriptor_cntl() to get the sender's contact string from a data descriptor passed to globus_xio_register_read().
PARAMETERS
contact_string_out - A pointer to a contact string will be stored here. The user should free() it when done with it. It will be in the format: <ip>:<port>.
RETURN VALUE
On success globus_xio_handle_cntl returns 0 and the contact_string_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_UDP_GET_RCVBUF
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_UDP_GET_RCVBUF
DESCRIPTION
Get the receive buffer size on the attr or handle.
PARAMETERS
rcvbuf_out - The receive buffer size will be stored here.
RETURN VALUE
On success globus_xio_handle_cntl returns 0 and rcvbuf_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_UDP_GET_SNDBUF
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_UDP_GET_SNDBUF
DESCRIPTION
Get the send buffer size on the attr or handle.
PARAMETERS
sndbuf_out - The send buffer size will be stored here.
RETURN VALUE
On success globus_xio_handle_cntl returns 0 and sndbuf_out.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_UDP_SET_RCVBUF
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_UDP_SET_RCVBUF
rcvbuf
DESCRIPTION
Set the socket receive buffer size. Used to set the size of the receive buffer used on the socket.
PARAMETERS
rcvbuf - The receive buffer size in bytes. (default is system specific).
RETURN VALUE
On success globus_xio_handle_cntl returns 0.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_UDP_SET_SNDBUF
SYNOPSIS
package require globus_xio
globus_xio_handle_cntl
handle
driver
GLOBUS_XIO_UDP_SET_SNDBUF
sndbuf
DESCRIPTION
Set the socket send buffer size. Used to set the size of the send buffer used on the socket.
PARAMETERS
sndbuf - The send buffer size in bytes to use. (default is system specific).
RETURN VALUE
On success globus_xio_handle_cntl returns 0.
EXAMPLE
TBD
NAME
globus_xio_handle_create
SYNOPSIS
package require globus_xio
globus_xio_handle_create
stack
DESCRIPTION
This command is used to initialize a handle for active opens (client-side connections).
RETURN VALUE
On success globus_xio_handle_create returns 0 and a handle. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_xio_handle_create $stack ] result handle
BUGS
None
TODO
None
SEE ALSO
NAME
globus_xio_open
SYNOPSIS
package require globus_xio
globus_xio_open
handle
contact_string
attr
DESCRIPTION
This command is used to create an open handle in blocking mode.
contact_string - This string represents the resources that the user wishes to contact.
attr - This attribute can be used to change the behavior of a handle and globus_xio_attr_cntl should precede the calling of this command in this case. This attribute can be NULL.
RETURN VALUE
On success globus_xio_open returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_xio_open $handle $contact_string $attr ] result
BUGS
None
TODO
None
SEE ALSO
globus_xio_close, globus_xio_handle_create, globus_xio_attr_cntl
NAME
globus_xio_read
SYNOPSIS
package require globus_xio
globus_xio_read
handle
buffer_length
waitforbytes
data_descriptor
DESCRIPTION
This command is used to script the reading of a block of data from a handle in blocking mode.
buffer_length - Maximum number of bytes to read.
waitforbytes - Minimum number of bytes to write before invoking the script.
data_descriptor - Globus XIO data descriptor as returned by globus_xio_data_descriptor_cntl. It can be NULL.
RETURN VALUE
On success globus_xio_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_xio_read $handle $buffer_length $waitforbytes $data_descriptor ] status buffer
BUGS
None
TODO
None
SEE ALSO
globus_xio_data_descriptor_cntl, globus_xio_handle_create, globus_xio_write
NAME
globus_xio_readv
SYNOPSIS
package require globus_xio
globus_xio_readv
handle
list_of_buffer_sizes
waitforbytes
data_descriptor
DESCRIPTION
This command is used to script the reading of a block of data from a handle and put the data into several buffers at once.
list_of_buffer_sizes - TCL list of buffer sizes.
waitforbytes - Minimum number of bytes to write before invoking the script.
data_descriptor - Globus XIO data descriptor as returned by globus_xio_data_descriptor_cntl. It can be NULL.
RETURN VALUE
On success globus_xio_readv returns 0 and puts the data into TCL buffers. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_xio_readv $handle [list $bufsize1 $bufsize2] $waitforbytes NULL ] status buf1 buf2
BUGS
None
TODO
None
SEE ALSO
globus_xio_data_descriptor_cntl, globus_xio_handle_create, globus_xio_writev
NAME
globus_xio_register_close
SYNOPSIS
package require globus_xio
globus_xio_register_close
handle
attr
callback_script
DESCRIPTION
This command is used to destroy for a handle in the background. As soon as the operation completes, the callback script is called.
attr - Globus XIO attributes as returned by globus_xio_attr_cntl and it determines how to close the handle. It can be NULL.
callback_script - TCL script invoked once the operation completes. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_xio_register_close returns 0. On error, this command will raise an error and must be caught using the appropriate bgerror mechanism.
EXAMPLE
lassign [ globus_xio_register_close $handle $attr [ subst { callback_proc user_arg } ] ] result
BUGS
None
TODO
None
SEE ALSO
NAME
globus_xio_register_open
SYNOPSIS
package require globus_xio
globus_xio_register_open
handle
contact_string
attr
script
DESCRIPTION
This command is used to script the opening of a handle based on the state contained in the given stack in the background. As soon as the operation completes, the script is called.
attr - Determine how to open the handle. It can be NULL.
script - TCL script invoked once the operation completes. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_xio_register_open returns 0. On error, this command will raise an error and must be caught using the appropriate bgerror mechanism.
EXAMPLE
lassign [ globus_xio_register_open $handle $contact_string $attr [ subst { callback user_arg } ] ] result
BUGS
None
TODO
None
SEE ALSO
NAME
globus_xio_register_read
SYNOPSIS
package require globus_xio
globus_xio_register_read
handle
buffer_length
waitforbytes
data_desc
script
DESCRIPTION
This command is used to script the reading of a block of data in the background.
buffer_length - Maximum number of bytes to read.
waitforbytes - Minimum number of bytes to read before invoking the script.
data_desc - To be initialized by globus_xio_data_descriptor_init. It can be NULL.
script - TCL script invoked to perform actual read. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_xio_register_read returns 0. On error, this command will raise an error and must be caught using the appropriate bgerror command.
EXAMPLE
lassign [ globus_xio_register_read $handle $buffer_length $waitforbytes $data_desc [ subst { callback user_arg } ] ] result
BUGS
None
TODO
None
SEE ALSO
globus_xio_data_descriptor_init, globus_xio_handle_create, globus_xio_register_write
NAME
globus_xio_register_readv
SYNOPSIS
package require globus_xio
globus_xio_register_readv
handle
list_of_buffer_size
waitforbytes
data_desc
script
DESCRIPTION
This command is used to script the reading of a block of data from several memory addresses at once in the background.
list_of_buffer_size - TCL list of buffer size
waitforbytes - Minimum number of bytes to read before invoking the script.
data_desc - To be initialized by globus_xio_data_descriptor_init. It can be NULL.
script - TCL script invoked to perform actual read. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_xio_register_readv returns 0. On error, this command will raise an error and must be caught using the appropriate bgerror command.
EXAMPLE
lassign [ globus_xio_register_readv $handle [list $bufsize1 $bufsize2] $waitforbytes $data_desc [ subst { callback_proc $user_arg } ] ] result
BUGS
None
TODO
None
SEE ALSO
globus_xio_data_descriptor_init, globus_xio_handle_create, globus_xio_register_writev
NAME
globus_xio_register_write
SYNOPSIS
package require globus_xio
globus_xio_register_write
handle
buffer
waitforbytes
data_descriptor
callback_script
DESCRIPTION
This command is used to script the writing of a block of data to a handle in the background.
buffer - Buffer to write.
waitforbytes - Minimum number of bytes to write before invoking the script.
data_desc - To be initialized by globus_xio_data_descriptor_init. It can be NULL.
script - TCL script invoked to perform actual write. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_xio_register_write returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_xio_register_write $handle $buffer $waitforbytes $data_desc [ subst { callback_proc $user_arg } ] ] result
BUGS
None
TODO
None
SEE ALSO
globus_xio_data_descriptor_init, globus_xio_handle_create, globus_xio_register_read
NAME
globus_xio_register_writev
SYNOPSIS
package require globus_xio
globus_xio_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 several memory addresses at once in the background.
list_of_buffer_size - TCL list of buffer
waitforbytes - Minimum number of bytes to read before invoking the script.
data_desc - To be initialized by globus_xio_data_descriptor_init. It can be NULL.
script - TCL script invoked to perform actual write. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
EXAMPLE
lassign [ globus_xio_register_writev $handle [list $buffer1 $buffer2] $waitforbytes $data_desc [ subst { callback_proc $user_arg } ] ] result
BUGS
None
TODO
None
SEE ALSO
globus_xio_data_descriptor_init, globus_xio_handle_create, globus_xio_register_readv
NAME
globus_xio_server_accept
SYNOPSIS
package require globus_xio
globus_xio_server_accept
server_object
DESCRIPTION
This command is usde to accept a connection on the given server object.
RETURN VALUE
On success globus_xio_server_close returns 0 and a server handle. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_xio_server_accept $server_object ] result server_handle
BUGS
None
TODO
TCL sample script to illustrate how to use this command.
SEE ALSO
NAME
globus_xio_server_close
SYNOPSIS
package require globus_xio
globus_xio_server_close
server_object
DESCRIPTION
This command is used to post a blocking server close.
RETURN VALUE
On success globus_xio_server_close returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_xio_server_close $server_object ] result
BUGS
None
TODO
None
SEE ALSO
NAME
globus_xio_server_cntl
SYNOPSIS
package require globus_xio
globus_xio_server_cntl
server
driver
cmd
...
DESCRIPTION
This command allows the user to comunicate directly with a driver in association with a server object. The driver defines what operations can be performed.
driver - This parameter indicates which driver the user would like to perform the requested operation.
cmd - An enum that determines what specific operation the user is requesting. Each driver will determine the value for this enumeration.
var args - These values are associated with the cmd values defined by the driver.
RETURN VALUE
On success globus_xio_server_cntl returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
TBD
BUGS
None
TODO
TCL sample script to illustrate how to use this command.
SEE ALSO
ATTRIBUTES
GLOBUS_XIO_TCP_GET_HANDLE
SYNOPSIS
package require globus_xio
globus_xio_server_cntl
server
driver
GLOBUS_XIO_TCP_GET_HANDLE
DESCRIPTION
Get the TCP socket handle on an attr, handle, or server.
PARAMETERS
handle_out - The TCP socket will be stored here. If none is set, GLOBUS_XIO_TCP_INVALID_HANDLE will be set.
RETURN VALUE
On success globus_xio_server_cntl returns 0 and handle.
EXAMPLE
TBD
ATTRIBUTES
GLOBUS_XIO_TCP_GET_LOCAL_CONTACT
SYNOPSIS
package require globus_xio
globus_xio_server_cntl
server
driver
GLOBUS_XIO_TCP_GET_LOCAL_CONTACT
DESCRIPTION
Get local socket info.
PARAMETERS
contact_string_out - A pointer to a contact string for the local end of a connected socket or listener will be stored here. The user should free() it when done with it. It will be in the format: <hostname>:<port>
RETURN VALUE
On success globus_xio_server_cntl returns 0 and the contact_string_out.
EXAMPLE
TBD
SEE ALSO
ATTRIBUTES
GLOBUS_XIO_TCP_GET_LOCAL_NUMERIC_CONTACT
SYNOPSIS
package require globus_xio
globus_xio_server_cntl
server
driver
GLOBUS_XIO_TCP_GET_LOCAL_NUMERIC_CONTACT
DESCRIPTION
Get local socket info.
PARAMETERS
contact_string_out - A pointer to a contact string for the local end of a connected socket or listener will be stored here. The user should free() it when done with it. It will be in the format: <ip>:<port>
RETURN VALUE
On success globus_xio_server_cntl returns 0 and the contact_string_out.
EXAMPLE
TBD
NAME
globus_xio_server_create
SYNOPSIS
package require globus_xio
globus_xio_server_create
attr
stack
DESCRIPTION
This command is used to create a server object which can then be used to accept connections.
stack - Globus XIO stack as returned by globus_xio_stack_init
RETURN VALUE
On success globus_xio_server_create returns 0 and a server object. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_xio_server_create $attr $stack ] result server_obj
BUGS
None
TODO
None
SEE ALSO
globus_xio_server_register_accept, globus_xio_server_get_contact_string
NAME
globus_xio_server_get_contact_string
SYNOPSIS
package require globus_xio
globus_xio_server_get_contact_string
server_obj
DESCRIPTION
This command is used to get contact string for a server.
RETURN VALUE
On success globus_xio_server_get_contact_string returns 0 and a string containing contact_string information. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_xio_server_get_contact_string $server_obj ] result contact_string
BUGS
None
TODO
None
SEE ALSO
NAME
globus_xio_server_register_accept
SYNOPSIS
package require globus_xio
globus_xio_server_register_accept
server_obj
script
DESCRIPTION
This command is used to post asynchronous accept. Once the operation has completed the script will be called.
script - TCL script invoked after the operation has been completed. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_xio_server_register_accept returns 0. On error, this command will raise an error and must be caught using the appropriate bgerror command.
EXAMPLE
lassign [ globus_xio_server_register_accept $server_obj { callback_proc $user_arg } ] result
BUGS
None
TODO
None
SEE ALSO
globus_xio_server_create, globus_xio_server_get_contact_string, globus_xio_server_register_close
NAME
globus_xio_server_register_close
SYNOPSIS
package require globus_xio
globus_xio_server_register_close
server_obj
script
DESCRIPTION
This command is used to post asynchronous close to a server_obj. Once the operation has completed the script will be called.
script - TCL script invoked after the operation has been completed. The command will be executed exactly once in global scope. If an error occurs while executing the command, then the bgerror mechanism is used to report the error.
RETURN VALUE
On success globus_xio_server_register_close returns 0. On error, this command will raise an error and must be caught using the appropriate bgerror command.
EXAMPLE
lassign [ globus_xio_server_register_close $server_obj { callback_proc $user_arg } ] result
BUGS
None
TODO
TCL sample script to illustrate how to use this command.
SEE ALSO
globus_xio_server_create, globus_xio_server_register_accept, globus_xio_server_get_contact_string
NAME
globus_xio_stack_destroy
SYNOPSIS
package require globus_xio
globus_xio_stack_destroy
stack
DESCRIPTION
This command is used to destroy a stack object.
RETURN VALUE
On success globus_xio_stack_destroy returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_xio_stack_destroy $stack ] result
BUGS
None
TODO
None
SEE ALSO
NAME
globus_xio_stack_init
SYNOPSIS
package require globus_xio
globus_xio_stack_init
stack
stack_attr
DESCRIPTION
This command is used to initialize a stack object.
stack_attr -
RETURN VALUE
On success globus_xio_stack_init returns 0 and the stack object. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_xio_stack_init $stack_attr ] result stack
BUGS
None
TODO
None
SEE ALSO
NAME
globus_xio_stack_push_driver
SYNOPSIS
package require globus_xio
globus_xio_stack_push_driver
stack
driver
DESCRIPTION
This command is used to push a driver onto a stack.
driver - The driver object.
RETURN VALUE
On success globus_xio_stack_push_driver returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.
EXAMPLE
lassign [ globus_xio_stack_push_driver $stack $driver] result
BUGS
None
TODO
None
SEE ALSO
NAME
globus_xio_tcp_send_flags_t
DESCRIPTION
TCP driver specific types.
ATTRIBUTES
o GLOBUS_XIO_TCP_SEND_OOB - Use this with GLOBUS_XIO_TCP_SET_SEND_FLAGS to send a TCP message out of band (Urgent data flag set).
SEE ALSO
globus_xio_data_descriptor_cntl/GLOBUS_XIO_TCP_SET_SEND_FLAGS
NAME
globus_xio_write
SYNOPSIS
package require globus_xio
globus_xio_write
handle
buffer
waitforbytes
data_desc
DESCRIPTION
This command is used to script the writing of a block of data in blocking mode.
buffer - Buffer to write.
waitforbytes - Minimum number of bytes to write before invoking the script.
data_desc - To be initialized by globus_xio_data_descriptor_init.
RESULT On success globus_xio_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_xio_write $handle $buffer $waitforbytes NULL ] status nbytes
BUGS
None
TODO
None
SEE ALSO
globus_xio_data_descriptor_init, globus_xio_handle_create, globus_xio_read
NAME
globus_xio_writev
SYNOPSIS
package require globus_xio
globus_xio_writev
handle
list_of_buffers
waitforbytes
data_desc
DESCRIPTION
This command is used to script the writing of a block of data to several memory addresses at once.
list_of_buffers - TCL list of data buffers.
waitforbytes - Minimum number of bytes to write before invoking the script.
data_desc - To be initialized by globus_xio_data_descriptor_init.
RETURN VALUE
On success globus_xio_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_xio_writev $handle [list $buf1 $buf2] $waitforbytes NULL ] status nbytes
BUGS
None
TODO
None
SEE ALSO
globus_xio_data_descriptor_init, globus_xio_handle_create, globus_xio_readv