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

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

.in +1c
.ti -1c
.RI "enum \fBglobus_xio_file_attr_cmd_t\fP { \fBGLOBUS_XIO_FILE_SET_MODE\fP, \fBGLOBUS_XIO_FILE_GET_MODE\fP, \fBGLOBUS_XIO_FILE_SET_FLAGS\fP, \fBGLOBUS_XIO_FILE_GET_FLAGS\fP, \fBGLOBUS_XIO_FILE_SET_TRUNC_OFFSET\fP, \fBGLOBUS_XIO_FILE_GET_TRUNC_OFFSET\fP, \fBGLOBUS_XIO_FILE_SET_HANDLE\fP, \fBGLOBUS_XIO_FILE_GET_HANDLE\fP, \fBGLOBUS_XIO_FILE_SET_BLOCKING_IO\fP, \fBGLOBUS_XIO_FILE_GET_BLOCKING_IO\fP, \fBGLOBUS_XIO_FILE_SEEK\fP }"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "globus_result_t \fBglobus_xio_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_FILE_SET_MODE\fP, int mode)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_FILE_GET_MODE\fP, int *mode_out)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_FILE_SET_FLAGS\fP, int flags)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_FILE_GET_FLAGS\fP, int *flags_out)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_FILE_SET_TRUNC_OFFSET\fP, globus_off_t offset)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_FILE_GET_TRUNC_OFFSET\fP, globus_off_t *offset_out)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_FILE_SET_HANDLE\fP, globus_xio_system_file_t handle)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_FILE_GET_HANDLE\fP, globus_xio_system_file_t *handle_out)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_handle_cntl\fP (handle, driver, \fBGLOBUS_XIO_FILE_GET_HANDLE\fP, globus_xio_system_file_t *handle_out)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_FILE_SET_BLOCKING_IO\fP, globus_bool_t use_blocking_io)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_handle_cntl\fP (handle, driver, \fBGLOBUS_XIO_FILE_SET_BLOCKING_IO\fP, globus_bool_t use_blocking_io)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_FILE_GET_BLOCKING_IO\fP, globus_bool_t *use_blocking_io_out)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_handle_cntl\fP (handle, driver, \fBGLOBUS_XIO_FILE_GET_BLOCKING_IO\fP, globus_bool_t *use_blocking_io_out)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_xio_handle_cntl\fP (handle, driver, \fBGLOBUS_XIO_FILE_SEEK\fP, globus_off_t *in_out_offset, \fBglobus_xio_file_whence_t\fP whence)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Attributes and Cntls\&. 

File 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_file_attr_cmd_t\fP"
doxygen varargs filter stuff File driver specific cntls 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fIGLOBUS_XIO_FILE_SET_MODE \fP\fP
See usage for: \fBglobus_xio_attr_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_FILE_GET_MODE \fP\fP
See usage for: \fBglobus_xio_attr_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_FILE_SET_FLAGS \fP\fP
See usage for: \fBglobus_xio_attr_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_FILE_GET_FLAGS \fP\fP
See usage for: \fBglobus_xio_attr_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_FILE_SET_TRUNC_OFFSET \fP\fP
See usage for: \fBglobus_xio_attr_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_FILE_GET_TRUNC_OFFSET \fP\fP
See usage for: \fBglobus_xio_attr_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_FILE_SET_HANDLE \fP\fP
See usage for: \fBglobus_xio_attr_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_FILE_GET_HANDLE \fP\fP
See usage for: \fBglobus_xio_attr_cntl \fP, \fBglobus_xio_handle_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_FILE_SET_BLOCKING_IO \fP\fP
See usage for: \fBglobus_xio_attr_cntl \fP, \fBglobus_xio_handle_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_FILE_GET_BLOCKING_IO \fP\fP
See usage for: \fBglobus_xio_attr_cntl \fP, \fBglobus_xio_handle_cntl \fP 
.TP
\fB\fIGLOBUS_XIO_FILE_SEEK \fP\fP
See usage for: \fBglobus_xio_handle_cntl \fP 
.SH "Function Documentation"
.PP 
.SS "globus_result_t globus_xio_attr_cntl (attr, driver, \fBGLOBUS_XIO_FILE_GET_BLOCKING_IO\fP, globus_bool_t * use_blocking_io_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 blocking io status in use or in attr\&.
.PP
\fBParameters\fP
.RS 4
\fIuse_blocking_io_out\fP The flag will be set here\&. GLOBUS_TRUE for enabled\&.
.RE
.PP
string opt: blocking=\fIbool\fP 
.SS "globus_result_t globus_xio_attr_cntl (attr, driver, \fBGLOBUS_XIO_FILE_GET_FLAGS\fP, int * flags_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 file open flags\&.
.PP
\fBParameters\fP
.RS 4
\fIflags_out\fP The current flags will be stored here\&. 
.RE
.PP

.SS "globus_result_t globus_xio_attr_cntl (attr, driver, \fBGLOBUS_XIO_FILE_GET_HANDLE\fP, globus_xio_system_file_t * handle_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 file handle in use or in attr\&.
.PP
\fBParameters\fP
.RS 4
\fIhandle_out\fP The file handle (fd or HANDLE) will be stored here\&. If none is set, GLOBUS_XIO_TCP_INVALID_HANDLE will be set\&. 
.RE
.PP

