GLOBUS_XIO_GRIDFTP_GET_MODE(3)

💖 globus_xio_gridftp_driver 💖

okay bestie, gather round, because we're looking at globus_xio_gridftp_driver(3) — the Globus XIO GRIDFTP Client Driver — and honestly? it's giving "quietly powerful". let's get into it 🦋

---

✨ NAME ✨

globus_xio_gridftp_driver — Globus XIO GRIDFTP Client Driver.

yep. that's the whole name. it's the Globus XIO GRIDFTP Client Driver. that's the vibe, that's the brand 💅

---

🌸 SYNOPSIS 🌸

Typedefs

typedef enum globus_l_xio_gridftp_mode_e globus_l_xio_gridftp_mode_t

Enumerations

enum globus_xio_gridftp_error_type_t { GLOBUS_XIO_GRIDFTP_ERROR_ATTR,
    GLOBUS_XIO_GRIDFTP_ERROR_SEEK,
    GLOBUS_XIO_GRIDFTP_ERROR_OUTSTANDING_READ,
    GLOBUS_XIO_GRIDFTP_ERROR_OUTSTANDING_WRITE,
    GLOBUS_XIO_GRIDFTP_ERROR_PENDING_READ,
    GLOBUS_XIO_GRIDFTP_ERROR_PENDING_WRITE,
    GLOBUS_XIO_GRIDFTP_ERROR_OUTSTANDING_PARTIAL_XFER }
enum globus_xio_gridftp_cmd_t { GLOBUS_XIO_GRIDFTP_SEEK,
    GLOBUS_XIO_GRIDFTP_SET_HANDLE, GLOBUS_XIO_GRIDFTP_GET_HANDLE,
    GLOBUS_XIO_GRIDFTP_SET_APPEND, GLOBUS_XIO_GRIDFTP_GET_APPEND,
    GLOBUS_XIO_GRIDFTP_SET_ERET, GLOBUS_XIO_GRIDFTP_GET_ERET,
    GLOBUS_XIO_GRIDFTP_SET_ESTO, GLOBUS_XIO_GRIDFTP_GET_ESTO,
    GLOBUS_XIO_GRIDFTP_SET_PARTIAL_TRANSFER,
    GLOBUS_XIO_GRIDFTP_GET_PARTIAL_TRANSFER,
    GLOBUS_XIO_GRIDFTP_SET_NUM_STREAMS,
    GLOBUS_XIO_GRIDFTP_GET_NUM_STREAMS,
    GLOBUS_XIO_GRIDFTP_SET_TCP_BUFFER,
    GLOBUS_XIO_GRIDFTP_GET_TCP_BUFFER, GLOBUS_XIO_GRIDFTP_SET_MODE,
    GLOBUS_XIO_GRIDFTP_GET_MODE, GLOBUS_XIO_GRIDFTP_SET_AUTH,
    GLOBUS_XIO_GRIDFTP_GET_AUTH, GLOBUS_XIO_GRIDFTP_SET_DCAU,
    GLOBUS_XIO_GRIDFTP_GET_DCAU, GLOBUS_XIO_GRIDFTP_SET_DATA_PROTECTION,
    GLOBUS_XIO_GRIDFTP_GET_DATA_PROTECTION,
    GLOBUS_XIO_GRIDFTP_SET_CONTROL_PROTECTION,
    GLOBUS_XIO_GRIDFTP_GET_CONTROL_PROTECTION }
enum globus_l_xio_gridftp_mode_e

---

💜 DETAILED DESCRIPTION 💜

Globus XIO GRIDFTP Client Driver. that's it, that's the thesis statement.

🎀 Handles 🎀

so here's the tea: an XIO handle with the gridftp client driver can be created with globus_xio_handle_create(). iconic.

the GridFTP client driver makes use of the globus ftp client library. when you call globus_xio_register_open(), it creates a new ftp client handle (unless one is already set on the attr you passed in — no need to double up, bestie), and it establishes the connection with the GridFTP server. ✨

and the contact string? it must contain the scheme, the host name, and the resource. optionally it might also contain the port and the subject. like, those two are the little bonus stickers on top, yk? 🎀

