---
name: "mode_e_driver_cntls"
section: "3"
platform: "linux"
package: "libglobus-xio-doc"
version: "3.3-1"
release: "Debian 7 (Wheezy)"
platforms: ["linux"]
url: "https://new.carta.tech/mode_e_driver_cntls"
---

# mode\_e\_driver\_cntls(3)

## NAME

Attributes and Cntls -

### Enumerations

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** }\

### Functions

globus\_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 offset\_reads)\
 globus\_result\_t **globus\_xio\_attr\_cntl** (attr, driver, **GLOBUS\_XIO\_MODE\_E\_GET\_OFFSET\_READS**, globus\_bool\_t \*offset\_reads\_out)\
 globus\_result\_t **globus\_xio\_attr\_cntl** (attr, driver, **GLOBUS\_XIO\_MODE\_E\_SET\_MANUAL\_EODC**, globus\_bool\_t manual\_eodc)\
 globus\_result\_t **globus\_xio\_attr\_cntl** (attr, driver, **GLOBUS\_XIO\_MODE\_E\_GET\_MANUAL\_EODC**, globus\_bool\_t \*manual\_eodc\_out)\
 globus\_result\_t **globus\_xio\_data\_descriptor\_cntl** (dd, driver, **GLOBUS\_XIO\_MODE\_E\_SEND\_EOD**, globus\_bool\_t send\_eod)\
 globus\_result\_t **globus\_xio\_handle\_cntl** (handle, driver, **GLOBUS\_XIO\_MODE\_E\_SET\_EODC**, int eod\_count)\
 globus\_result\_t **globus\_xio\_data\_descriptor\_cntl** (dd, driver, **GLOBUS\_XIO\_MODE\_E\_DD\_GET\_OFFSET**, globus\_off\_t \*offset\_out)\
 globus\_result\_t **globus\_xio\_attr\_cntl** (attr, driver, **GLOBUS\_XIO\_MODE\_E\_SET\_STACK\_ATTR**, globus\_xio\_stack\_t stack)\
 globus\_result\_t **globus\_xio\_attr\_cntl** (attr, driver, **GLOBUS\_XIO\_MODE\_E\_GET\_STACK\_ATTR**, globus\_xio\_attr\_t \*stack\_out)\

## Detailed Description

Mode\_e driver specific attrs and cntls.

**See also:**

**globus\_xio\_attr\_cntl()**

**globus\_xio\_handle\_cntl()**

**globus\_xio\_server\_cntl()**

**globus\_xio\_data\_descriptor\_cntl()**

## Enumeration Type Documentation

### enum globus\_xio\_mode\_e\_cmd\_t

doxygen varargs filter stuff MODE\_E driver specific cntls

**Enumerator:**

- *GLOBUS\_XIO\_MODE\_E\_SET\_STACK*

  *See usage for:* **globus\_xio\_attr\_cntl** *.*

- *GLOBUS\_XIO\_MODE\_E\_GET\_STACK*

  *See usage for:* **globus\_xio\_attr\_cntl** *.*

- *GLOBUS\_XIO\_MODE\_E\_SET\_NUM\_STREAMS*

  *See usage for:* **globus\_xio\_attr\_cntl** *.*

- *GLOBUS\_XIO\_MODE\_E\_GET\_NUM\_STREAMS*

  *See usage for:* **globus\_xio\_attr\_cntl** *.*

- *GLOBUS\_XIO\_MODE\_E\_SET\_OFFSET\_READS*

  *See usage for:* **globus\_xio\_attr\_cntl** *.*

- *GLOBUS\_XIO\_MODE\_E\_GET\_OFFSET\_READS*

  *See usage for:* **globus\_xio\_attr\_cntl** *.*

- *GLOBUS\_XIO\_MODE\_E\_SET\_MANUAL\_EODC*

  *See usage for:* **globus\_xio\_attr\_cntl** *.*

- *GLOBUS\_XIO\_MODE\_E\_GET\_MANUAL\_EODC*

  *See usage for:* **globus\_xio\_attr\_cntl** *.*

- *GLOBUS\_XIO\_MODE\_E\_SEND\_EOD*

  *See usage for:* **globus\_xio\_data\_descriptor\_cntl** *.*

- *GLOBUS\_XIO\_MODE\_E\_SET\_EODC*

  *See usage for:* **globus\_xio\_handle\_cntl** *.*

- *GLOBUS\_XIO\_MODE\_E\_DD\_GET\_OFFSET*

  *See usage for:* **globus\_xio\_data\_descriptor\_cntl** *.*

