---
name: "globus_ftp_client_throughput_plugin.h"
section: "3"
platform: "linux"
package: "libglobus-ftp-client-doc"
version: "9.8-4"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/globus_ftp_client_throughput_plugin.h"
---

# globus\_ftp\_client\_throughput\_plugin.h(3)

GridFTP Throughput Performance Plugin Implementation.

## NAME

globus\_ftp\_client\_throughput\_plugin.h - GridFTP Throughput Performance Plugin Implementation.

## SYNOPSIS

`#include 'globus_ftp_client.h'`\
 `#include 'globus_ftp_client_plugin.h'`\

### Macros

\#define **GLOBUS\_FTP\_CLIENT\_THROUGHPUT\_PLUGIN\_MODULE**   (&globus\_i\_ftp\_client\_throughput\_plugin\_module)\

### Typedefs

typedef void(\* **globus\_ftp\_client\_throughput\_plugin\_begin\_cb\_t**) (void \*user\_specific, **globus\_ftp\_client\_handle\_t** \*handle, const char \*source\_url, const char \*dest\_url)\
 typedef void(\* **globus\_ftp\_client\_throughput\_plugin\_stripe\_cb\_t**) (void \*user\_specific, **globus\_ftp\_client\_handle\_t** \*handle, int stripe\_ndx, globus\_off\_t bytes, float instantaneous\_throughput, float avg\_throughput)\
 typedef void(\* **globus\_ftp\_client\_throughput\_plugin\_total\_cb\_t**) (void \*user\_specific, **globus\_ftp\_client\_handle\_t** \*handle, globus\_off\_t bytes, float instantaneous\_throughput, float avg\_throughput)\
 typedef void(\* **globus\_ftp\_client\_throughput\_plugin\_complete\_cb\_t**) (void \*user\_specific, **globus\_ftp\_client\_handle\_t** \*handle, globus\_bool\_t success)\
 typedef void \*(\* **globus\_ftp\_client\_throughput\_plugin\_user\_copy\_cb\_t**) (void \*user\_specific)\
 typedef void(\* **globus\_ftp\_client\_throughput\_plugin\_user\_destroy\_cb\_t**) (void \*user\_specific)\

### Functions

globus\_result\_t **globus\_ftp\_client\_throughput\_plugin\_init** (**globus\_ftp\_client\_plugin\_t** \*plugin, **globus\_ftp\_client\_throughput\_plugin\_begin\_cb\_t** begin\_cb, **globus\_ftp\_client\_throughput\_plugin\_stripe\_cb\_t** per\_stripe\_cb, **globus\_ftp\_client\_throughput\_plugin\_total\_cb\_t** total\_cb, **globus\_ftp\_client\_throughput\_plugin\_complete\_cb\_t** complete\_cb, void \*user\_specific)\
 globus\_result\_t **globus\_ftp\_client\_throughput\_plugin\_set\_copy\_destroy** (**globus\_ftp\_client\_plugin\_t** \*plugin, **globus\_ftp\_client\_throughput\_plugin\_user\_copy\_cb\_t** copy\_cb, **globus\_ftp\_client\_throughput\_plugin\_user\_destroy\_cb\_t** destroy\_cb)\
 globus\_result\_t **globus\_ftp\_client\_throughput\_plugin\_destroy** (**globus\_ftp\_client\_plugin\_t** \*plugin)\
 globus\_result\_t **globus\_ftp\_client\_throughput\_plugin\_get\_user\_specific** (**globus\_ftp\_client\_plugin\_t** \*plugin, void \*\*user\_specific)\

## Detailed Description

GridFTP Throughput Performance Plugin Implementation.

## Author

Generated automatically by Doxygen for globus\_ftp\_client from the source code.