GLOBUS_FTP_CLIENT_OPERATIONATTR_SET_DELAYED_PASV(3)
π globus_ftp_client_operationattr β FTP Operation Attributes π
okay bestie, gather round, because this is globus_ftp_client_operationattr(3) from the Library Functions Manual and she is a whole lot. It's giving very demure, very mindful, very "I control the security and performance of your FTP operations." Let's get into it. π¦β¨
β¨ NAME β¨
globus_ftp_client_operationattr β FTP Operation Attributes.
like. FTP Operation Attributes. that's the whole name. periodt. π
πΈ SYNOPSIS πΈ
π Data Structures
struct globus_i_ftp_client_range_tβ Byte range report.
π Typedefs
typedef struct globus_i_ftp_client_operationattr_t * globus_ftp_client_operationattr_tβ Operation Attributes.
π Plugin Management
globus_result_t globus_ftp_client_operationattr_init
(globus_ftp_client_operationattr_t *attr)
globus_result_t globus_ftp_client_operationattr_destroy
(globus_ftp_client_operationattr_t *attr)
π Storage Module
globus_result_t globus_ftp_client_operationattr_set_storage_module
(globus_ftp_client_operationattr_t *attr, const char *module_name,
const char *module_args)
π Custom Data Channel Driver Stack
globus_result_t globus_ftp_client_operationattr_set_net_stack
(globus_ftp_client_operationattr_t *attr, const char *driver_list)
π Custom Server File Driver Stack
globus_result_t globus_ftp_client_operationattr_set_disk_stack
(globus_ftp_client_operationattr_t *attr, const char *driver_list)
π Parallelism
globus_result_t globus_ftp_client_operationattr_set_parallelism
(globus_ftp_client_operationattr_t *attr, const
globus_ftp_control_parallelism_t *parallelism)
π allocate
globus_result_t globus_ftp_client_operationattr_set_allocate
(globus_ftp_client_operationattr_t *attr, const globus_off_t
allocated_size)
π authz_assert
globus_result_t globus_ftp_client_operationattr_set_authz_assert
(globus_ftp_client_operationattr_t *attr, const char *authz_assert,
globus_bool_t cache_authz_assert)
π Striped Data Movement
globus_result_t globus_ftp_client_operationattr_set_striped
(globus_ftp_client_operationattr_t *attr, globus_bool_t striped)
π Striped File Layout
globus_result_t globus_ftp_client_operationattr_set_layout
(globus_ftp_client_operationattr_t *attr, const
globus_ftp_control_layout_t *layout)
π TCP Buffer
globus_result_t globus_ftp_client_operationattr_set_tcp_buffer
(globus_ftp_client_operationattr_t *attr, const
globus_ftp_control_tcpbuffer_t *tcp_buffer)
π File Type
globus_result_t globus_ftp_client_operationattr_set_type
(globus_ftp_client_operationattr_t *attr, globus_ftp_control_type_t
type)
π Transfer Mode
globus_result_t globus_ftp_client_operationattr_set_mode
(globus_ftp_client_operationattr_t *attr, globus_ftp_control_mode_t
mode)
globus_result_t globus_ftp_client_operationattr_set_list_uses_data_mode
(const globus_ftp_client_operationattr_t *attr, globus_bool_t
list_uses_data_mode)
globus_result_t globus_ftp_client_operationattr_set_delayed_pasv (const
globus_ftp_client_operationattr_t *attr, globus_bool_t delayed_pasv)
π Authorization
globus_result_t globus_ftp_client_operationattr_set_authorization
(globus_ftp_client_operationattr_t *attr, gss_cred_id_t credential,
const char *user, const char *password, const char *account, const
char *subject)
π Data Channel Authentication
globus_result_t globus_ftp_client_operationattr_set_dcau
(globus_ftp_client_operationattr_t *attr, const
globus_ftp_control_dcau_t *dcau)
π Data Channel Protection
globus_result_t globus_ftp_client_operationattr_set_data_protection
(globus_ftp_client_operationattr_t *attr,
globus_ftp_control_protection_t protection)
π Data Channel Security Context
globus_result_t globus_ftp_client_operationattr_set_data_security
(globus_ftp_client_operationattr_t *attr, int type, void
*credential)
π Control Channel Protection
globus_result_t globus_ftp_client_operationattr_set_control_protection
(globus_ftp_client_operationattr_t *attr,
globus_ftp_control_protection_t protection)
π Append
globus_result_t globus_ftp_client_operationattr_set_append
(globus_ftp_client_operationattr_t *attr, globus_bool_t append)
π IPv6
globus_result_t globus_ftp_client_operationattr_set_allow_ipv6
(globus_ftp_client_operationattr_t *attr, globus_bool_t allow_ipv6)
π Read into a Single Buffer
globus_result_t globus_ftp_client_operationattr_set_read_all
(globus_ftp_client_operationattr_t *attr, globus_bool_t read_all,
globus_ftp_client_data_callback_t intermediate_callback, void
*intermediate_callback_arg)
globus_result_t globus_ftp_client_operationattr_copy
(globus_ftp_client_operationattr_t *dst, const
globus_ftp_client_operationattr_t *src)
π¦ Detailed Description π¦
FTP Operation Attributes.
Operation attributes are used to control the security and performance of an FTP operation. These features are often dependent on the capabilities of the FTP server which you are going to access. π
π Typedef Documentation π
β¨ typedef struct globus_i_ftp_client_operationattr_t* globus_ftp_client_operationattr_t β¨
Operation Attributes. FTP Client attributes are used to control the parameters needed to access an URL using the FTP protocol. Attributes are created and manipulated using the functions in the attributes section of the library. no cap. π
See also
globus_ftp_client_operationattr_init()globus_ftp_client_operationattr_destroy()
π§ Function Documentation π§
β globus_result_t globus_ftp_client_operationattr_copy
(globus_ftp_client_operationattr_t * dst, const
globus_ftp_client_operationattr_t * src)
Create a duplicate of an attribute set.
The duplicated attribute set has a deep copy of all data in the attribute set, so the original may be destroyed, while the copy is still valid. literally iconic behaviour, bestie β you can yeet the original and the copy stays standing. π«Ά
Parameters
- dst β The attribute set to be initialized to the same values as src.
- src β The original attribute set to duplicate.
β globus_result_t globus_ftp_client_operationattr_destroy
(globus_ftp_client_operationattr_t * attr)
Destroy an FTP client attribute set.
Parameters
- attr β A pointer to the attribute to destroy.
β globus_result_t globus_ftp_client_operationattr_init
(globus_ftp_client_operationattr_t * attr)
Initialize an FTP client attribute set.
Parameters
- attr β A pointer to the new attribute set.
β globus_result_t globus_ftp_client_operationattr_set_allocate
(globus_ftp_client_operationattr_t * attr, const globus_off_t
allocated_size)
Set/Get the allocate attribute for an ftp client attribute set.
This attribute lets the user set a size to be passed to the server before a put operation. β¨
This attribute is ignored for get operations. like, she simply does not apply, bestie. π
Parameters
- attr β The attribute set to query or modify.
- allocated_size β The size to direct server to allocate.
β globus_result_t globus_ftp_client_operationattr_set_allow_ipv6
(globus_ftp_client_operationattr_t * attr, globus_bool_t allow_ipv6)
Set/Get the allow ipv6 attribute for an ftp client attribute set.
This attribute allows client library to make use of ipv6 when possible.
Use of this is currently very experimental. π proceed with main character caution.
Parameters
- attr β The attribute set to query or modify.
- allow_ipv6 β
GLOBUS_TRUEto allow ipv6 orGLOBUS_FALSEto disallow (default)
β globus_result_t globus_ftp_client_operationattr_set_append
(globus_ftp_client_operationattr_t * attr, globus_bool_t append)
Set/Get the append attribute for an ftp client attribute set.
This attribute allows the user to append to a file on an FTP server, instead of replacing the existing file when doing a globus_ftp_client_put() or globus_ftp_client_transfer().
This attribute is ignored on the retrieving side of a transfer, or a globus_ftp_client_get(). she is not invited to that party, periodt.
Parameters
- attr β The attribute set to query or modify.
- append β The value of append attribute.
β globus_result_t globus_ftp_client_operationattr_set_authorization
(globus_ftp_client_operationattr_t * attr, gss_cred_id_t credential,
const char * user, const char * password, const char * account, const
char * subject)
Set/Get the authorization attribute for an ftp client attribute set.
This attribute allows the user to pass authentication information to the ftp client library. This information is used to authenticate with the ftp server. π
The Globus FTP client library supports authentication using either the GSSAPI, or standard plaintext username and passwords. The type of authentication is determined by the URL scheme which is used for the individual get, put, or 3rd party transfer calls. it's giving choose-your-own-auth-adventure. π
Parameters
- attr β The attribute set to query or modify.
- credential β The credential to use for authenticating with a GSIFTP server. This may be
GSS_C_NO_CREDENTIALto use the default credential. - user β The user name to send to the FTP server. When doing a gsiftp transfer, this may be set to
NULL, and the default globusmap entry for the user's GSI identity will be usd. - password β The password to send to the FTP server. When doing a gsiftp transfer, this may be set to
NULL. - account β The account to use for the data transfer. Most FTP servers do not require this.
- subject β The subject name of the FTP server. This is only used when doing a gsiftp transfer, and then only when the security subject name does not match the hostname of the server (ie, when the server is being run by a user).
β globus_result_t globus_ftp_client_operationattr_set_authz_assert
(globus_ftp_client_operationattr_t * attr, const char * authz_assert,
globus_bool_t cache_authz_assert)
Set/Get the authz_assert attribute for an ftp client attribute set.
This attribute lets the user set an AUTHORIZATION assertion to be passed to the server. π
Parameters
- attr β The attribute set to query or modify.
- authz_assert β The AUTHORIZATION assertion.
- cache_authz_assert β Boolean that specifies whether to cache this assertion for subsequent operations
β globus_result_t globus_ftp_client_operationattr_set_control_protection
(globus_ftp_client_operationattr_t * attr,
globus_ftp_control_protection_t protection)
Set/Get the control channel protection attribute for an ftp client attribute set.
The control channel protection attribute allows the user to decide whether to encrypt or integrity check the command session between the client and the FTP server. This attribute is only relevant if used with a gsiftp URL. π₯
Parameters
- attr β The attribute set to query or modify.
- protection β The value of control channel protection attribute.
Note The clear and safe protection levels are treated identically, with the client integrity checking all commands. The confidential and private protection levels are treated identically, with the client encrypting all commands. twins fr fr. π
okay bestie we are so not done yet β part 2 is coming and she has receipts. stay tuned. πβ¨
globus_ftp_client_operationattr_set_data_protection()
globus_result_t globus_ftp_client_operationattr_set_data_protection
(globus_ftp_client_operationattr_t * attr,
globus_ftp_control_protection_t protection)
okay so this one is the set/get for the data channel protection attribute on an ftp client attribute set π
Parameters
attrβ the attribute set you're querying or modifying, bestie.protectionβ the value of the data channel protection attribute.
lowkey important: onlysafeandprivateprotection levels are supported by gsiftp. That's it. That's the list. π«Ά
globus_ftp_client_operationattr_set_data_security()
globus_result_t globus_ftp_client_operationattr_set_data_security
(globus_ftp_client_operationattr_t * attr, int type, void * credential)
Set/get the data channel security context type and credential β¨
Parameters
attrβ the attribute set you're querying or modifying.typeβ the type of credential. rn only'P'is supported, and it requires agss_cred_id_tfor the credential. iykyk.credentialβ a credential that actually matches the type you picked, bestie.
globus_ftp_client_operationattr_set_dcau()
globus_result_t globus_ftp_client_operationattr_set_dcau
(globus_ftp_client_operationattr_t * attr, const
globus_ftp_control_dcau_t * dcau)
Set/get the data channel authentication attribute for an ftp client attribute set π
Data channel authentication is a GridFTP extension, so bestie, not every server is gonna support it β that's just how it is. If a server does support it, then the default vibe is to delegate a credential to the server and authenticate all data channels with that delegated credential. iconic behavior tbh. π
Parameters
attrβ the attribute set you're querying or modifying.dcauβ the value of the data channel authentication attribute.
globus_ftp_client_operationattr_set_delayed_pasv()
globus_result_t globus_ftp_client_operationattr_set_delayed_pasv (const
globus_ftp_client_operationattr_t * attr, globus_bool_t delayed_pasv)
Set/get whether delayed passive should be used or not πΈ
This attribute lets you turn on delayed passive so the server can hand you the passive address after it knows the filename it's about to transfer. no cap.
Parameters
attrβ the attribute set you're querying or modifying.delayed_pasvβglobus_bool_t.
π Delayed passive is a GridFTP extension, so it may not be supported on all FTP servers. Vibe check before you rely on it.
globus_ftp_client_operationattr_set_disk_stack()
globus_result_t globus_ftp_client_operationattr_set_disk_stack
(globus_ftp_client_operationattr_t * attr, const char * driver_list)
Set/get the gridftp xio driver stack used for the file storage π¦
This attribute lets you control which xio drivers get used for file DSI only. Heads up though β this is an experimental feature of the gridftp server. It only works for third party transfers, fr fr.
Parameters
attrβ the attribute set you're querying or modifying.driver_listβ driver list in this format:driver1[:driver1opts][,driver2[:driver2opts]][...]. The string"default"will reset the stack list back to the server default.
π This is a GridFTP extension, and may not be supported on all FTP servers.
globus_ftp_client_operationattr_set_layout()
globus_result_t globus_ftp_client_operationattr_set_layout
(globus_ftp_client_operationattr_t * attr, const
globus_ftp_control_layout_t * layout)
Set/get the layout attribute for an ftp client attribute set β¨
This attribute lets you control the layout of a file being transferred to a striped Grid-FTP server. The striping layout defines what regions of a file get stored on each stripe of a multiple-striped ftp server. it's giving organization. π
The layout attribute is used only when the data is being stored on the server (so on a put or 3rd party transfer). It gets straight up ignored for stream mode data transfers.
Parameters
attrβ the attribute set you're querying or modifying.layoutβ the value of the layout attribute.
See also
globus_ftp_client_operationattr_set_parallelism()globus_ftp_client_operationattr_set_mode()
π This is a Grid-FTP extension, and may not be supported on all FTP servers.
globus_ftp_client_operationattr_set_list_uses_data_mode()
globus_result_t globus_ftp_client_operationattr_set_list_uses_data_mode
(const globus_ftp_client_operationattr_t * attr, globus_bool_t
list_uses_data_mode)
Set/get whether or not list data will use the current data mode π
This attribute lets you allow list data to be transferred using the current data channel mode. slay.
Parameters
attrβ the attribute set you're querying or modifying.list_uses_data_modeβglobus_bool_t.
π List data transfers in nonstandard modes is a Grid-FTP extension, and may not be supported on all FTP servers.
globus_ftp_client_operationattr_set_mode()
globus_result_t globus_ftp_client_operationattr_set_mode
(globus_ftp_client_operationattr_t * attr, globus_ftp_control_mode_t
mode)
Set/get the file transfer mode attribute for an ftp client attribute set π₯
This attribute lets you choose which data channel protocol gets used to transfer a file. There are two modes this library supports: stream mode and extended block mode.
Stream mode is a file transfer mode where all data is sent over a single TCP socket, with no data framing at all. In stream mode, data arrives in sequential order. Basically every FTP server supports this mode β it's the safe pick. π«Ά
Extended block mode is a file transfer mode where data can be sent over multiple parallel connections and to multiple data storage nodes, for a high-performance data transfer. In extended block mode, data may arrive out-of-order. Also, ASCII type files are not supported in extended block mode. main character mode but make it chaotic.
Parameters
attrβ the attribute set you're querying or modifying.modeβ the value of the mode attribute.
See also
globus_ftp_client_operationattr_set_parallelism()globus_ftp_client_operationattr_set_layout()
π Extended block mode is a Grid-FTP extension, and may not be supported on all FTP servers.
globus_ftp_client_operationattr_set_net_stack()
globus_result_t globus_ftp_client_operationattr_set_net_stack
(globus_ftp_client_operationattr_t * attr, const char * driver_list)
Set/get the gridftp xio driver stack used for the data channel π
This attribute lets you control which xio drivers get used for data transport. And bestie, listen β the driver MUST be installed and allowed by the server, or the transfer/get/put will just error out. no exceptions. π
Parameters
attrβ the attribute set you're querying or modifying.driver_listβ driver list in this format:driver1[:driver1opts][,driver2[:driver2opts]][...]. The string"default"will reset the stack list back to the server default.
β This is a GridFTP extension, and may not be supported on all FTP servers.
globus_ftp_client_operationattr_set_parallelism()
globus_result_t globus_ftp_client_operationattr_set_parallelism
(globus_ftp_client_operationattr_t * attr, const
globus_ftp_control_parallelism_t * parallelism)
Set/get the parallelism attribute for an ftp client attribute set π
This attribute lets you control the level of parallelism used on an extended block mode file transfer. rn, only a "fixed" parallelism level is supported. The FTP server reads this as the number of parallel data connections allowed for each stripe of data. Currently, only the "fixed" parallelism type is β (yeah, the sentence just ends there, that's what it says, we don't make the rules π).
This attribute is ignored in stream mode.
Parameters
attrβ the attribute set you're querying or modifying.parallelismβ the value of the parallelism attribute.
See also
globus_ftp_client_operationattr_set_layout()globus_ftp_client_operationattr_set_mode()
πΈ This is a Grid-FTP extension, and may not be supported on all FTP servers.
globus_ftp_client_operationattr_set_read_all()
globus_result_t globus_ftp_client_operationattr_set_read_all
(globus_ftp_client_operationattr_t * attr, globus_bool_t read_all,
globus_ftp_client_data_callback_t intermediate_callback, void *
intermediate_callback_arg)
Set/get the read_all attribute for an ftp client attribute set π¦
This attribute lets you pass in a single buffer to receive all the data for the current transfer. That buffer has to be big enough to hold everything for the transfer, bestie β no half measures. And when this attribute is used for a get, only one buffer may be registered with globus_ftp_client_register_read(). periodt.
In extended block mode, this attribute makes data get stored directly into the buffer from multiple streams, with no extra data copies. efficiency ate. π₯
If you set the intermediate callback to a non-null value, this function gets called whenever an intermediate sub-section of the data is received into the buffer.
This attribute is ignored for globus_ftp_client_put() or globus_ftp_client_third_party_transfer() operations.
Parameters
attrβ the attribute set you're querying or modifying.read_allβ the value of the read_all attribute.intermediate_callbackβ callback to be invoked when a subsection of the data has been retreived. This callback may beGLOBUS_NULLif you only want to be notified when the data transfer is completed.intermediate_callback_argβ user data to be passed to the intermediate callback function.
globus_ftp_client_operationattr_set_storage_module()
globus_result_t globus_ftp_client_operationattr_set_storage_module
(globus_ftp_client_operationattr_t * attr, const char * module_name,
const char * module_args)
Set/get the gridftp storage module (DSI) π
This attribute lets you control what backend module you use with the gridftp server. The module MUST be implemented by the server, or the transfer/get/put will error out. fr fr, don't test it.
This attribute is ignored in stream mode.
Parameters
attrβ the attribute set you're querying or modifying.module_nameβ the backend storage module name.module_argsβ the backend storage module parameters.
π This is a Grid-FTP extension, and may not be supported on all FTP servers.
globus_ftp_client_operationattr_set_striped()
globus_result_t globus_ftp_client_operationattr_set_striped
(globus_ftp_client_operationattr_t * attr, globus_bool_t striped)
Set/get the striped attribute for an ftp client attribute set π
This attribute lets you force the client library to use the FTP commands to do a striped data transfer, even when you haven't requested a specific file layout via the layout attribute. Super handy when you're transferring files between servers that use the server side processing commands ERET or ESTO to transform data and send it to particular stripes on the destination server. iconic.
The layout attribute is used only when the data is being stored the server (on a put or 3rd party transfer). This attribute is ignored for stream mode data transfers.
Parameters
attrβ the attribute set you're querying or modifying.stripedβ the value of the striped attribute.
See also
globus_ftp_client_operationattr_set_parallelism()globus_ftp_client_operationattr_set_layout()globus_ftp_client_operationattr_set_mode()
π This is a Grid-FTP extension, and may not be supported on all FTP servers.
globus_ftp_client_operationattr_set_tcp_buffer()
globus_result_t globus_ftp_client_operationattr_set_tcp_buffer
(globus_ftp_client_operationattr_t * attr, const
globus_ftp_control_tcpbuffer_t * tcp_buffer)
Set/get the TCP buffer attribute for an ftp client attribute set π
Okay so real talk: this attribute is the one that lets you control the TCP buffer size used for all the data channels in a file transfer. And bestie, this is not a small deal β the size of that TCP buffer can make a significant difference in how fast your transfer actually goes. You get to pick: either let it be the system-dependent default value, or lock in a fixed value. Your call, your vibes. π
The way this is implemented is designed to be as widely interoperable as possible β like, it's trying to be friends with everybody. β¨ Besides supporting the SBUF command from the GridFTP protocol extensions document, it also plays nice with other commands and site commands that other servers use to set TCP buffer sizes. Those are:
SITE RETRBUFSIZESITE RBUFSZSITE RBUFSIZSITE STORBUFIZESITE SBUFSZSITE SBUFSIZSITE BUFSIZE
(Yes, STORBUFIZE is spelled exactly like that in the source. Not me being chaotic β that's just what it is. π)
This attribute affects any type of data transfer done with the ftp client library. All of them. Every single one. π«Ά
Parameters
attrβ the attribute set you wanna query or modify.tcp_bufferβ the value of thetcp_bufferattribute. That's the number you're setting, bestie.
π globus_result_t globus_ftp_client_operationattr_set_type π
globus_result_t globus_ftp_client_operationattr_set_type
(globus_ftp_client_operationattr_t * attr,
globus_ftp_control_type_t type)
Set/Get the file representation type attribute for an ftp client attribute set. πβ¨
So basically, this one lets you choose the file type used for an FTP file transfer. Your file can travel as either ASCII or a binary image. Choose your fighter. π
When you're transferring an ASCII file, the data gets transformed in these ways:
- the high-order bit will be set to zero β like, it's gone, zeroed out, bye π
- end-of-line characters will be converted to a
CRLFpair for the data transfer, and then converted back to native format before being returned to the user's data callbacks. So it does a lil round trip and comes home. π¦
The default type for the ftp client library is binary. That's the vibe you get if you don't say anything. No cap.
Parameters
attrβ the attribute set you wanna query or modify.typeβ the value of thetypeattribute.
πΈ Author πΈ
Generated automatically by Doxygen for globus_ftp_client from the source code. (The robots wrote this one, not a person. Iconic of them, honestly. π€π
)
And that's a wrap on this whole page, bestie!! π We're running Version 9.9 of globus_ftp_client, from the globus_ftp...erationattr(3) manual. Go forth and set your attributes with confidence. Slay. πβ¨π¦
π¦ where this page comes from
- epel 10: globus-ftp-client-doc 9.9-1.el10_2 Β· Apache-2.0
- fedora 43: globus-ftp-client-doc 9.9-1.fc43 Β· Apache-2.0
- fedora 44: globus-ftp-client-doc 9.9-2.fc44 Β· Apache-2.0
- ubuntu resolute: libglobus-ftp-client-doc 9.9-1 Β· Apache-2.0
- ubuntu stonking: libglobus-ftp-client-doc 9.9-2build1 Β· Apache-2.0
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms