Section 3: library functions
Env Variables – The mode_e driver uses the following environment variable • GLOBUS_XIO_MODE_E_DEBUG Available if using a debug build. See globus_debug.h for format.AuthorGenerated automatically by Doxygen for globus_xio from the source code.
Attributes and Cntls – Enumerationsenum globus_xio_mode_e_cmd_t { GLOBUS_XIO_MODE_E_SET_STACK, GLOBUS_XIO_MODE_E_GET_STACK, GLOBUS_XIO_MODE_E_SET_NUM_STREAMS, GLOBUS_XIO_MODE_E_GET_NUM_STREAMS, GLOBUS_XIO_MODE_E_SET_OFFSET_READS, GLOBUS_XIO_MODE_E_GET_OFFSET_READS, GLOBUS_XIO_MODE_E_SET_MANUAL_EODC, GLOBUS_XIO_MODE_E_GET_MANUAL_EODC, GLOBUS_XIO_MODE_E_SEND_EOD, GLOBUS_XIO_MODE_E_SET_EODC, GLOBUS_XIO_MODE_E_DD_GET_OFFSET, GLOBUS_XIO_MODE_E_SET_STACK_ATTR, GLOBUS_XIO_MODE_E_GET_STACK_ATTR } Functionsglobus_result_t globus_xio_attr_cntl (attr, driver, GLOBUS_XIO_MODE_E_SET_STACK, globus_xio_stack_t stack) globus_result_t globus_xio_attr_cntl (attr, driver, GLOBUS_XIO_MODE_E_GET_STACK, globus_xio_stack_t *stack_out) globus_result_t globus_xio_attr_cntl (attr, driver, GLOBUS_XIO_MODE_E_SET_NUM_STREAMS, int num_streams) globus_result_t globus_xio_attr_cntl (attr, driver, GLOBUS_XIO_MODE_E_GET_NUM_STREAMS, int *num_streams_out) globus_result_t globus_xio_attr_cntl (attr, driver, GLOBUS_XIO_MODE_E_SET_OFFSET_READS, globus_bool_t…
Globus XIO MODE_E Driver – ModulesOpening/Closing Reading/Writing Server Env Variables Attributes and Cntls Types Error Types Detailed DescriptionAuthorGenerated automatically by Doxygen for globus_xio from the source code.
builtins/mode_e/globus_xio_mode_e_driver.h – XIO MODE_E Driver. Synopsis#include ‘globus_common.h’ Enumerationsenum globus_xio_mode_e_error_type_t { GLOBUS_XIO_MODE_E_HEADER_ERROR } enum globus_xio_mode_e_cmd_t { GLOBUS_XIO_MODE_E_SET_STACK, GLOBUS_XIO_MODE_E_GET_STACK, GLOBUS_XIO_MODE_E_SET_NUM_STREAMS, GLOBUS_XIO_MODE_E_GET_NUM_STREAMS, GLOBUS_XIO_MODE_E_SET_OFFSET_READS, GLOBUS_XIO_MODE_E_GET_OFFSET_READS, GLOBUS_XIO_MODE_E_SET_MANUAL_EODC, GLOBUS_XIO_MODE_E_GET_MANUAL_EODC, GLOBUS_XIO_MODE_E_SEND_EOD, GLOBUS_XIO_MODE_E_SET_EODC, GLOBUS_XIO_MODE_E_DD_GET_OFFSET, GLOBUS_XIO_MODE_E_SET_STACK_ATTR, GLOBUS_XIO_MODE_E_GET_STACK_ATTR } Functionsglobus_result_t globus_xio_attr_cntl (attr, driver, GLOBUS_XIO_MODE_E_SET_STACK, globus_xio_stack_t stack) globus_result_t globus_xio_attr_cntl (attr, driver, GLOBUS_XIO_MODE_E_GET_STACK, globus_xio_stack_t *stack_out) globus_result_t globus_xio_attr_cntl (attr, driver, GLOBUS_XIO_MODE_E_SET_NUM_STREAMS, int num_streams) globus_result_t globus_xio_attr_cntl (attr, driver, GLOBUS_XIO_MODE_E_GET_NUM_STREAMS,…
Attributes and Cntls – Enumerationsenum globus_xio_mode_e_cmd_t { GLOBUS_XIO_MODE_E_SET_STACK, GLOBUS_XIO_MODE_E_GET_STACK, GLOBUS_XIO_MODE_E_SET_NUM_STREAMS, GLOBUS_XIO_MODE_E_GET_NUM_STREAMS, GLOBUS_XIO_MODE_E_SET_OFFSET_READS, GLOBUS_XIO_MODE_E_GET_OFFSET_READS, GLOBUS_XIO_MODE_E_SET_MANUAL_EODC, GLOBUS_XIO_MODE_E_GET_MANUAL_EODC, GLOBUS_XIO_MODE_E_SEND_EOD, GLOBUS_XIO_MODE_E_SET_EODC, GLOBUS_XIO_MODE_E_DD_GET_OFFSET, GLOBUS_XIO_MODE_E_SET_STACK_ATTR, GLOBUS_XIO_MODE_E_GET_STACK_ATTR } Functionsglobus_result_t globus_xio_attr_cntl (attr, driver, GLOBUS_XIO_MODE_E_SET_STACK, globus_xio_stack_t stack) globus_result_t globus_xio_attr_cntl (attr, driver, GLOBUS_XIO_MODE_E_GET_STACK, globus_xio_stack_t *stack_out) globus_result_t globus_xio_attr_cntl (attr, driver, GLOBUS_XIO_MODE_E_SET_NUM_STREAMS, int num_streams) globus_result_t globus_xio_attr_cntl (attr, driver, GLOBUS_XIO_MODE_E_GET_NUM_STREAMS, int *num_streams_out) globus_result_t globus_xio_attr_cntl (attr, driver, GLOBUS_XIO_MODE_E_SET_OFFSET_READS, globus_bool_t…
Globus XIO API – Typedefstypedef void(* globus_xio_accept_callback_t )(globus_xio_server_t server, globus_xio_handle_t handle, globus_result_t result, void *user_arg) typedef void(* globus_xio_server_callback_t )(globus_xio_server_t server, void *user_arg) typedef globus_bool_t(* globus_xio_timeout_callback_t )(globus_xio_handle_t handle, globus_xio_operation_type_t type, void *user_arg) typedef void(* globus_xio_callback_t )(globus_xio_handle_t handle, globus_result_t result, void *user_arg) typedef void(* globus_xio_data_callback_t )(globus_xio_handle_t handle, globus_result_t result, globus_byte_t *buffer, globus_size_t len, globus_size_t nbytes, globus_xio_data_descriptor_t data_desc,…
Globus XIO HTTP Driver – ModulesOpening/Closing Reading/Writing Server Attributes and Cntls Error Types Data Structuresstruct globus_xio_http_header_t HTTP Header. Enumerationsenum globus_xio_http_version_t { , GLOBUS_XIO_HTTP_VERSION_1_0, GLOBUS_XIO_HTTP_VERSION_1_1 } Detailed DescriptionThis driver implements the HTTP/1.0 and HTTP/1.1 protocols within the Globus XIO framework. It may be used with the tcp driver for the standard HTTP protocol stack, or may…
globus_xio_http_header_t – HTTP Header. Synopsis#include <globus_xio_http.h> Data Fieldschar * name char * value Detailed DescriptionHTTP Header. doxygen varargs filter stuff Field Documentationchar* globus_xio_http_header_t::nameHeader Name char* globus_xio_http_header_t::valueHeader Value AuthorGenerated automatically by Doxygen for globus_xio from the source code.
Attributes and Cntls – Enumerationsenum globus_xio_http_handle_cmd_t { GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_HEADER, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_STATUS_CODE, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_REASON_PHRASE, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_HTTP_VERSION, GLOBUS_XIO_HTTP_HANDLE_SET_END_OF_ENTITY } enum globus_xio_http_attr_cmd_t { GLOBUS_XIO_HTTP_ATTR_SET_REQUEST_METHOD, GLOBUS_XIO_HTTP_ATTR_SET_REQUEST_HTTP_VERSION, GLOBUS_XIO_HTTP_ATTR_SET_REQUEST_HEADER, GLOBUS_XIO_HTTP_ATTR_DELAY_WRITE_HEADER, GLOBUS_XIO_HTTP_GET_REQUEST, GLOBUS_XIO_HTTP_GET_RESPONSE } Functionsglobus_result_t globus_xio_handle_cntl (handle, driver, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_HEADER, const char *header_name, const char *header_value) globus_result_t globus_xio_handle_cntl (handle, driver, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_STATUS_CODE, int status) globus_result_t globus_xio_handle_cntl (handle, driver, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_REASON_PHRASE, const char *reason) globus_result_t globus_xio_handle_cntl (handle, driver, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_HTTP_VERSION, globus_xio_http_version_t…
Error Types – Enumerationsenum globus_xio_http_errors_t { GLOBUS_XIO_HTTP_ERROR_INVALID_HEADER, GLOBUS_XIO_HTTP_ERROR_PARSE, GLOBUS_XIO_HTTP_ERROR_NO_ENTITY, GLOBUS_XIO_HTTP_ERROR_EOF, GLOBUS_XIO_HTTP_ERROR_PERSISTENT_CONNECTION_DROPPED } Detailed DescriptionIn addition to errors generated by underlying protocol drivers, the XIO HTTP driver defines a few error conditions specific to the HTTP protocol. See Also: globus_xio_driver_error_match()Enumeration Type Documentationenum globus_xio_http_errors_tError types used to generate errors using the globus_error_generic module. Enumerator GLOBUS_XIO_HTTP_ERROR_INVALID_HEADER An attempt…
Server – The globus_xio_server_create() causes a new transport-specific listener socket to be created to handle new HTTP connections. globus_xio_server_register_accept() will accept a new connection for processing. globus_xio_server_register_close() cleans up the internal resources associated with the http server and calls close on the listener. Multiple HTTP requests may be read in sequence from an HTTP server….
Reading/Writing – The HTTP driver behaves similar to the underlying transport driver with respect to reads and writes with the exception that metadata must be passed to the handle via open attributes on the client side and will be received as data descriptors as part of the first request read or response read. AuthorGenerated automatically…
Opening/Closing – An XIO handle with the http driver can be created with either globus_xio_handle_create() or globus_xio_server_register_accept(). If the handle is created with globus_xio_server_register_accept(), then an HTTP service handle will be created when globus_xio_register_open() is called. The XIO application must call one of the functions in the globus_xio_read() family to receive the HTTP request metadata….
Error Types – Enumerationsenum globus_xio_http_errors_t { GLOBUS_XIO_HTTP_ERROR_INVALID_HEADER, GLOBUS_XIO_HTTP_ERROR_PARSE, GLOBUS_XIO_HTTP_ERROR_NO_ENTITY, GLOBUS_XIO_HTTP_ERROR_EOF, GLOBUS_XIO_HTTP_ERROR_PERSISTENT_CONNECTION_DROPPED } Detailed DescriptionIn addition to errors generated by underlying protocol drivers, the XIO HTTP driver defines a few error conditions specific to the HTTP protocol. See Also: globus_xio_driver_error_match()Enumeration Type Documentationenum globus_xio_http_errors_tError types used to generate errors using the globus_error_generic module. Enumerator GLOBUS_XIO_HTTP_ERROR_INVALID_HEADER An attempt…
Attributes and Cntls – Enumerationsenum globus_xio_http_handle_cmd_t { GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_HEADER, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_STATUS_CODE, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_REASON_PHRASE, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_HTTP_VERSION, GLOBUS_XIO_HTTP_HANDLE_SET_END_OF_ENTITY } enum globus_xio_http_attr_cmd_t { GLOBUS_XIO_HTTP_ATTR_SET_REQUEST_METHOD, GLOBUS_XIO_HTTP_ATTR_SET_REQUEST_HTTP_VERSION, GLOBUS_XIO_HTTP_ATTR_SET_REQUEST_HEADER, GLOBUS_XIO_HTTP_ATTR_DELAY_WRITE_HEADER, GLOBUS_XIO_HTTP_GET_REQUEST, GLOBUS_XIO_HTTP_GET_RESPONSE } Functionsglobus_result_t globus_xio_handle_cntl (handle, driver, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_HEADER, const char *header_name, const char *header_value) globus_result_t globus_xio_handle_cntl (handle, driver, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_STATUS_CODE, int status) globus_result_t globus_xio_handle_cntl (handle, driver, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_REASON_PHRASE, const char *reason) globus_result_t globus_xio_handle_cntl (handle, driver, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_HTTP_VERSION, globus_xio_http_version_t…
Globus XIO HTTP Driver – ModulesOpening/Closing Reading/Writing Server Attributes and Cntls Error Types Data Structuresstruct globus_xio_http_header_t HTTP Header. Enumerationsenum globus_xio_http_version_t { , GLOBUS_XIO_HTTP_VERSION_1_0, GLOBUS_XIO_HTTP_VERSION_1_1 } Detailed DescriptionThis driver implements the HTTP/1.0 and HTTP/1.1 protocols within the Globus XIO framework. It may be used with the tcp driver for the standard HTTP protocol stack, or may…
Attributes and Cntls – Enumerationsenum globus_xio_http_handle_cmd_t { GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_HEADER, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_STATUS_CODE, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_REASON_PHRASE, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_HTTP_VERSION, GLOBUS_XIO_HTTP_HANDLE_SET_END_OF_ENTITY } enum globus_xio_http_attr_cmd_t { GLOBUS_XIO_HTTP_ATTR_SET_REQUEST_METHOD, GLOBUS_XIO_HTTP_ATTR_SET_REQUEST_HTTP_VERSION, GLOBUS_XIO_HTTP_ATTR_SET_REQUEST_HEADER, GLOBUS_XIO_HTTP_ATTR_DELAY_WRITE_HEADER, GLOBUS_XIO_HTTP_GET_REQUEST, GLOBUS_XIO_HTTP_GET_RESPONSE } Functionsglobus_result_t globus_xio_handle_cntl (handle, driver, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_HEADER, const char *header_name, const char *header_value) globus_result_t globus_xio_handle_cntl (handle, driver, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_STATUS_CODE, int status) globus_result_t globus_xio_handle_cntl (handle, driver, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_REASON_PHRASE, const char *reason) globus_result_t globus_xio_handle_cntl (handle, driver, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_HTTP_VERSION, globus_xio_http_version_t…
globus_xio_http.h – Globus XIO HTTP Driver Header. SynopsisData Structuresstruct globus_xio_http_header_t doxygen varargs filter stuff Enumerationsenum globus_xio_http_handle_cmd_t { GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_HEADER, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_STATUS_CODE, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_REASON_PHRASE, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_HTTP_VERSION, GLOBUS_XIO_HTTP_HANDLE_SET_END_OF_ENTITY } enum globus_xio_http_attr_cmd_t { GLOBUS_XIO_HTTP_ATTR_SET_REQUEST_METHOD, GLOBUS_XIO_HTTP_ATTR_SET_REQUEST_HTTP_VERSION, GLOBUS_XIO_HTTP_ATTR_SET_REQUEST_HEADER, GLOBUS_XIO_HTTP_ATTR_DELAY_WRITE_HEADER, GLOBUS_XIO_HTTP_GET_REQUEST, GLOBUS_XIO_HTTP_GET_RESPONSE } enum globus_xio_http_errors_t { GLOBUS_XIO_HTTP_ERROR_INVALID_HEADER, GLOBUS_XIO_HTTP_ERROR_PARSE, GLOBUS_XIO_HTTP_ERROR_NO_ENTITY, GLOBUS_XIO_HTTP_ERROR_EOF, GLOBUS_XIO_HTTP_ERROR_PERSISTENT_CONNECTION_DROPPED } enum globus_xio_http_version_t { , GLOBUS_XIO_HTTP_VERSION_1_0, GLOBUS_XIO_HTTP_VERSION_1_1 } Functionsglobus_result_t globus_xio_handle_cntl (handle, driver, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_HEADER, const…
builtins/http/globus_xio_http.h – Globus XIO HTTP Driver Header. Synopsis#include ‘globus_xio.h’ Data Structuresstruct globus_xio_http_header_t HTTP Header. Enumerationsenum globus_xio_http_handle_cmd_t { GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_HEADER, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_STATUS_CODE, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_REASON_PHRASE, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_HTTP_VERSION, GLOBUS_XIO_HTTP_HANDLE_SET_END_OF_ENTITY } enum globus_xio_http_attr_cmd_t { GLOBUS_XIO_HTTP_ATTR_SET_REQUEST_METHOD, GLOBUS_XIO_HTTP_ATTR_SET_REQUEST_HTTP_VERSION, GLOBUS_XIO_HTTP_ATTR_SET_REQUEST_HEADER, GLOBUS_XIO_HTTP_ATTR_DELAY_WRITE_HEADER, GLOBUS_XIO_HTTP_GET_REQUEST, GLOBUS_XIO_HTTP_GET_RESPONSE } enum globus_xio_http_errors_t { GLOBUS_XIO_HTTP_ERROR_INVALID_HEADER, GLOBUS_XIO_HTTP_ERROR_PARSE, GLOBUS_XIO_HTTP_ERROR_NO_ENTITY, GLOBUS_XIO_HTTP_ERROR_EOF, GLOBUS_XIO_HTTP_ERROR_PERSISTENT_CONNECTION_DROPPED } enum globus_xio_http_version_t { , GLOBUS_XIO_HTTP_VERSION_1_0, GLOBUS_XIO_HTTP_VERSION_1_1 } Functionsglobus_result_t globus_xio_handle_cntl (handle, driver, GLOBUS_XIO_HTTP_HANDLE_SET_RESPONSE_HEADER, const…
Globus XIO API – Typedefstypedef void(* globus_xio_accept_callback_t )(globus_xio_server_t server, globus_xio_handle_t handle, globus_result_t result, void *user_arg) typedef void(* globus_xio_server_callback_t )(globus_xio_server_t server, void *user_arg) typedef globus_bool_t(* globus_xio_timeout_callback_t )(globus_xio_handle_t handle, globus_xio_operation_type_t type, void *user_arg) typedef void(* globus_xio_callback_t )(globus_xio_handle_t handle, globus_result_t result, void *user_arg) typedef void(* globus_xio_data_callback_t )(globus_xio_handle_t handle, globus_result_t result, globus_byte_t *buffer, globus_size_t len, globus_size_t nbytes, globus_xio_data_descriptor_t data_desc,…