globus_ftp_client_plugin.h

Go to the documentation of this file.

/*
 * Copyright 1999-2006 University of Chicago
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef GLOBUS_FTP_CLIENT_PLUGIN_H
#define GLOBUS_FTP_CLIENT_PLUGIN_H

#include "globus_ftp_client.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef enum
{
    GLOBUS_FTP_CLIENT_CMD_MASK_NONE =    0,

    GLOBUS_FTP_CLIENT_CMD_MASK_CONTROL_ESTABLISHMENT    = 1<<0,

    GLOBUS_FTP_CLIENT_CMD_MASK_DATA_ESTABLISHMENT   = 1<<1,

    GLOBUS_FTP_CLIENT_CMD_MASK_TRANSFER_PARAMETERS  = 1<<2,

    GLOBUS_FTP_CLIENT_CMD_MASK_TRANSFER_MODIFIERS   = 1<<3,

    GLOBUS_FTP_CLIENT_CMD_MASK_FILE_ACTIONS     = 1<<4,

    GLOBUS_FTP_CLIENT_CMD_MASK_INFORMATION      = 1<<5,

    GLOBUS_FTP_CLIENT_CMD_MASK_MISC         = 1<<6,

    GLOBUS_FTP_CLIENT_CMD_MASK_BUFFER           = 1<<7,

    GLOBUS_FTP_CLIENT_CMD_MASK_ALL          = 0x7fffffff
}
globus_ftp_client_plugin_command_mask_t;


typedef globus_ftp_client_plugin_t * (*globus_ftp_client_plugin_copy_t)(
    globus_ftp_client_plugin_t *        plugin_template,
    void *                  plugin_specific);

typedef void (*globus_ftp_client_plugin_destroy_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific);

typedef void (*globus_ftp_client_plugin_connect_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    const char *                url);

typedef void (*globus_ftp_client_plugin_authenticate_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_control_auth_info_t *  auth_info);

typedef void (*globus_ftp_client_plugin_chmod_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    int                         mode,
    const globus_ftp_client_operationattr_t *   attr,
    globus_bool_t               restart);

typedef void (*globus_ftp_client_plugin_chgrp_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const char *                group,
    const globus_ftp_client_operationattr_t *   attr,
    globus_bool_t               restart);

typedef void (*globus_ftp_client_plugin_utime_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const struct tm *           utime_time,
    const globus_ftp_client_operationattr_t *   attr,
    globus_bool_t               restart);

typedef void (*globus_ftp_client_plugin_symlink_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const char *                utime_time,
    const globus_ftp_client_operationattr_t *   attr,
    globus_bool_t               restart);

typedef void (*globus_ftp_client_plugin_cksm_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    globus_off_t                offset,
    globus_off_t                length,
    const char *                algorithm,
    const globus_ftp_client_operationattr_t *   attr,
    globus_bool_t               restart);

typedef void (*globus_ftp_client_plugin_delete_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_client_operationattr_t *   attr,
    globus_bool_t               restart);

typedef void (*globus_ftp_client_plugin_feat_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_client_operationattr_t *   attr,
    globus_bool_t               restart);

typedef void (*globus_ftp_client_plugin_mkdir_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_client_operationattr_t *   attr,
    globus_bool_t               restart);

typedef void (*globus_ftp_client_plugin_rmdir_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_client_operationattr_t *   attr,
    globus_bool_t               restart);


typedef void (*globus_ftp_client_plugin_list_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_client_operationattr_t *   attr,
    globus_bool_t               restart);

typedef void (*globus_ftp_client_plugin_verbose_list_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_client_operationattr_t *   attr,
    globus_bool_t               restart);

typedef void (*globus_ftp_client_plugin_machine_list_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_client_operationattr_t *   attr,
    globus_bool_t               restart);

typedef void (*globus_ftp_client_plugin_recursive_list_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_client_operationattr_t *   attr,
    globus_bool_t               restart);

typedef void (*globus_ftp_client_plugin_mlst_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_client_operationattr_t *   attr,
    globus_bool_t               restart);


typedef void (*globus_ftp_client_plugin_stat_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_client_operationattr_t *   attr,
    globus_bool_t               restart);


typedef void (*globus_ftp_client_plugin_move_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    const char *                source_url,
    const char *                dest_url,
    const globus_ftp_client_operationattr_t *   attr,
    globus_bool_t               restart);

typedef void (*globus_ftp_client_plugin_get_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_client_operationattr_t *   attr,
    globus_bool_t               restart);

typedef void (*globus_ftp_client_plugin_put_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_client_operationattr_t *   attr,
    globus_bool_t               restart);

typedef void (*globus_ftp_client_plugin_third_party_transfer_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    const char *                source_url,
    const globus_ftp_client_operationattr_t *   source_attr,
    const char *                dest_url,
    const globus_ftp_client_operationattr_t *   dest_attr,
    globus_bool_t               restart);

typedef void (*globus_ftp_client_plugin_modification_time_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_client_operationattr_t *   attr,
    globus_bool_t               restart);

typedef void (*globus_ftp_client_plugin_size_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_client_operationattr_t *   attr,
    globus_bool_t               restart);

typedef void (*globus_ftp_client_plugin_abort_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle);

typedef void (*globus_ftp_client_plugin_read_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    const globus_byte_t *           buffer,
    globus_size_t               buffer_length);

typedef void (*globus_ftp_client_plugin_write_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    const globus_byte_t *           buffer,
    globus_size_t               buffer_length,
    globus_off_t                offset,
    globus_bool_t               eof);

typedef void (*globus_ftp_client_plugin_data_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    globus_object_t *               error,
    const globus_byte_t *           buffer,
    globus_size_t               length,
    globus_off_t                offset,
    globus_bool_t               eof);

typedef void (*globus_ftp_client_plugin_command_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const char *                command);

typedef void (*globus_ftp_client_plugin_response_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    globus_object_t *               error,
    const globus_ftp_control_response_t *   ftp_response);

typedef void (*globus_ftp_client_plugin_fault_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    globus_object_t *               error);

typedef void (*globus_ftp_client_plugin_complete_t)(
    globus_ftp_client_plugin_t *        plugin,
    void *                  plugin_specific,
    globus_ftp_client_handle_t *        handle);


/* Plugin Implementation API */
globus_result_t
globus_ftp_client_plugin_restart_list(
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_client_operationattr_t *   attr,
    const globus_abstime_t *                when);

