globus_xio...iver_cntls(3)

💖 globus_xio_ordering_driver_cntls 💖

okay bestie, welcome to the Library Functions Manual page for globus_xio...iver_cntls — yes that's the actual shortened name, the terminal cut it off mid-word like it always does, so rude of it 🫠. Anyway. Sit down, hydrate, and let's talk about the ordering driver's attrs and cntls, because you're gonna slay this.

---

✨ NAME ✨

globus_xio_ordering_driver_cntls — Attributes and Cntls.

• Attributes and Cntls.

like. that's the whole vibe. attributes and cntls. iconic, honestly.

---

🌸 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

• ```c globus_result_t globus_xio_handle_cntl (handle, driver, GLOBUS_XIO_ORDERING_SET_OFFSET, globus_off_t offset)

- ```c
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_ORDERING_SET_MAX_READ_COUNT, int max_read_count)

• ```c globus_result_t globus_xio_attr_cntl (attr, driver, GLOBUS_XIO_ORDERING_GET_MAX_READ_COUNT, int *max_read_count_out)

- ```c
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_ORDERING_SET_BUFFERING, globus_bool_t buffering)

• ```c globus_result_t globus_xio_attr_cntl (attr, driver, GLOBUS_XIO_ORDERING_GET_BUFFERING, globus_bool_t *buffering_out)

- ```c
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_ORDERING_SET_BUF_SIZE, int buf_size)

• ```c globus_result_t globus_xio_attr_cntl (attr, driver, GLOBUS_XIO_ORDERING_GET_BUF_SIZE, int *buf_size_out)

- ```c
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_ORDERING_SET_MAX_BUF_COUNT, int max_buf_count)

• ```c 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. like, this whole page is the ordering driver's own little collection of attrs and cntls, and it's very much *her* page, no cap ✨.

### 👀 See also

- `globus_xio_attr_cntl()`
- `globus_xio_handle_cntl()`

---

# 🌈 Enumeration Type Documentation 🌈

## `enum globus_xio_ordering_cmd_t`

ORDERING driver specific cntls. that's the whole summary, periodt.

### 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 🔥

> ok so every single one of these functions starts with the same little disclaimer: *"This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts."* it's giving copy-paste-from-Doxygen energy and honestly? same. I'm keeping it for every one because it's in the original and we do not drop details in this house 💖

## `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.

> not me pointing out that "maximun" is a typo in the original 🙈 — but bestie, I am *keeping* it, because the rule is we never change a single character. the typo stays. it's canon now.

## `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.

> "abd" instead of "and" — again, not me fixing it, bestie, we preserve ✨ everything ✨ fr fr.

## `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.

> 🚨 bestie, read this part twice: this is **not allowed when there is an outstanding IO operation**, and this operation **clears all the buffered data**. so like, don't be mid-read and then yank the offset out from under yourself, okay? that's the kind of thing that ruins your whole day 💀

**Parameters**

- *`offset`* — Specifies the offset to use in the next IO operation.

---

# 👑 Author 👑

Generated automatically by Doxygen for `globus_xio` from the source code. (so like, don't come for the prose, a robot wrote the original and *I* wrote this version, we're both just doing our jobs 🫶)

---

<purple>and that's the whole page, bestie!! this was <rainbow>globus_xio</rainbow>, **Version 6.6**, in the `globus_xio` manual — go forth and order your data correctly, you absolute icon 💜✨🎀🦋</purple>