This file is indexed.

/usr/include/globus/globus_ftp_client_plugin.h is in libglobus-ftp-client-dev 8.36-2build1.

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
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
/*
 * 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

/**
 * @file globus_ftp_client_plugin.h
 * @brief Plugin Implementation
 */

/**
 * @brief Plugin API
 * @defgroup globus_ftp_client_plugins Plugins
 * @ingroup globus_ftp_client_api
 * @details
 * A plugin is a way to implement application-independent reliability
 * and performance tuning behavior. Plugins are written using the API
 * described in this document.
 *
 * A plugin is created by defining a globus_ftp_client_plugin_t which
 * contains the function pointers and plugin-specific data needed for
 * the plugin's operation. It is recommended that a plugin define a
 * a globus_module_descriptor_t and plugin initialization functions,
 * to ensure that the plugin is properly initialized.
 *
 * The functions pointed to in a plugin are called when significant
 * events in the life of an FTP Client operation occur. Note that
 * plugins will only be called when the plugin has the function
 * pointer for both the operation (get, put, list, etc), and the event
 * (connect, authenticate, command, etc), are defined. The command and
 * response functions are filtered based on the command_mask defined in
 * the plugin structure.
 *
 * Every plugin must define @link
 * #globus_ftp_client_plugin_copy_t copy @endlink and
 * @link #globus_ftp_client_plugin_destroy_t destroy @endlink functions. The
 * copy function is called when the plugin is added to an attribute set
 * or a handle is initialized with an attribute set containing the plugin.
 * The destroy function is called when the handle or attribute set is
 * destroyed.
 */

#include "globus_ftp_client.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
 * Command Mask.
 * @ingroup globus_ftp_client_plugins
 *
 * This enumeration includes the types of commands which the plugin
 * is interested in.
 */
typedef enum
{
    GLOBUS_FTP_CLIENT_CMD_MASK_NONE =    0,

    /** connect, authenticate */
    GLOBUS_FTP_CLIENT_CMD_MASK_CONTROL_ESTABLISHMENT	= 1<<0,

    /** PASV, PORT, SPOR, SPAS */
    GLOBUS_FTP_CLIENT_CMD_MASK_DATA_ESTABLISHMENT	= 1<<1,

    /** MODE, TYPE, STRU, OPTS RETR, DCAU */
    GLOBUS_FTP_CLIENT_CMD_MASK_TRANSFER_PARAMETERS	= 1<<2,

    /** ALLO, REST */
    GLOBUS_FTP_CLIENT_CMD_MASK_TRANSFER_MODIFIERS	= 1<<3,

    /** STOR, RETR, ESTO, ERET, APPE, LIST, NLST, MLSD, MLSR, GET, PUT */
    GLOBUS_FTP_CLIENT_CMD_MASK_FILE_ACTIONS		= 1<<4,

    /** HELP, SITE HELP, FEAT, STAT, SYST, SIZE */
    GLOBUS_FTP_CLIENT_CMD_MASK_INFORMATION		= 1<<5,

    /** SITE, NOOP */
    GLOBUS_FTP_CLIENT_CMD_MASK_MISC			= 1<<6,

    /** SBUF, ABUF */
    GLOBUS_FTP_CLIENT_CMD_MASK_BUFFER			= 1<<7,

    /** All possible commands */
    GLOBUS_FTP_CLIENT_CMD_MASK_ALL			= 0x7fffffff
}
globus_ftp_client_plugin_command_mask_t;


/**
 * Plugin copy function.
 * @ingroup globus_ftp_client_plugins
 *
 * This function is used to create a new copy or reference count a
 * plugin. This function is called by the FTP Client library when
 * a plugin is added to a handle attribute set, or when a handle
 * is initialized with an attribute which contains the plugin.
 *
 * A plugin may not call any of the plugin API functions from it's
 * instantiate method.
 *
 * @param plugin_template
 *        A plugin previously initialized by a call to the plugin-specific
 *        initialization function.
 *        by the user.
 * @param plugin_specific
 *        Plugin-specific data.
 *
 * @return A pointer to a plugin. This plugin copy must remain valid
 *         until the copy's
 *         @ref globus_ftp_client_plugin_destroy_t "destroy"
 *         function is called on the copy.
 *
 * @see #globus_ftp_client_plugin_destroy_t
 */
typedef globus_ftp_client_plugin_t * (*globus_ftp_client_plugin_copy_t)(
    globus_ftp_client_plugin_t *		plugin_template,
    void *					plugin_specific);

