.TH "globus_xio_mode_e_driver_cntls" 3 "Tue Jul 5 2022" "Version 6.6" "globus_xio" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_xio_mode_e_driver_cntls \- Attributes and Cntls
.PP
 \- Attributes and Cntls\&.  

.SH SYNOPSIS
.br
.PP
.SS "Enumerations"

.in +1c
.ti -1c
.RI "enum \fBglobus_xio_mode_e_cmd_t\fP { \fBGLOBUS_XIO_MODE_E_SET_STACK\fP, \fBGLOBUS_XIO_MODE_E_GET_STACK\fP, \fBGLOBUS_XIO_MODE_E_SET_NUM_STREAMS\fP, \fBGLOBUS_XIO_MODE_E_GET_NUM_STREAMS\fP, \fBGLOBUS_XIO_MODE_E_SET_OFFSET_READS\fP, \fBGLOBUS_XIO_MODE_E_GET_OFFSET_READS\fP, \fBGLOBUS_XIO_MODE_E_SET_MANUAL_EODC\fP, \fBGLOBUS_XIO_MODE_E_GET_MANUAL_EODC\fP, \fBGLOBUS_XIO_MODE_E_SEND_EOD\fP, \fBGLOBUS_XIO_MODE_E_SET_EODC\fP, \fBGLOBUS_XIO_MODE_E_DD_GET_OFFSET\fP, \fBGLOBUS_XIO_MODE_E_SET_STACK_ATTR\fP, \fBGLOBUS_XIO_MODE_E_GET_STACK_ATTR\fP }"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "globus_result_t \fBglobus_xio_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_MODE_E_SET_STACK\fP, globus_xio_stack_t stack)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_MODE_E_GET_STACK\fP, globus_xio_stack_t *stack_out)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_MODE_E_SET_NUM_STREAMS\fP, int num_streams)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_MODE_E_GET_NUM_STREAMS\fP, int *num_streams_out)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_MODE_E_SET_OFFSET_READS\fP, globus_bool_t offset_reads)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_MODE_E_GET_OFFSET_READS\fP, globus_bool_t *offset_reads_out)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_MODE_E_SET_MANUAL_EODC\fP, globus_bool_t manual_eodc)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_MODE_E_GET_MANUAL_EODC\fP, globus_bool_t *manual_eodc_out)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_data_descriptor_cntl\fP (dd, driver, \fBGLOBUS_XIO_MODE_E_SEND_EOD\fP, globus_bool_t send_eod)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_handle_cntl\fP (handle, driver, \fBGLOBUS_XIO_MODE_E_SET_EODC\fP, int eod_count)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_data_descriptor_cntl\fP (dd, driver, \fBGLOBUS_XIO_MODE_E_DD_GET_OFFSET\fP, globus_off_t *offset_out)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_MODE_E_SET_STACK_ATTR\fP, globus_xio_stack_t stack)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_MODE_E_GET_STACK_ATTR\fP, globus_xio_attr_t *stack_out)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Attributes and Cntls\&. 

Mode_e driver specific attrs and cntls\&.
.PP
\fBSee also\fP
.RS 4
\fBglobus_xio_attr_cntl()\fP 
.PP
\fBglobus_xio_handle_cntl()\fP 
.PP
\fBglobus_xio_server_cntl()\fP 
.PP
\fBglobus_xio_data_descriptor_cntl()\fP 
.RE
.PP

.SH "Enumeration Type Documentation"
.PP 
.SS "enum \fBglobus_xio_mode_e_cmd_t\fP"
doxygen varargs filter stuff MODE_E driver specific cntls 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fIGLOBUS_XIO_MODE_E_SET_STACK \fP\fP
See usage for: \fBglobus_xio_attr_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_MODE_E_GET_STACK \fP\fP
See usage for: \fBglobus_xio_attr_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_MODE_E_SET_NUM_STREAMS \fP\fP
See usage for: \fBglobus_xio_attr_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_MODE_E_GET_NUM_STREAMS \fP\fP
See usage for: \fBglobus_xio_attr_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_MODE_E_SET_OFFSET_READS \fP\fP
See usage for: \fBglobus_xio_attr_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_MODE_E_GET_OFFSET_READS \fP\fP
See usage for: \fBglobus_xio_attr_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_MODE_E_SET_MANUAL_EODC \fP\fP
See usage for: \fBglobus_xio_attr_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_MODE_E_GET_MANUAL_EODC \fP\fP
See usage for: \fBglobus_xio_attr_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_MODE_E_SEND_EOD \fP\fP
See usage for: \fBglobus_xio_data_descriptor_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_MODE_E_SET_EODC \fP\fP
See usage for: \fBglobus_xio_handle_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_MODE_E_DD_GET_OFFSET \fP\fP
See usage for: \fBglobus_xio_data_descriptor_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_MODE_E_SET_STACK_ATTR \fP\fP
See usage for: \fBglobus_xio_attr_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_MODE_E_GET_STACK_ATTR \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_MODE_E_GET_MANUAL_EODC\fP, globus_bool_t * manual_eodc_out)"
This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Get MANUAL_EODC flag on the attr\&.
.PP
\fBParameters\fP
.RS 4
\fImanual_eodc_out\fP The MANUAL_EODC flag will be stored here\&. 
.RE
.PP