globus_result_t
globus_ftp_client_plugin_restart_verbose_list(
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_client_operationattr_t *   attr,
    const globus_abstime_t *                when);

globus_result_t
globus_ftp_client_plugin_restart_machine_list(
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_client_operationattr_t *   attr,
    const globus_abstime_t *                when);

globus_result_t
globus_ftp_client_plugin_restart_recursive_list(
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_client_operationattr_t *   attr,
    const globus_abstime_t *                when);

globus_result_t
globus_ftp_client_plugin_restart_mlst(
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_client_operationattr_t *   attr,
    const globus_abstime_t *                when);

globus_result_t
globus_ftp_client_plugin_restart_stat(
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_client_operationattr_t *   attr,
    const globus_abstime_t *                when);

globus_result_t
globus_ftp_client_plugin_restart_delete(
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_client_operationattr_t *   attr,
    const globus_abstime_t *                when);

globus_result_t
globus_ftp_client_plugin_restart_chmod(
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    int                                         mode,
    const globus_ftp_client_operationattr_t *   attr,
    const globus_abstime_t *                when);

globus_result_t
globus_ftp_client_plugin_restart_chgrp(
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const char *                group,
    const globus_ftp_client_operationattr_t *   attr,
    const globus_abstime_t *                when);

globus_result_t
globus_ftp_client_plugin_restart_utime(
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const struct tm *           utime_time,
    const globus_ftp_client_operationattr_t *   attr,
    const globus_abstime_t *                when);

globus_result_t
globus_ftp_client_plugin_restart_symlink(
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const char *                link_url,
    const globus_ftp_client_operationattr_t *   attr,
    const globus_abstime_t *                when);

globus_result_t
globus_ftp_client_plugin_restart_cksm(
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    globus_off_t                offset,
    globus_off_t                length,
    const char *                algorithm,
    const globus_ftp_client_operationattr_t *   attr,
    const globus_abstime_t *                when);

globus_result_t
globus_ftp_client_plugin_restart_feat(
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_client_operationattr_t *   attr,
    const globus_abstime_t *                when);

globus_result_t
globus_ftp_client_plugin_restart_mkdir(
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_client_operationattr_t *   attr,
    const globus_abstime_t *                when);

globus_result_t
globus_ftp_client_plugin_restart_rmdir(
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_client_operationattr_t *   attr,
    const globus_abstime_t *                when);

globus_result_t
globus_ftp_client_plugin_restart_move(
    globus_ftp_client_handle_t *        handle,
    const char *                source_url,
    const char *                dest_url,
    const globus_ftp_client_operationattr_t *   attr,
    const globus_abstime_t *                when);

globus_result_t
globus_ftp_client_plugin_restart_get(
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_client_operationattr_t *   attr,
    globus_ftp_client_restart_marker_t *    restart_marker,
    const globus_abstime_t *                when);

globus_result_t
globus_ftp_client_plugin_restart_put(
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_client_operationattr_t *   attr,
    globus_ftp_client_restart_marker_t *    restart_marker,
    const globus_abstime_t *                when);

globus_result_t
globus_ftp_client_plugin_restart_third_party_transfer(
    globus_ftp_client_handle_t *        handle,
    const char *                source_url,
    const globus_ftp_client_operationattr_t *   source_attr,
    const char *                dest_url,
    const globus_ftp_client_operationattr_t *   dest_attr,
    globus_ftp_client_restart_marker_t *    restart_marker,
    const globus_abstime_t *                when);