/**
 * Plugin destroy function.
 * @ingroup globus_ftp_client_plugins
 *
 * This function is used to free or unreference a copy of a plugin which
 * was allocated by calling the instantiate function from the plugin.
 *
 * @param plugin
 *        The plugin, created by the create function, which is to be
 *        destroyed.
 * @param plugin_specific
 *        Plugin-specific data.
 */
typedef void (*globus_ftp_client_plugin_destroy_t)(
    globus_ftp_client_plugin_t *		plugin,
    void *					plugin_specific);

/**
 * Plugin connection begin function.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that connection
 * establishment is being done for this client handle.  This
 * notification can occur when a new request is made or when a restart
 * is done by a plugin.
 *
 * If a response_callback is defined by a plugin, then that will be
 * once the connection establishment has completed (successfully or
 * unsuccessfully).
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the connection.
 *
 * @note This function will not be called for a get, put, or
 * third-party transfer operation when a cached connection is used.
 */
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);

/**
 * Plugin authentication notification callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that an authentication
 * handshake is being done for this client handle.  This
 * notification can occur when a new request is made or when a hard restart
 * is done by a plugin.
 *
 * If a response_callback is defined by a plugin, then that will be
 * once the authentication has completed (successfully or
 * unsuccessfully).
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the connection.
 * @param url
 *        The URL of the server to connect to.
 * @param auth_info
 *        Authentication and authorization info being used to
 *        authenticate with the FTP or GridFTP server.
 */
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);

/**
 * Plugin chmod notification callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that a chmod is being
 * requested  on a client handle. This notification happens both when
 * the user requests a chmod, and when a plugin restarts the currently
 * active chmod request.
 *
 * If this function is not defined by the plugin, then no plugin
 * callbacks associated with the chmod will be called.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the delete operation.
 * @param url
 *        The url to chmod.
 * @param mode
 *        The file mode to be applied.
 * @param attr
 *        The attributes to be used during this operation.
 * @param restart
 *        This value is set to GLOBUS_TRUE when this callback is
 *        caused by a plugin restarting the current delete operation;
 *	  otherwise, this is set to GLOBUS_FALSE.
 */
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);

/**
 * Plugin chgrp notification callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that a chgrp is being
 * requested  on a client handle. This notification happens both when
 * the user requests a chgrp, and when a plugin restarts the currently
 * active chgrp request.
 *
 * If this function is not defined by the plugin, then no plugin
 * callbacks associated with the chgrp will be called.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the delete operation.
 * @param url
 *        The url to chgrp.
 * @param group
 *        The group name or ID to change to.
 * @param attr
 *        The attributes to be used during this operation.
 * @param restart
 *        This value is set to GLOBUS_TRUE when this callback is
 *        caused by a plugin restarting the current delete operation;
 *    otherwise, this is set to GLOBUS_FALSE.
 */
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);

/**
 * Plugin utime notification callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that a utime is being
 * requested  on a client handle. This notification happens both when
 * the user requests a utime, and when a plugin restarts the currently
 * active utime request.
 *
 * If this function is not defined by the plugin, then no plugin
 * callbacks associated with the utime will be called.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the utime operation.
 * @param url
 *        The url to utime.
 * @param utime_time
 *        The modification time to change the file to.
 * @param attr
 *        The attributes to be used during this operation.
 * @param restart
 *        This value is set to GLOBUS_TRUE when this callback is
 *        caused by a plugin restarting the current utime operation;
 *    otherwise, this is set to GLOBUS_FALSE.
 */
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);

/**
 * Plugin symlink notification callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that a symlink is being
 * requested  on a client handle. This notification happens both when
 * the user requests a symlink, and when a plugin restarts the currently
 * active symlink request.
 *
 * If this function is not defined by the plugin, then no plugin
 * callbacks associated with the symlink will be called.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the symlink operation.
 * @param url
 *        The url of the new link.
 * @param link_url
 *        The url to which the new link should point.
 * @param attr
 *        The attributes to be used during this operation.
 * @param restart
 *        This value is set to GLOBUS_TRUE when this callback is
 *        caused by a plugin restarting the current utime operation;
 *    otherwise, this is set to GLOBUS_FALSE.
 */
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);

/**
 * Plugin cksm notification callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that a cksm is being
 * requested  on a client handle. This notification happens both when
 * the user requests a cksm, and when a plugin restarts the currently
 * active cksm request.
 *
 * If this function is not defined by the plugin, then no plugin
 * callbacks associated with the cksm will be called.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the delete operation.
 * @param url
 *        The url to cksm.
 * @param offset
 *        File offset to start calculating checksum.    
 * @param length
 *        Length of data to read from the starting offset.  Use -1 to read the
 *        entire file.
 * @param algorithm
 *        A pointer to a string to be filled with the checksum of the
 *        file. On error the value pointed to by it is undefined.          
 * @param attr
 *        The attributes to be used during this operation.
 * @param restart
 *        This value is set to GLOBUS_TRUE when this callback is
 *        caused by a plugin restarting the current delete operation;
 *	  otherwise, this is set to GLOBUS_FALSE.
 */
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);

