---
name: "GLOBUS_XIO_ORDERING_GET_MAX_BUF_COUNT"
section: "3"
platform: "linux"
package: "libglobus-xio-doc"
version: "6.6-3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/globus_xio_ordering_driver_cntls"
---

# GLOBUS\_XIO\_ORDERING\_GET\_MAX\_BUF\_COUNT(3)

Attributes and Cntls - Attributes and Cntls.

Part of [globus\_xio\_ordering\_driver\_cntls(3)](/globus_xio_ordering_driver_cntls/3.md).

## NAME

globus\_xio\_ordering\_driver\_cntls - Attributes and Cntls

 \- Attributes and Cntls.

## SYNOPSIS

### Enumerations

enum **globus\_xio\_ordering\_cmd\_t** { **GLOBUS\_XIO\_ORDERING\_SET\_OFFSET**, **GLOBUS\_XIO\_ORDERING\_SET\_MAX\_READ\_COUNT**, **GLOBUS\_XIO\_ORDERING\_GET\_MAX\_READ\_COUNT**, **GLOBUS\_XIO\_ORDERING\_SET\_BUFFERING**, **GLOBUS\_XIO\_ORDERING\_GET\_BUFFERING**, **GLOBUS\_XIO\_ORDERING\_SET\_BUF\_SIZE**, **GLOBUS\_XIO\_ORDERING\_GET\_BUF\_SIZE**, **GLOBUS\_XIO\_ORDERING\_SET\_MAX\_BUF\_COUNT**, **GLOBUS\_XIO\_ORDERING\_GET\_MAX\_BUF\_COUNT** }\

### Functions

globus\_result\_t **globus\_xio\_handle\_cntl** (handle, driver, **GLOBUS\_XIO\_ORDERING\_SET\_OFFSET**, globus\_off\_t offset)\
 globus\_result\_t **globus\_xio\_attr\_cntl** (attr, driver, **GLOBUS\_XIO\_ORDERING\_SET\_MAX\_READ\_COUNT**, int max\_read\_count)\
 globus\_result\_t **globus\_xio\_attr\_cntl** (attr, driver, **GLOBUS\_XIO\_ORDERING\_GET\_MAX\_READ\_COUNT**, int \*max\_read\_count\_out)\
 globus\_result\_t **globus\_xio\_attr\_cntl** (attr, driver, **GLOBUS\_XIO\_ORDERING\_SET\_BUFFERING**, globus\_bool\_t buffering)\
 globus\_result\_t **globus\_xio\_attr\_cntl** (attr, driver, **GLOBUS\_XIO\_ORDERING\_GET\_BUFFERING**, globus\_bool\_t \*buffering\_out)\
 globus\_result\_t **globus\_xio\_attr\_cntl** (attr, driver, **GLOBUS\_XIO\_ORDERING\_SET\_BUF\_SIZE**, int buf\_size)\
 globus\_result\_t **globus\_xio\_attr\_cntl** (attr, driver, **GLOBUS\_XIO\_ORDERING\_GET\_BUF\_SIZE**, int \*buf\_size\_out)\
 globus\_result\_t **globus\_xio\_attr\_cntl** (attr, driver, **GLOBUS\_XIO\_ORDERING\_SET\_MAX\_BUF\_COUNT**, int max\_buf\_count)\
 globus\_result\_t **globus\_xio\_attr\_cntl** (attr, driver, **GLOBUS\_XIO\_ORDERING\_GET\_MAX\_BUF\_COUNT**, int \*max\_buf\_count\_out)\

## Detailed Description

Attributes and Cntls.

Ordering driver specific attrs and cntls.

**See also**

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

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

## Enumeration Type Documentation

### enum globus\_xio\_ordering\_cmd\_t

ORDERING driver specific cntls

**Enumerator**

- *GLOBUS\_XIO\_ORDERING\_SET\_OFFSET*

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

- *GLOBUS\_XIO\_ORDERING\_SET\_MAX\_READ\_COUNT*

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

- *GLOBUS\_XIO\_ORDERING\_GET\_MAX\_READ\_COUNT*

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

- *GLOBUS\_XIO\_ORDERING\_SET\_BUFFERING*

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

- *GLOBUS\_XIO\_ORDERING\_GET\_BUFFERING*

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

- *GLOBUS\_XIO\_ORDERING\_SET\_BUF\_SIZE*

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

- *GLOBUS\_XIO\_ORDERING\_GET\_BUF\_SIZE*

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

- *GLOBUS\_XIO\_ORDERING\_SET\_MAX\_BUF\_COUNT*

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

- *GLOBUS\_XIO\_ORDERING\_GET\_MAX\_BUF\_COUNT*

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

## Function Documentation

### globus\_result\_t globus\_xio\_attr\_cntl (attr, driver, GLOBUS\_XIO\_ORDERING\_GET\_BUF\_SIZE, 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.*

**Parameters**

*buf\_size\_out The buffer size will be stored in here.*

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

**Parameters**

*buffering\_out Buffering flag will be stored in here.*

### globus\_result\_t globus\_xio\_attr\_cntl (attr, driver, GLOBUS\_XIO\_ORDERING\_GET\_MAX\_BUF\_COUNT, 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.*

**Parameters**

*max\_buf\_count\_out The maximun buffer count will be stored in here.*

### globus\_result\_t globus\_xio\_attr\_cntl (attr, driver, GLOBUS\_XIO\_ORDERING\_GET\_MAX\_READ\_COUNT, 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.*

**Parameters**

*max\_read\_count\_out The maximum number of parallel reads allowed will be stored here.*

### globus\_result\_t globus\_xio\_attr\_cntl (attr, driver, GLOBUS\_XIO\_ORDERING\_SET\_BUF\_SIZE, 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.*

**Parameters**

*buf\_size Specifies the buffer size for internal reads (default is 100 KB).*

### globus\_result\_t globus\_xio\_attr\_cntl (attr, driver, GLOBUS\_XIO\_ORDERING\_SET\_BUFFERING, 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.*

**Parameters**

*buffering GLOBUS\_TRUE to enable buffering, GLOBUS\_FALSE (default) to disable buffering.*

### globus\_result\_t globus\_xio\_attr\_cntl (attr, driver, GLOBUS\_XIO\_ORDERING\_SET\_MAX\_BUF\_COUNT, 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.*

**Parameters**

*max\_buf\_count Specifies the max buffer count for internal reads (default is 100).*

### globus\_result\_t globus\_xio\_attr\_cntl (attr, driver, GLOBUS\_XIO\_ORDERING\_SET\_MAX\_READ\_COUNT, 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.*

**Parameters**

*max\_read\_count Specifies the maximum number of parallel reads (default is 1).*

### globus\_result\_t globus\_xio\_handle\_cntl (handle, driver, GLOBUS\_XIO\_ORDERING\_SET\_OFFSET, 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.*

**Parameters**

*offset Specifies the offset to use in the next IO operation.*

## Author

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