.SS "globus_result_t globus_xio_attr_cntl (attr, driver, \fBGLOBUS_XIO_FILE_GET_MODE\fP, int * mode_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 file create mode\&.
.PP
\fBParameters\fP
.RS 4
\fImode_out\fP The current mode will be stored here\&. 
.RE
.PP

.SS "globus_result_t globus_xio_attr_cntl (attr, driver, \fBGLOBUS_XIO_FILE_GET_TRUNC_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 the file truncate offset\&.
.PP
\fBParameters\fP
.RS 4
\fIoffset_out\fP The offset will be stored here\&. 
.RE
.PP

.SS "globus_result_t globus_xio_attr_cntl (attr, driver, \fBGLOBUS_XIO_FILE_SET_BLOCKING_IO\fP, globus_bool_t use_blocking_io)"
This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Enable true blocking io when making globus_xio_read/write() calls\&. Note: use with caution\&. You can deadlock an entire app with this\&.
.PP
\fBParameters\fP
.RS 4
\fIuse_blocking_io\fP If GLOBUS_TRUE, true blocking io will be enabled\&. GLOBUS_FALSE will disable it (default); 
.RE
.PP

.SS "globus_result_t globus_xio_attr_cntl (attr, driver, \fBGLOBUS_XIO_FILE_SET_FLAGS\fP, int flags)"
This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Set the file open flags\&.
.PP
The default flags specify to create the file if it doesn't exist, open it for reading and writing, and interpret it as a binary file\&.
.PP
\fBParameters\fP
.RS 4
\fIflags\fP A bitwise OR of all the flags desired
.RE
.PP
\fBSee also\fP
.RS 4
\fBglobus_xio_file_flag_t\fP
.RE
.PP
string opt: flags=\fIint\fP 
.SS "globus_result_t globus_xio_attr_cntl (attr, driver, \fBGLOBUS_XIO_FILE_SET_HANDLE\fP, globus_xio_system_file_t handle)"
This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Set the file handle to use\&.
.PP
Do not open a new file, use this pre-opened handle instead\&.
.PP
\fBParameters\fP
.RS 4
\fIhandle\fP Use this handle (fd or HANDLE) for the file\&. Note: close() will not be called on this handle\&. 
.RE
.PP

.SS "globus_result_t globus_xio_attr_cntl (attr, driver, \fBGLOBUS_XIO_FILE_SET_MODE\fP, int mode)"
This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Set the file create mode\&.
.PP
Use this to set the permissions a non-existent file is created with, The default mode is 0644\&.
.PP
\fBParameters\fP
.RS 4
\fImode\fP A bitwise OR of all the modes desired
.RE
.PP
\fBSee also\fP
.RS 4
\fBglobus_xio_file_mode_t\fP
.RE
.PP
string opt: mode=\fIint\fP 
.SS "globus_result_t globus_xio_attr_cntl (attr, driver, \fBGLOBUS_XIO_FILE_SET_TRUNC_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 the file truncate offset\&.
.PP
Use this in conjunction with the \fBGLOBUS_XIO_FILE_TRUNC\fP flag to truncate a file to a non-zero offset\&. If the file was larger than offset bytes, the extra data is lost\&. If the file was shorter or non-existent, it is extended and the extended part reads as zeros\&. (default is 0)
.PP
\fBParameters\fP
.RS 4
\fIoffset\fP The desired size of the file\&. 
.RE
.PP

.SS "globus_result_t globus_xio_handle_cntl (handle, driver, \fBGLOBUS_XIO_FILE_GET_BLOCKING_IO\fP, globus_bool_t * use_blocking_io_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 blocking io status in use or in attr\&.
.PP
\fBParameters\fP
.RS 4
\fIuse_blocking_io_out\fP The flag will be set here\&. GLOBUS_TRUE for enabled\&.
.RE
.PP
string opt: blocking=\fIbool\fP 
.SS "globus_result_t globus_xio_handle_cntl (handle, driver, \fBGLOBUS_XIO_FILE_GET_HANDLE\fP, globus_xio_system_file_t * handle_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 file handle in use or in attr\&.
.PP
\fBParameters\fP
.RS 4
\fIhandle_out\fP The file handle (fd or HANDLE) will be stored here\&. If none is set, GLOBUS_XIO_TCP_INVALID_HANDLE will be set\&. 
.RE
.PP

.SS "globus_result_t globus_xio_handle_cntl (handle, driver, \fBGLOBUS_XIO_FILE_SEEK\fP, globus_off_t * in_out_offset, \fBglobus_xio_file_whence_t\fP whence)"
This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Reposition read/write file offset\&.
.PP
\fBParameters\fP
.RS 4
\fIin_out_offset\fP Specify the desired offset (according to whence)\&. On success, the actual file offset will be stored here\&.
.br
\fIwhence\fP Specify how offset should be interpreted\&.
.RE
.PP
\fBSee also\fP
.RS 4
\fBglobus_xio_file_whence_t\fP 
.PP
\fBGLOBUS_XIO_SEEK\fP 
.RE
.PP

.SS "globus_result_t globus_xio_handle_cntl (handle, driver, \fBGLOBUS_XIO_FILE_SET_BLOCKING_IO\fP, globus_bool_t use_blocking_io)"
This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Enable true blocking io when making globus_xio_read/write() calls\&. Note: use with caution\&. You can deadlock an entire app with this\&.
.PP
\fBParameters\fP
.RS 4
\fIuse_blocking_io\fP If GLOBUS_TRUE, true blocking io will be enabled\&. GLOBUS_FALSE will disable it (default); 
.RE
.PP

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