/**
 * Plugin delete notification callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that a delete is being
 * requested  on a client handle. This notification happens both when
 * the user requests a delete, and when a plugin restarts the currently
 * active delete request.
 *
 * If this function is not defined by the plugin, then no plugin
 * callbacks associated with the delete will be called.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the delete operation.
 * @param url
 *        The url to be deleted.
 * @param attr
 *        The attributes to be used during this operation.
 * @param restart
 *        This value is set to GLOBUS_TRUE when this callback is
 *        caused by a plugin restarting the current delete operation;
 *	  otherwise, this is set to GLOBUS_FALSE.
 */
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);

/**
 * Plugin feat notification callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that a feat is being
 * requested  on a client handle. This notification happens both when
 * the user requests a feat, and when a plugin restarts the currently
 * active feat request.
 *
 * If this function is not defined by the plugin, then no plugin
 * callbacks associated with the feat will be called.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the feat operation.
 * @param url
 *        The url to be feat'd.
 * @param attr
 *        The attributes to be used during this operation.
 * @param restart
 *        This value is set to GLOBUS_TRUE when this callback is
 *        caused by a plugin restarting the current feat operation;
 *	  otherwise, this is set to GLOBUS_FALSE.
 */
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);

/**
 * Plugin mkdir notification callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that a mkdir is being
 * requested  on a client handle. This notification happens both when
 * the user requests a mkdir, and when a plugin restarts the currently
 * active mkdir request.
 *
 * If this function is not defined by the plugin, then no plugin
 * callbacks associated with the mkdir will be called.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the mkdir operation.
 * @param url
 *        The url of the directory to create.
 * @param attr
 *        The attributes to be used during this operation.
 * @param restart
 *        This value is set to GLOBUS_TRUE when this callback is
 *        caused by a plugin restarting the current mkdir operation;
 *	  otherwise, this is set to GLOBUS_FALSE.
 */

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);

/**
 * Plugin rmdir notification callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that a rmdir is being
 * requested  on a client handle. This notification happens both when
 * the user requests a rmdir, and when a plugin restarts the currently
 * active rmdir request.
 *
 * If this function is not defined by the plugin, then no plugin
 * callbacks associated with the rmdir will be called.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the rmdir operation.
 * @param url
 *        The url of the rmdir operation.
 * @param attr
 *        The attributes to be used during this operation.
 * @param restart
 *        This value is set to GLOBUS_TRUE when this callback is
 *        caused by a plugin restarting the current rmdir operation;
 *	  otherwise, this is set to GLOBUS_FALSE.
 */
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);


/**
 * Plugin list notification callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that a list is being
 * requested  on a client handle. This notification happens both when
 * the user requests a list, and when a plugin restarts the currently
 * active list request.
 *
 * If this function is not defined by the plugin, then no plugin
 * callbacks associated with the list will be called.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the list operation.
 * @param url
 *        The url of the list operation.
 * @param attr
 *        The attributes to be used during this transfer.
 * @param restart
 *        This value is set to GLOBUS_TRUE when this callback is
 *        caused by a plugin restarting the current list transfer;
 *	  otherwise, this is set to GLOBUS_FALSE.
 */
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);

/**
 * Plugin verbose list notification callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that a list is being
 * requested  on a client handle. This notification happens both when
 * the user requests a list, and when a plugin restarts the currently
 * active list request.
 *
 * If this function is not defined by the plugin, then no plugin
 * callbacks associated with the list will be called.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the list operation.
 * @param url
 *        The url of the list operation.
 * @param attr
 *        The attributes to be used during this transfer.
 * @param restart
 *        This value is set to GLOBUS_TRUE when this callback is
 *        caused by a plugin restarting the current list transfer;
 *	  otherwise, this is set to GLOBUS_FALSE.
 */
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);

/**
 * Plugin machine list notification callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that a list is being
 * requested  on a client handle. This notification happens both when
 * the user requests a list, and when a plugin restarts the currently
 * active list request.
 *
 * If this function is not defined by the plugin, then no plugin
 * callbacks associated with the list will be called.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the list operation.
 * @param url
 *        The url of the list operation.
 * @param attr
 *        The attributes to be used during this transfer.
 * @param restart
 *        This value is set to GLOBUS_TRUE when this callback is
 *        caused by a plugin restarting the current list transfer;
 *	  otherwise, this is set to GLOBUS_FALSE.
 */
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);

