globus_i_ftp_client_plugin_t Struct Reference
[Plugins]

FTP Client Plugin.Each plugin implementation should define a method for initializing one of these structures. Plugins may be implemented as either a static function table, or a specialized plugin with plugin-specific attributes. More...

#include <globus_i_ftp_client.h>

Data Fields

char * plugin_name
globus_ftp_client_plugin_tplugin
globus_ftp_client_plugin_copy_t copy_func
globus_ftp_client_plugin_destroy_t destroy_func
globus_ftp_client_plugin_command_mask_t command_mask
void * plugin_specific

Detailed Description

FTP Client Plugin.

Each plugin implementation should define a method for initializing one of these structures. Plugins may be implemented as either a static function table, or a specialized plugin with plugin-specific attributes.

Each plugin function may be either GLOBUS_NULL, or a valid function pointer. If the function is GLOBUS_NULL, then the plugin will not be notified when the corresponding event happens.

Examples:

globus_ftp_client_debug_plugin.example, and globus_ftp_client_restart_plugin.example.


Field Documentation

Command Mask

The bits set in this mask determine which command responses the plugin is interested in. The command_mask should be a bitwise-or of the values in the globus_ftp_client_plugin_command_mask_t enumeration.

Plugin function pointers.

Plugin function pointers.

The value the user/plugin implementation passed into the plugin handling parts of the API.

Plugin name.

The plugin name is used by the FTP Client library to detect multiple instances of the same plugin being associated with a globus_ftp_client_handleattr_t or globus_ftp_client_handle_t.

Each plugin type should have a unique plugin name, which must be a NULL-terminated string of arbitrary length.

This pointer is reserved for plugin-specific data


The documentation for this struct was generated from the following file:
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines

Generated on 12 Dec 2014 for globus_ftp_client by  doxygen 1.6.1