| globus_xio_http_driver_cntls(3) | globus_xio | globus_xio_http_driver_cntls(3) |
globus_xio_http_driver_cntls - Attributes and Cntls.
enum 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 }
globus_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 version)
globus_result_t globus_xio_handle_cntl (handle, driver,
GLOBUS_XIO_HTTP_HANDLE_SET_END_OF_ENTITY)
globus_result_t globus_xio_attr_cntl (attr, driver,
GLOBUS_XIO_HTTP_ATTR_SET_REQUEST_METHOD, const char *method)
globus_result_t globus_xio_attr_cntl (attr, driver,
GLOBUS_XIO_HTTP_ATTR_SET_REQUEST_HTTP_VERSION,
globus_xio_http_version_t version)
globus_result_t globus_xio_attr_cntl (attr, driver,
GLOBUS_XIO_HTTP_ATTR_SET_REQUEST_HEADER, const char *header_name,
const char *header_value)
Attributes and Cntls.
HTTP driver specific attrs and cntls.
See also:
globus_xio_handle_cntl()
HTTP driver specific attribute and data descriptor cntls
Enumerator
HTTP driver specific cntls
Enumerator
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Set the HTTP method to use for a client request.
Parameters:
If this is not set on the target before it is opened, it will default to GET.
This attribute is ignored when opening the server side of an HTTP connection.
Setting this attribute may fail with
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Set the HTTP version to use for a client request.
Parameters:
If the client is using HTTP/1.0 in a request which will send a request message body (such as a POST or PUT), then the client MUST set the 'Content-Length' HTTP header to be the length of the message. If this attribute is not present, then the default of GLOBUS_XIO_HTTP_VERSION_1_1 will be used.
This attribute is ignored when opening the server side of an HTTP connection.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Set the value of an HTTP request header.
Parameters:
Certain headers will cause the HTTP driver to behave differently than normal. This must be called before
If this is set to 'identity' and any of the following are true, then the
connection will be closed after the end of the message is sent:
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Set the value of a response HTTP header.
Parameters:
Certain headers will cause changes in how the HTTP protocol will be handled. These include:
If this is set to 'identity' and any of the following are true, then the
connection will be closed after the end of the response is sent:
Returns:
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Set the response status code.
Parameters:
If this cntl is not called by a server, then the default value of 200 ('Ok') will be used. If this is called on the client-side of an HTTP connection, the handle control will fail with a GLOBUS_XIO_ERROR_PARAMETER error.
Returns:
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Set the response reason phrase.
Parameters:
If this cntl is not called by a server, then a default value based on the handle's response status code will be generated. If this is called on the client-side of an HTTP connection, the handle control will fail with a GLOBUS_XIO_ERROR_PARAMETER error.
Returns:
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Set the response HTTP version.
Parameters:
If this cntl is not called by a server, then the default of GLOBUS_XIO_HTTP_VERSION_1_1 will be used, though no HTTP/1.1 features (chunking, persistent connections, etc) will be assumed if the client request was an HTTP/1.0 request. If this is called on the client-side of an HTTP connection, the handle control will fail with GLOBUS_XIO_ERROR_PARAMETER.
Returns:
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Indicate end-of-entity for an HTTP body.
HTTP clients and servers must call this command to indicate to the driver that the entity-body which is being sent is completed. Subsequent attempts to write data on the handle will fail.
This handle command MUST be called on the client side of an HTTP connection when the HTTP method is OPTIONS, POST, or PUT, or when the open attributes indicate that an entity will be sent. This handle command MUST be called on the server side of an HTTP request connection when the HTTP method was OPTIONS, GET, POST, or TRACE.
Generated automatically by Doxygen for globus_xio from the source code.
| Wed Feb 27 2019 | Version 6.1 |