.TH "globus_xio_ordering_driver_cntls" 3 "Thu Nov 10 2016" "Version 5.14" "globus_xio" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_xio_ordering_driver_cntls \- Attributes and Cntls
.SS "Enumerations"

.in +1c
.ti -1c
.RI "enum \fBglobus_xio_ordering_cmd_t\fP { \fBGLOBUS_XIO_ORDERING_SET_OFFSET\fP, \fBGLOBUS_XIO_ORDERING_SET_MAX_READ_COUNT\fP, \fBGLOBUS_XIO_ORDERING_GET_MAX_READ_COUNT\fP, \fBGLOBUS_XIO_ORDERING_SET_BUFFERING\fP, \fBGLOBUS_XIO_ORDERING_GET_BUFFERING\fP, \fBGLOBUS_XIO_ORDERING_SET_BUF_SIZE\fP, \fBGLOBUS_XIO_ORDERING_GET_BUF_SIZE\fP, \fBGLOBUS_XIO_ORDERING_SET_MAX_BUF_COUNT\fP, \fBGLOBUS_XIO_ORDERING_GET_MAX_BUF_COUNT\fP }"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "globus_result_t \fBglobus_xio_handle_cntl\fP (handle, driver, \fBGLOBUS_XIO_ORDERING_SET_OFFSET\fP, globus_off_t offset)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_ORDERING_SET_MAX_READ_COUNT\fP, int max_read_count)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_ORDERING_GET_MAX_READ_COUNT\fP, int *max_read_count_out)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_ORDERING_SET_BUFFERING\fP, globus_bool_t buffering)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_ORDERING_GET_BUFFERING\fP, globus_bool_t *buffering_out)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_ORDERING_SET_BUF_SIZE\fP, int buf_size)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_ORDERING_GET_BUF_SIZE\fP, int *buf_size_out)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_ORDERING_SET_MAX_BUF_COUNT\fP, int max_buf_count)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_ORDERING_GET_MAX_BUF_COUNT\fP, int *max_buf_count_out)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Ordering driver specific attrs and cntls\&.
.PP
\fBSee also:\fP
.RS 4
\fBglobus_xio_attr_cntl()\fP 
.PP
\fBglobus_xio_handle_cntl()\fP 
.RE
.PP

.SH "Enumeration Type Documentation"
.PP 
.SS "enum \fBglobus_xio_ordering_cmd_t\fP"
ORDERING driver specific cntls 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fIGLOBUS_XIO_ORDERING_SET_OFFSET \fP\fP
See usage for: \fBglobus_xio_handle_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_ORDERING_SET_MAX_READ_COUNT \fP\fP
See usage for: \fBglobus_xio_attr_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_ORDERING_GET_MAX_READ_COUNT \fP\fP
See usage for: \fBglobus_xio_attr_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_ORDERING_SET_BUFFERING \fP\fP
See usage for: \fBglobus_xio_attr_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_ORDERING_GET_BUFFERING \fP\fP
See usage for: \fBglobus_xio_attr_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_ORDERING_SET_BUF_SIZE \fP\fP
See usage for: \fBglobus_xio_attr_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_ORDERING_GET_BUF_SIZE \fP\fP
See usage for: \fBglobus_xio_attr_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_ORDERING_SET_MAX_BUF_COUNT \fP\fP
See usage for: \fBglobus_xio_attr_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_ORDERING_GET_MAX_BUF_COUNT \fP\fP
See usage for: \fBglobus_xio_attr_cntl \fP 
.SH "Function Documentation"
.PP 
.SS "globus_result_t globus_xio_attr_cntl (attr, driver, \fBGLOBUS_XIO_ORDERING_SET_MAX_READ_COUNT\fP, int max_read_count)"
This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Set the maximum number of reads that ordering driver can have outstanding on driver(s) below\&.
.PP
\fBParameters:\fP
.RS 4
\fImax_read_count\fP Specifies the maximum number of parallel reads (default is 1)\&. 
.RE
.PP

.SS "globus_result_t globus_xio_attr_cntl (attr, driver, \fBGLOBUS_XIO_ORDERING_GET_MAX_READ_COUNT\fP, int * max_read_count_out)"
This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Get the maximum number of parallel reads set on the attr\&.
.PP
\fBParameters:\fP
.RS 4
\fImax_read_count_out\fP The maximum number of parallel reads allowed will be stored here\&. 
.RE
.PP

.SS "globus_result_t globus_xio_attr_cntl (attr, driver, \fBGLOBUS_XIO_ORDERING_SET_BUFFERING\fP, globus_bool_t buffering)"
This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. This driver can be used in 2 modes; ordering (care about offsets of the data read - underlying transport driver may deliver data out of order - this driver will rearrange data based on the offset and deliver inorder to user) and buffering (do not care about offsets - just buffer the data read abd deliver it when requested)\&. This attribute control can be used to enable buffering\&.
.PP
\fBParameters:\fP
.RS 4
\fIbuffering\fP GLOBUS_TRUE to enable buffering, GLOBUS_FALSE (default) to disable buffering\&. 
.RE
.PP

.SS "globus_result_t globus_xio_attr_cntl (attr, driver, \fBGLOBUS_XIO_ORDERING_GET_BUFFERING\fP, globus_bool_t * buffering_out)"
This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Get the buffering flag on the attr\&.
.PP
\fBParameters:\fP
.RS 4
\fIbuffering_out\fP Buffering flag will be stored in here\&. 
.RE
.PP

.SS "globus_result_t globus_xio_attr_cntl (attr, driver, \fBGLOBUS_XIO_ORDERING_SET_BUF_SIZE\fP, int buf_size)"
This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Set the size of the buffer that ordering driver creates to use for reading data from the driver below it\&.
.PP
\fBParameters:\fP
.RS 4
\fIbuf_size\fP Specifies the buffer size for internal reads (default is 100 KB)\&. 
.RE
.PP

.SS "globus_result_t globus_xio_attr_cntl (attr, driver, \fBGLOBUS_XIO_ORDERING_GET_BUF_SIZE\fP, int * buf_size_out)"
This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Get the size of the buffer used for the internal reads\&.
.PP
\fBParameters:\fP
.RS 4
\fIbuf_size_out\fP The buffer size will be stored in here\&. 
.RE
.PP

.SS "globus_result_t globus_xio_attr_cntl (attr, driver, \fBGLOBUS_XIO_ORDERING_SET_MAX_BUF_COUNT\fP, int max_buf_count)"
This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Set the maximum number of buffers that this driver can create for reading data from the driver below it\&.
.PP
\fBParameters:\fP
.RS 4
\fImax_buf_count\fP Specifies the max buffer count for internal reads (default is 100)\&. 
.RE
.PP

.SS "globus_result_t globus_xio_attr_cntl (attr, driver, \fBGLOBUS_XIO_ORDERING_GET_MAX_BUF_COUNT\fP, int * max_buf_count_out)"
This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Get the maximum buffer count set on the attr\&.
.PP
\fBParameters:\fP
.RS 4
\fImax_buf_count_out\fP The maximun buffer count will be stored in here\&. 
.RE
.PP

.SS "globus_result_t globus_xio_handle_cntl (handle, driver, \fBGLOBUS_XIO_ORDERING_SET_OFFSET\fP, globus_off_t offset)"
This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Set offset for the next IO operation\&. This is not allowed when there is an outstanding IO operation\&. This operation clears all the buffered data\&.
.PP
\fBParameters:\fP
.RS 4
\fIoffset\fP Specifies the offset to use in the next IO operation\&. 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for globus_xio from the source code\&.