- *GLOBUS\_XIO\_MODE\_E\_SET\_STACK\_ATTR*

  *See usage for:* **globus\_xio\_attr\_cntl** *.*

- *GLOBUS\_XIO\_MODE\_E\_GET\_STACK\_ATTR*

  *See usage for:* **globus\_xio\_attr\_cntl** *.*

## Function Documentation

### globus\_result\_t globus\_xio\_attr\_cntl (attr, driver, GLOBUS\_XIO\_MODE\_E\_SET\_STACK, globus\_xio\_stack\_tstack)

*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). Do not create a new ftp client handle, use this handle instead.*

**Parameters:**

*stack Specifies the stack to use for the connection(s). Note: this stack will not be destroyed.*

### globus\_result\_t globus\_xio\_attr\_cntl (attr, driver, GLOBUS\_XIO\_MODE\_E\_GET\_STACK, 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.* **Parameters:**

*stack\_out The stack will be stored here. If none is set, GLOBUS\_NULL will be set.*

### globus\_result\_t globus\_xio\_attr\_cntl (attr, driver, GLOBUS\_XIO\_MODE\_E\_SET\_NUM\_STREAMS, intnum\_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.* **Parameters:**

*num\_streams Specifies the number of streams to use.*

### globus\_result\_t globus\_xio\_attr\_cntl (attr, driver, GLOBUS\_XIO\_MODE\_E\_GET\_NUM\_STREAMS, 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.* **Parameters:**

*num\_streams\_out The stream count will be stored here.*

### globus\_result\_t globus\_xio\_attr\_cntl (attr, driver, GLOBUS\_XIO\_MODE\_E\_SET\_OFFSET\_READS, globus\_bool\_toffset\_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*

**Parameters:**

*offset\_reads GLOBUS\_TRUE to enable offset reads, GLOBUS\_FALSE to disable offset reads (default).*

### globus\_result\_t globus\_xio\_attr\_cntl (attr, driver, GLOBUS\_XIO\_MODE\_E\_GET\_OFFSET\_READS, 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.* **Parameters:**

*offset\_reads\_out The OFFSET\_READS flag will be stored here.*

### globus\_result\_t globus\_xio\_attr\_cntl (attr, driver, GLOBUS\_XIO\_MODE\_E\_SET\_MANUAL\_EODC, globus\_bool\_tmanual\_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.* **Parameters:**

*manual\_eodc GLOBUS\_TRUE to set EODC manually, GLOBUS\_FALSE to not set EODC manually (default).*

### globus\_result\_t globus\_xio\_attr\_cntl (attr, driver, GLOBUS\_XIO\_MODE\_E\_GET\_MANUAL\_EODC, 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.* **Parameters:**

*manual\_eodc\_out The MANUAL\_EODC flag will be stored here.*

### globus\_result\_t globus\_xio\_data\_descriptor\_cntl (dd, driver, GLOBUS\_XIO\_MODE\_E\_SEND\_EOD, globus\_bool\_tsend\_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*

*Used only for data descriptors to write calls.* **Parameters:**

*send\_eod GLOBUS\_TRUE to send EOD, GLOBUS\_FALSE to not send EOD (default).*

### globus\_result\_t globus\_xio\_handle\_cntl (handle, driver, GLOBUS\_XIO\_MODE\_E\_SET\_EODC, inteod\_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*

*Used only if MANUAL\_EODC flag is set to GLOBUS\_TRUE.* **Parameters:**

*eod\_count specifies the eod count*

### globus\_result\_t globus\_xio\_data\_descriptor\_cntl (dd, driver, GLOBUS\_XIO\_MODE\_E\_DD\_GET\_OFFSET, 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*

*Used only if OFFSET\_READS is enabled.* **Parameters:**

*offset\_out offset will be stored here*

### globus\_result\_t globus\_xio\_attr\_cntl (attr, driver, GLOBUS\_XIO\_MODE\_E\_SET\_STACK\_ATTR, globus\_xio\_stack\_tstack)

*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. Do not create a new ftp client handle, use this handle instead.*

**Parameters:**

*stack Specifies the stack to use for the connection(s). Note: this stack will not be destroyed.*

### globus\_result\_t globus\_xio\_attr\_cntl (attr, driver, GLOBUS\_XIO\_MODE\_E\_GET\_STACK\_ATTR, 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.*

**Parameters:**

*stack\_out The stack will be stored here. If none is set, GLOBUS\_NULL will be set.*

## Author

*Generated automatically by Doxygen for globus xio from the source code.*