/usr/include/globus/globus_ftp_client_perf_plugin.h is in libglobus-ftp-client-dev 7.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 | /*
* 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_INCLUDE_FTP_CLIENT_PERF_PLUGIN_H
#define GLOBUS_INCLUDE_FTP_CLIENT_PERF_PLUGIN_H
#ifndef GLOBUS_DONT_DOCUMENT_INTERNAL
/**
* @file globus_ftp_client_perf_plugin.h GridFTP Performance Marker Plugin Implementation
*
* $RCSfile: globus_ftp_client_perf_plugin.h,v $
* $Revision: 1.7 $
* $Date: 2006/01/19 05:54:53 $
* $Author: mlink $
*/
#endif
/**
* @defgroup globus_ftp_client_perf_plugin Performance Marker Plugin
* @ingroup globus_ftp_client_plugins
*
* The FTP Performance Marker plugin allows the user to obtain
* performance markers for all types of transfers except a
* third party transfer in which Extended Block mode is not enabled.
*
* These markers may be generated internally, or they may be received
* from a server ('put' or third_party_transfer' only).
*
* Copy constructor and destructor callbacks are also provided to allow
* one to more easily layer other plugins on top of this one.
*/
#include "globus_ftp_client.h"
#include "globus_ftp_client_plugin.h"
#ifndef EXTERN_C_BEGIN
#ifdef __cplusplus
#define EXTERN_C_BEGIN extern "C" {
#define EXTERN_C_END }
#else
#define EXTERN_C_BEGIN
#define EXTERN_C_END
#endif
#endif
EXTERN_C_BEGIN
/** Module descriptor
* @ingroup globus_ftp_client_perf_plugin
*/
#define GLOBUS_FTP_CLIENT_PERF_PLUGIN_MODULE (&globus_i_ftp_client_perf_plugin_module)
extern
globus_module_descriptor_t globus_i_ftp_client_perf_plugin_module;
/**
* Transfer begin callback
* @ingroup globus_ftp_client_perf_plugin
*
* This callback is called when a get, put, or third party transfer is
* started. Note that it is possible for this callback to be made multiple
* times before ever receiving the complete callback... this would be the case
* if a transfer was restarted. The 'restart' will indicate whether or not we
* have been restarted.
*
* @param handle
* this the client handle that this transfer will be occurring on
*
* @param user_specific
* this is user specific data either created by the copy method,
* or, if a copy method was not specified, the value passed to
* init
*
* @param source_url
* source of the transfer (GLOBUS_NULL if 'put')
*
* @param dest_url
* dest of the transfer (GLOBUS_NULL if 'get')
*
* @param restart
* boolean indicating whether this callback is result of a restart
*
* @return
* - n/a
*/
typedef void (*globus_ftp_client_perf_plugin_begin_cb_t)(
void * user_specific,
globus_ftp_client_handle_t * handle,
const char * source_url,
const char * dest_url,
globus_bool_t restart);
/**
* Performance marker received callback
* @ingroup globus_ftp_client_perf_plugin
*
* This callback is called for all types of transfers except a third
* party in which extended block mode is not used (because 112 perf markers
* wont be sent in that case). For extended mode 'put' and '3pt', actual 112
* perf markers will be used and the frequency of this callback is dependent
* upon the frequency those messages are received. For 'put' in which
* extended block mode is not enabled and 'get' transfers, the information in
* this callback will be determined locally and the frequency of this callback
* will be at a maximum of one per second.
*
* @param handle
* this the client handle that this transfer is occurring on
*
* @param user_specific
* this is user specific data either created by the copy method,
* or, if a copy method was not specified, the value passed to
* init
*
* @param time_stamp
* the timestamp at which the number of bytes is valid
*
* @param stripe_ndx
* the stripe index this data refers to
*
* @param num_stripes total number of stripes involved in this transfer
*
* @param nbytes
* the total bytes transfered on this stripe
*
* @return
* - n/a
*/
typedef void (*globus_ftp_client_perf_plugin_marker_cb_t)(
void * user_specific,
globus_ftp_client_handle_t * handle,
long time_stamp_int,
char time_stamp_tength,
int stripe_ndx,
int num_stripes,
globus_off_t nbytes);
/**
* Transfer complete callback
* @ingroup globus_ftp_client_perf_plugin
*
* This callback will be called upon transfer completion (successful or
* otherwise)
*
* @param handle
* this the client handle that this transfer was occurring on
*
* @param user_specific
* this is user specific data either created by the copy method,
* or, if a copy method was not specified, the value passed to
* init
*
* @param success
* indicates whether this transfer completed successfully or was
* interrupted (by error or abort)
*
* @return
* - n/a
*/
typedef void (*globus_ftp_client_perf_plugin_complete_cb_t)(
void * user_specific,
globus_ftp_client_handle_t * handle,
globus_bool_t success);
/**
* Copy constructor
* @ingroup globus_ftp_client_perf_plugin
*
* This callback will be called when a copy of this plugin is made,
* it is intended to allow initialization of a new user_specific data
*
* @param user_specific
* this is user specific data either created by this copy
* method, or the value passed to init
*
* @return
* - a pointer to a user specific piece of data
* - GLOBUS_NULL (does not indicate error)
*/
typedef void * (*globus_ftp_client_perf_plugin_user_copy_cb_t)(
void * user_specific);
/**
* Destructor
* @ingroup globus_ftp_client_perf_plugin
*
* This callback will be called when a copy of this plugin is destroyed,
* it is intended to allow the user to free up any memory associated with
* the user specific data
*
* @param user_specific
* this is user specific data created by the copy method
*
* @return
* - n/a
*/
typedef void (*globus_ftp_client_perf_plugin_user_destroy_cb_t)(
void * user_specific);
globus_result_t
globus_ftp_client_perf_plugin_init(
globus_ftp_client_plugin_t * plugin,
globus_ftp_client_perf_plugin_begin_cb_t begin_cb,
globus_ftp_client_perf_plugin_marker_cb_t marker_cb,
globus_ftp_client_perf_plugin_complete_cb_t complete_cb,
void * user_specific);
globus_result_t
globus_ftp_client_perf_plugin_set_copy_destroy(
globus_ftp_client_plugin_t * plugin,
globus_ftp_client_perf_plugin_user_copy_cb_t copy_cb,
globus_ftp_client_perf_plugin_user_destroy_cb_t destroy_cb);
globus_result_t
globus_ftp_client_perf_plugin_destroy(
globus_ftp_client_plugin_t * plugin);
globus_result_t
globus_ftp_client_perf_plugin_get_user_specific(
globus_ftp_client_plugin_t * plugin,
void ** user_specific);
EXTERN_C_END
#endif /* GLOBUS_INCLUDE_FTP_CLIENT_PERF_PLUGIN_H */
|