/**
 * Plugin recursive list notification callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that a list is being
 * requested  on a client handle. This notification happens both when
 * the user requests a list, and when a plugin restarts the currently
 * active list request.
 *
 * If this function is not defined by the plugin, then no plugin
 * callbacks associated with the list will be called.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the list operation.
 * @param url
 *        The url of the list operation.
 * @param attr
 *        The attributes to be used during this transfer.
 * @param restart
 *        This value is set to GLOBUS_TRUE when this callback is
 *        caused by a plugin restarting the current list transfer;
 *    otherwise, this is set to GLOBUS_FALSE.
 */
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);

/**
 * Plugin mlst notification callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that a mlst is being
 * requested  on a client handle. This notification happens both when
 * the user requests a list, and when a plugin restarts the currently
 * active list request.
 *
 * If this function is not defined by the plugin, then no plugin
 * callbacks associated with the list will be called.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the list operation.
 * @param url
 *        The url of the list operation.
 * @param attr
 *        The attributes to be used during this transfer.
 * @param restart
 *        This value is set to GLOBUS_TRUE when this callback is
 *        caused by a plugin restarting the current list transfer;
 *	  otherwise, this is set to GLOBUS_FALSE.
 */
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);


/**
 * Plugin stat notification callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that a stat is being
 * requested  on a client handle. This notification happens both when
 * the user requests a list, and when a plugin restarts the currently
 * active list request.
 *
 * If this function is not defined by the plugin, then no plugin
 * callbacks associated with the list will be called.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the list operation.
 * @param url
 *        The url of the list operation.
 * @param attr
 *        The attributes to be used during this transfer.
 * @param restart
 *        This value is set to GLOBUS_TRUE when this callback is
 *        caused by a plugin restarting the current list transfer;
 *	  otherwise, this is set to GLOBUS_FALSE.
 */
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);


/**
 * Plugin move notification callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that a move is being
 * requested  on a client handle. This notification happens both when
 * the user requests a move, and when a plugin restarts the currently
 * active move request.
 *
 * If this function is not defined by the plugin, then no plugin
 * callbacks associated with the move will be called.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the move operation.
 * @param source_url
 *        The source url of the move operation.
 * @param dest_url
 *        The destination url of the move operation.
 * @param attr
 *        The attributes to be used during this move.
 * @param restart
 *        This value is set to GLOBUS_TRUE when this callback is
 *        caused by a plugin restarting the current move transfer;
 *	  otherwise, this is set to GLOBUS_FALSE.
 */
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);

/**
 * Plugin get notification callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that a get is being
 * requested  on a client handle. This notification happens both when
 * the user requests a get, and when a plugin restarts the currently
 * active get request.
 *
 * If this function is not defined by the plugin, then no plugin
 * callbacks associated with the get will be called.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the get operation.
 * @param url
 *        The url of the get operation.
 * @param attr
 *        The attributes to be used during this transfer.
 * @param restart
 *        This value is set to GLOBUS_TRUE when this callback is
 *        caused by a plugin restarting the current get transfer;
 *	  otherwise, this is set to GLOBUS_FALSE.
 */
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);

/**
 * Plugin put notification callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that a put is being
 * requested  on a client handle. This notification happens both when
 * the user requests a put, and when a plugin restarts the currently
 * active put request.
 *
 * If this function is not defined by the plugin, then no plugin
 * callbacks associated with the put will be called.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the put operation.
 * @param url
 *        The url of the put operation.
 * @param attr
 *        The attributes to be used during this transfer.
 * @param restart
 *        This value is set to GLOBUS_TRUE when this callback is
 *        caused by a plugin restarting the current put transfer;
 *	  otherwise, this is set to GLOBUS_FALSE.
 */
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);

/**
 * Plugin third-party transfer notification callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that a transfer is being
 * requested  on a client handle. This notification happens both when
 * the user requests a transfer, and when a plugin restarts the currently
 * active transfer request.
 *
 * If this function is not defined by the plugin, then no plugin
 * callbacks associated with the third-party transfer will be called.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the transfer operation.
 * @param source_url
 *        The source url of the transfer operation.
 * @param source_attr
 *        The attributes to be used during this transfer on the source.
 * @param dest_url
 *        The destination url of the third-party transfer operation.
 * @param dest_attr
 *        The attributes to be used during this transfer on the destination.
 * @param restart
 *        This value is set to GLOBUS_TRUE when this callback is
 *        caused by a plugin restarting the current transfer transfer;
 *	  otherwise, this is set to GLOBUS_FALSE.
 */
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);