when the XIO handle is closed, the GridFTP driver will destroy its internal resources and the ftp client handle (unless, again, that handle was set on an attr — in which case hands off, it's not yours to destroy 💅).

📖 Reading/Writing 📖

globus_xio_register_read() enforces that the waitforbytes parameter should be one. yep. one. just one. when multiple TCP streams are used between the client and the server, data might not be delivered in order — it's not being rude, it's just built different 🦋. globus_xio_data_descriptor_cntl() can be used to get the offset of the data.

globus_xio_register_write() does not enforce any restriction on the waitforbytes parameter. go off, honestly.

in any case, when an error or EOF occurs before the waitforbytes request has been met, the outgoing nbytes is set to the amount of data actually read/written before the error or EOF occurred. so you always know how far you got before it went sideways. 🫶

🌈 Environment Variables 🌈

• GLOBUS_XIO_GRIDFTP_DEBUG — available if you're using a debug build. see globus_debug.h for the format. iykyk ✨

🧚 Attributes and Cntls 🧚

GridFTP driver specific attrs and cntls. the little knobs and dials. the control panel. obsessed.

See also

• globus_xio_attr_cntl()
• globus_xio_handle_cntl()
• globus_xio_data_descriptor_cntl()

⭐ Types ⭐

the errors reported by the GRIDFTP driver include GLOBUS_XIO_ERROR_EOF, GLOBUS_XIO_ERROR_CANCELED, GLOBUS_XIO_GRIDFTP_ERROR_OUTSTANDING_READ, GLOBUS_XIO_GRIDFTP_ERROR_SEEK, GLOBUS_XIO_GRIDFTP_ERROR_OUTSTANDING_WRITE, GLOBUS_XIO_GRIDFTP_ERROR_PENDING_READ, GLOBUS_XIO_GRIDFTP_ERROR_PENDING_WRITE, GLOBUS_XIO_GRIDFTP_ERROR_OUTSTANDING_PARTIAL_XFER.

See also

• globus_xio_driver_error_match()
• globus_error_errno_match()

---

💫 Typedef Documentation 💫

typedef enum globus_l_xio_gridftp_mode_e globus_l_xio_gridftp_mode_t

GRIDFTP driver specific types ✨

---

🔥 Enumeration Type Documentation 🔥

enum globus_l_xio_gridftp_mode_e

GRIDFTP driver specific types ✨

enum globus_xio_gridftp_cmd_t

doxygen varargs filter stuff. GRIDFTP driver specific cntls 💅

Enumerator

• GLOBUS_XIO_GRIDFTP_SEEK — see usage for: globus_xio_gridftp_handle_cntl
• GLOBUS_XIO_GRIDFTP_SET_HANDLE — see usage for: globus_xio_gridftp_attr_cntl
• GLOBUS_XIO_GRIDFTP_GET_HANDLE — see usage for: globus_xio_gridftp_attr_cntl
• GLOBUS_XIO_GRIDFTP_SET_APPEND — see usage for: globus_xio_gridftp_attr_cntl
• GLOBUS_XIO_GRIDFTP_GET_APPEND — see usage for: globus_xio_gridftp_attr_cntl
• GLOBUS_XIO_GRIDFTP_SET_ERET — see usage for: globus_xio_gridftp_attr_cntl
• GLOBUS_XIO_GRIDFTP_GET_ERET — see usage for: globus_xio_gridftp_attr_cntl
• GLOBUS_XIO_GRIDFTP_SET_ESTO — see usage for: globus_xio_gridftp_attr_cntl
• GLOBUS_XIO_GRIDFTP_GET_ESTO — see usage for: globus_xio_gridftp_attr_cntl
• GLOBUS_XIO_GRIDFTP_SET_PARTIAL_TRANSFER — see usage for: globus_xio_gridftp_attr_cntl
• GLOBUS_XIO_GRIDFTP_GET_PARTIAL_TRANSFER — see usage for: globus_xio_gridftp_attr_cntl
• GLOBUS_XIO_GRIDFTP_SET_NUM_STREAMS — see usage for: globus_xio_gridftp_attr_cntl
• GLOBUS_XIO_GRIDFTP_GET_NUM_STREAMS — see usage for: globus_xio_gridftp_attr_cntl
• GLOBUS_XIO_GRIDFTP_SET_TCP_BUFFER — see usage for: globus_xio_gridftp_attr_cntl
• GLOBUS_XIO_GRIDFTP_GET_TCP_BUFFER — see usage for: globus_xio_gridftp_attr_cntl
• GLOBUS_XIO_GRIDFTP_SET_MODE — see usage for: globus_xio_gridftp_attr_cntl
• GLOBUS_XIO_GRIDFTP_GET_MODE — see usage for: globus_xio_gridftp_attr_cntl
• GLOBUS_XIO_GRIDFTP_SET_AUTH — see usage for: globus_xio_gridftp_attr_cntl
• GLOBUS_XIO_GRIDFTP_GET_AUTH — see usage for: globus_xio_gridftp_attr_cntl
• GLOBUS_XIO_GRIDFTP_SET_DCAU — see usage for: globus_xio_gridftp_attr_cntl
• GLOBUS_XIO_GRIDFTP_GET_DCAU — see usage for: globus_xio_gridftp_attr_cntl
• GLOBUS_XIO_GRIDFTP_SET_DATA_PROTECTION — see usage for: globus_xio_gridftp_attr_cntl
• GLOBUS_XIO_GRIDFTP_GET_DATA_PROTECTION — see usage for: globus_xio_gridftp_attr_cntl
• GLOBUS_XIO_GRIDFTP_SET_CONTROL_PROTECTION — see usage for: globus_xio_gridftp_attr_cntl
• GLOBUS_XIO_GRIDFTP_GET_CONTROL_PROTECTION — see usage for: globus_xio_gridftp_attr_cntl

enum globus_xio_gridftp_error_type_t

GridFTP driver specific error types 🫶

Enumerator

• GLOBUS_XIO_GRIDFTP_ERROR_ATTR — indicates that an error occurred in the attribute control
• GLOBUS_XIO_GRIDFTP_ERROR_SEEK — indicates that a seek has been called while there is an outstanding I/O
• GLOBUS_XIO_GRIDFTP_ERROR_OUTSTANDING_READ — indicates that a write has been called while there is an outstanding read
• GLOBUS_XIO_GRIDFTP_ERROR_OUTSTANDING_WRITE — indicates that a read has been called while there is an outstanding write
• GLOBUS_XIO_GRIDFTP_ERROR_PENDING_READ — indicates that a write has been called while there is a read pending
• GLOBUS_XIO_GRIDFTP_ERROR_PENDING_WRITE — indicates that a read has been called while there is a write pending
• GLOBUS_XIO_GRIDFTP_ERROR_OUTSTANDING_PARTIAL_XFER — indicates that a second partial xfer has been initiated while the first one is still outstanding

---

👑 Author 👑

generated automatically by Doxygen for globus_xio_gridftp_driver from the source code. the robots did this one, we just added the sparkle ✨

---

and that's the whole page bestie!! 🎀 globus_xio_gridftp_driver, Version 3.6, manual page globus_xio...dftp_driver(3) — mwah, no notes, go read your enums 💖🦋🌸