Function Documentation

This function provides a means to access the attr structure. What exactly this function 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 function applies to general Globus XIO values. If it is not NULL it indicates that the function 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.

Parameters:

attr the attribute structure to be manipulated.

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.

globus_result_t globus_xio_attr_destroy (globus_xio_attr_tattr)

attr Upon completion of this function all resources associated with this structure will returned to the system and the attr will no longer be valid.

globus_result_t globus_xio_attr_init (globus_xio_attr_t *attr)

Initialize a Globus XIO attribute.

Parameters:

attr upon return from this function this out parameter will be initialized. Once the user is finished with the attribute they should make sure they destroy it in order to free resources associated with it.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Get local connection info.

@param contact_string_out
A pointer to a contact string for the local end of a connected
handle. Where possible, it will be in symbolic form (FQDN).
The user must free the returned string.
@see globus_xio_server_get_contact_string().fi

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Set the driver specific configuration string. The format of the string is defined by the driver. It is typically a set of key=value pairs

out_h An uninitialized handle that will be initialized in the function to correspond to the scheme given. This handle should be used for any I/O operations.

scheme A string containing the protocol which the handle should be initialized to. The string can either be a protocol by itself, for example, 'http', or a complete scheme such as 'http://www.example.com'.

attr Attribute to be used for setting parameter string. It is initialized by the function. Can be NULL if attributes are not being used.

param_string A string containing attributes to be set for the drivers associated with the scheme. This should be in the form 'protocol1:option1=value1;option2=value2,protocol2:option1=value1;

Creates an open handle based on the state contained in the given stack.

No operation can be preformed on a handle until it is initialized and then opened. If an already open handle used the information contained in that handle will be destroyed.

Parameters:

handle The handle created with globus_xio_handle_create() or globus_xio_server_register_accept() that is to be opened.

attr how to open attribute. can be NULL

cb The function to be called when the open operation completes.

user_arg A user pointer that will be threaded through to the callback.

contact_string An url describing the resource. NULL is allowed. Drivers interpret the various parts of this url as described in their documentation. An alternative form is also supported: if contact_string does not specify a scheme (e.g. http://) and it contains a ':', it will be parsed as a host:port pair. if it does not contain a ':', it will be parsed as the path