globus_result_t
globus_ftp_client_plugin_restart_size(
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_client_operationattr_t *   attr,
    const globus_abstime_t *                when);

globus_result_t
globus_ftp_client_plugin_restart_modification_time(
    globus_ftp_client_handle_t *        handle,
    const char *                url,
    const globus_ftp_client_operationattr_t *   attr,
    const globus_abstime_t *                when);

globus_result_t
globus_ftp_client_plugin_restart_get_marker(
    globus_ftp_client_handle_t *        handle,
    globus_ftp_client_restart_marker_t *    marker);

globus_result_t
globus_ftp_client_plugin_abort(
    globus_ftp_client_handle_t *        handle);

globus_result_t
globus_ftp_client_plugin_add_data_channels(
    globus_ftp_client_handle_t *        handle,
    unsigned int                num_channels,
    unsigned int                stripe);

globus_result_t
globus_ftp_client_plugin_remove_data_channels(
    globus_ftp_client_handle_t *        handle,
    unsigned int                num_channels,
    unsigned int                stripe);

globus_result_t
globus_ftp_client_plugin_init(
    globus_ftp_client_plugin_t *        plugin,
    const char *                plugin_name,
    globus_ftp_client_plugin_command_mask_t command_mask,
    void *                  plugin_specific);

globus_result_t
globus_ftp_client_plugin_destroy(
    globus_ftp_client_plugin_t *        plugin);

globus_result_t
globus_ftp_client_plugin_get_plugin_specific(
    globus_ftp_client_plugin_t *        plugin,
    void **                 plugin_specific);

globus_result_t
globus_ftp_client_plugin_set_copy_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_copy_t     copy);

globus_result_t
globus_ftp_client_plugin_set_destroy_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_destroy_t      destroy);

globus_result_t
globus_ftp_client_plugin_set_chmod_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_chmod_t        chmod_func);

globus_result_t
globus_ftp_client_plugin_set_chgrp_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_chgrp_t        chgrp_func);

globus_result_t
globus_ftp_client_plugin_set_utime_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_utime_t        utime_func);
    
globus_result_t
globus_ftp_client_plugin_set_symlink_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_symlink_t        symlink_func);

globus_result_t
globus_ftp_client_plugin_set_cksm_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_cksm_t     cksm_func);

globus_result_t
globus_ftp_client_plugin_set_delete_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_delete_t       delete_func);

globus_result_t
globus_ftp_client_plugin_set_feat_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_feat_t     feat_func);

globus_result_t
globus_ftp_client_plugin_set_mkdir_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_mkdir_t        mkdir_func);

globus_result_t
globus_ftp_client_plugin_set_rmdir_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_rmdir_t        rmdir_func);

globus_result_t
globus_ftp_client_plugin_set_move_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_move_t     move_func);

globus_result_t
globus_ftp_client_plugin_set_verbose_list_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_verbose_list_t verbose_list_func);

globus_result_t
globus_ftp_client_plugin_set_machine_list_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_machine_list_t machine_list_func);

globus_result_t
globus_ftp_client_plugin_set_recursive_list_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_recursive_list_t recursive_list_func);

globus_result_t
globus_ftp_client_plugin_set_list_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_list_t     list_func);

globus_result_t
globus_ftp_client_plugin_set_mlst_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_mlst_t     mlst_func);

globus_result_t
globus_ftp_client_plugin_set_stat_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_stat_t     stat_func);

globus_result_t
globus_ftp_client_plugin_set_get_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_get_t      get_func);

globus_result_t
globus_ftp_client_plugin_set_put_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_put_t      put_func);

globus_result_t
globus_ftp_client_plugin_set_third_party_transfer_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_third_party_transfer_t
                        third_party_transfer_func);

globus_result_t
globus_ftp_client_plugin_set_modification_time_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_modification_time_t
                        modification_time_func);
globus_result_t
globus_ftp_client_plugin_set_size_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_size_t     size_func);

globus_result_t
globus_ftp_client_plugin_set_abort_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_abort_t        abort_func);

globus_result_t
globus_ftp_client_plugin_set_connect_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_connect_t      connect_func);

globus_result_t
globus_ftp_client_plugin_set_authenticate_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_authenticate_t auth_func);

globus_result_t
globus_ftp_client_plugin_set_read_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_read_t     read_func);

globus_result_t
globus_ftp_client_plugin_set_write_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_write_t        write_func);

globus_result_t
globus_ftp_client_plugin_set_data_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_data_t     data_func);

globus_result_t
globus_ftp_client_plugin_set_command_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_command_t      command_func);

globus_result_t
globus_ftp_client_plugin_set_response_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_response_t     response_func);

globus_result_t
globus_ftp_client_plugin_set_fault_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_fault_t        fault_func);

globus_result_t
globus_ftp_client_plugin_set_complete_func(
    globus_ftp_client_plugin_t *        plugin,
    globus_ftp_client_plugin_complete_t     complete_func);

#ifdef __cplusplus
}
#endif

#endif /* GLOBUS_FTP_CLIENT_PLUGIN_H */