/**
 * Plugin modification time notification callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that a modification time check
 * is being requested  on a client handle. This notification happens both when
 * the user requests the modification time of a file,
 * and when a plugin restarts the currently active request.
 *
 * If this function is not defined by the plugin, then no plugin
 * callbacks associated with the modification time request will be called.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the list operation.
 * @param url
 *        The url of the list operation.
 * @param attr
 *        The attributes to be used during this transfer.
 * @param restart
 *        This value is set to GLOBUS_TRUE when this callback is
 *        caused by a plugin restarting the current list transfer;
 *	  otherwise, this is set to GLOBUS_FALSE.
 */
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);

/**
 * Plugin size notification callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that a size check
 * is being requested  on a client handle. This notification happens both when
 * the user requests the size of a file,
 * and when a plugin restarts the currently active request.
 *
 * If this function is not defined by the plugin, then no plugin
 * callbacks associated with the size request will be called.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the list operation.
 * @param url
 *        The url of the list operation.
 * @param attr
 *        The attributes to be used during this transfer.
 * @param restart
 *        This value is set to GLOBUS_TRUE when this callback is
 *        caused by a plugin restarting the current list transfer;
 *	  otherwise, this is set to GLOBUS_FALSE.
 */
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);

/**
 * Plugin abort notification callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that an abort is being
 * requested on a client handle. This notification happens both when
 * the user aborts a request and when a plugin aborts the currently
 * active request.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the request.
 */
typedef void (*globus_ftp_client_plugin_abort_t)(
    globus_ftp_client_plugin_t *		plugin,
    void *					plugin_specific,
    globus_ftp_client_handle_t *		handle);

/**
 * Plugin read registration callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that the client API has
 * registered a buffer with the FTP control API for reading when
 * processing a get.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the request.
 * @param buffer
 *        The data buffer to read into.
 * @param buffer_length
 *        The maximum amount of data to read into the buffer.
 */
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);

/**
 * Plugin write registration callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that the client API has
 * registered a buffer with the FTP control API for writing when
 * processing a put.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the request.
 * @param buffer
 *        The buffer which is being written.
 * @param buffer_length
 *        The amount of data in the buffer.
 * @param offset
 *        The offset within the file where the buffer is to be written.
 * @param eof
 *        This value is set to GLOBUS_TRUE if this is the last data
 *        buffer to be sent for this put request.
 */
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);

/**
 * Plugin data callback handler.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that a read or write
 * operation previously registered has completed. The buffer pointer
 * will match that of a previous plugin read or write registration
 * callback.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the request.
 * @param buffer
 *        The buffer which was successfully transferred over the network.
 * @param length
 *        The amount of data to read or written.
 * @param offset
 *        The offset into the file where this data buffer belongs.
 * @param eof
 *        This value is set to GLOBUS_TRUE if end-of-file is being processed
 *        for this transfer.
 */
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);

/**
 * Command callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that a FTP control
 * command is being sent. The client library will only call this
 * function for response callbacks associated with a command which is
 * in the plugin's command mask, and associated with one of the other
 * ftp operations with a defined callback in the plugin.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the request.
 * @param url
 *        The URL which this command is being sent to.
 * @param command
 *        A string containing the command which is being sent
 *        to the server (TYPE I, for example).
 */
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);

/**
 * Response callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that a FTP control
 * response has occurred on a control connection. FTP response
 * callbacks will come back to the user in the order which the
 * commands were executed. The client library will only call this
 * function for response callbacks associated with a command which is
 * in the plugin's command mask, or associated with one of the other
 * ftp operations with a defined callback in the plugin.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the request.
 * @param url
 *        The URL which this response came from.
 * @param error
 *        An error which occurred while processing this
 *	  command/response pair.
 * @param ftp_response
 *        The response structure from the ftp control library.
 */
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);

/**
 * Fault notification callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that a fault occurred
 * while processing the request. The fault may be internally
 * generated, or come from a call to another library.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the request.
 * @param url
 *        The url being processed when the fault ocurred.
 * @param error
 *        An error object describing the fault.
 */
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);

/**
 * Completion notification callback.
 * @ingroup globus_ftp_client_plugins
 *
 * This callback is used to notify a plugin that an operation previously
 * begun has completed. The plugin may not call any other plugin operation
 * on this handle after this has occurred. This is the final callback for
 * the plugin while processing the operation.  The plugin may free any
 * internal state associated with the operation at this point.
 *
 * @param plugin
 *        The plugin which is being notified.
 * @param plugin_specific
 *        Plugin-specific data.
 * @param handle
 *        The handle associated with the operation.
 */
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 */