.SS "globus_result_t globus_xio_attr_cntl (attr, driver, \fBGLOBUS_XIO_MODE_E_GET_NUM_STREAMS\fP, int * num_streams_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 number of streams on the attr\&.
.PP
\fBParameters\fP
.RS 4
\fInum_streams_out\fP The stream count will be stored here\&. 
.RE
.PP

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

.SS "globus_result_t globus_xio_attr_cntl (attr, driver, \fBGLOBUS_XIO_MODE_E_GET_STACK\fP, globus_xio_stack_t * stack_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 stack on the attr\&.
.PP
\fBParameters\fP
.RS 4
\fIstack_out\fP The stack will be stored here\&. If none is set, GLOBUS_NULL will be set\&. 
.RE
.PP

.SS "globus_result_t globus_xio_attr_cntl (attr, driver, \fBGLOBUS_XIO_MODE_E_GET_STACK_ATTR\fP, globus_xio_attr_t * stack_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 attr that will be used with the stack\&. This is intended for use with GLOBUS_XIO_MODE_E_SET_STACK\&.
.PP
\fBParameters\fP
.RS 4
\fIstack_out\fP The stack will be stored here\&. If none is set, GLOBUS_NULL will be set\&. 
.RE
.PP

.SS "globus_result_t globus_xio_attr_cntl (attr, driver, \fBGLOBUS_XIO_MODE_E_SET_MANUAL_EODC\fP, globus_bool_t manual_eodc)"
This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Set flag to indicate whether EODC will be set manually by the user on a data_desc or the driver has to calculate the EODC
.PP
\fBParameters\fP
.RS 4
\fImanual_eodc\fP GLOBUS_TRUE to set EODC manually, GLOBUS_FALSE to not set EODC manually (default)\&. 
.RE
.PP

.SS "globus_result_t globus_xio_attr_cntl (attr, driver, \fBGLOBUS_XIO_MODE_E_SET_NUM_STREAMS\fP, int num_streams)"
This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Set the number of streams to be used between the client and the server\&.
.PP
\fBParameters\fP
.RS 4
\fInum_streams\fP Specifies the number of streams to use\&. 
.RE
.PP

.SS "globus_result_t globus_xio_attr_cntl (attr, driver, \fBGLOBUS_XIO_MODE_E_SET_OFFSET_READS\fP, globus_bool_t offset_reads)"
This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Set flag to indicate whether the data read from user would always be preceded by an offset read or not\&. The user can do a read with wait_for_bytes set to zero, to find the offset of the data that he is going to get in his next read operation
.PP
\fBParameters\fP
.RS 4
\fIoffset_reads\fP GLOBUS_TRUE to enable offset reads, GLOBUS_FALSE to disable offset reads (default)\&. 
.RE
.PP

.SS "globus_result_t globus_xio_attr_cntl (attr, driver, \fBGLOBUS_XIO_MODE_E_SET_STACK\fP, globus_xio_stack_t stack)"
This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Set the stack (of xio drivers) to be used for the connection(s)\&.
.PP
Do not create a new ftp client handle, use this handle instead\&.
.PP
\fBParameters\fP
.RS 4
\fIstack\fP Specifies the stack to use for the connection(s)\&. Note: this stack will not be destroyed\&. 
.RE
.PP

.SS "globus_result_t globus_xio_attr_cntl (attr, driver, \fBGLOBUS_XIO_MODE_E_SET_STACK_ATTR\fP, globus_xio_stack_t stack)"
This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Set the attr to be used with the stack set from GLOBUS_XIO_MODE_E_SET_STACK\&.
.PP
Do not create a new ftp client handle, use this handle instead\&.
.PP
\fBParameters\fP
.RS 4
\fIstack\fP Specifies the stack to use for the connection(s)\&. Note: this stack will not be destroyed\&. 
.RE
.PP

.SS "globus_result_t globus_xio_data_descriptor_cntl (dd, driver, \fBGLOBUS_XIO_MODE_E_DD_GET_OFFSET\fP, globus_off_t * offset_out)"
This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Get offset of the next available data
.PP
Used only if OFFSET_READS is enabled\&.
.PP
\fBParameters\fP
.RS 4
\fIoffset_out\fP offset will be stored here 
.RE
.PP

.SS "globus_result_t globus_xio_data_descriptor_cntl (dd, driver, \fBGLOBUS_XIO_MODE_E_SEND_EOD\fP, globus_bool_t send_eod)"
This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Set SEND_EOD flag
.PP
Used only for data descriptors to write calls\&.
.PP
\fBParameters\fP
.RS 4
\fIsend_eod\fP GLOBUS_TRUE to send EOD, GLOBUS_FALSE to not send EOD (default)\&. 
.RE
.PP

.SS "globus_result_t globus_xio_handle_cntl (handle, driver, \fBGLOBUS_XIO_MODE_E_SET_EODC\fP, int eod_count)"
This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Set EOD count
.PP
Used only if MANUAL_EODC flag is set to GLOBUS_TRUE\&.
.PP
\fBParameters\fP
.RS 4
\fIeod_count\fP specifies the eod count 
.RE
.PP

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