/usr/share/doc/libglobus-gass-copy-dev/html/group__globus__gass__copy.html is in libglobus-gass-copy-doc 9.12-3.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>globus_gass_copy: GASS Copy</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">globus_gass_copy
 <span id="projectnumber">9.12</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Modules</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GASS Copy</div> </div>
</div><!--header-->
<div class="contents">
<p>Protocol-Independent File Transfer.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structglobus__gass__copy__attr__s.html">globus_gass_copy_attr_s</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Attributes. <a href="structglobus__gass__copy__attr__s.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structglobus__gass__copy__handleattr__s.html">globus_gass_copy_handleattr_s</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Handle Attributes. <a href="structglobus__gass__copy__handleattr__s.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structglobus__gass__copy__glob__stat__t.html">globus_gass_copy_glob_stat_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Glob expanded entry information. <a href="structglobus__gass__copy__glob__stat__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga31d716567bc1e1a4440c84ff409b44fe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga31d716567bc1e1a4440c84ff409b44fe"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#ga31d716567bc1e1a4440c84ff409b44fe">GLOBUS_GASS_COPY_MODULE</a>   (&globus_i_gass_copy_module)</td></tr>
<tr class="memdesc:ga31d716567bc1e1a4440c84ff409b44fe"><td class="mdescLeft"> </td><td class="mdescRight">Module Descriptor. <br /></td></tr>
<tr class="separator:ga31d716567bc1e1a4440c84ff409b44fe"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga0d2b5b6d5f7b8cb9246fd77d16ee00be"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#ga0d2b5b6d5f7b8cb9246fd77d16ee00be">globus_gass_copy_performance_cb_t</a> )(void *user_arg, <a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> *handle, globus_off_t total_bytes, float instantaneous_throughput, float avg_throughput)</td></tr>
<tr class="memdesc:ga0d2b5b6d5f7b8cb9246fd77d16ee00be"><td class="mdescLeft"> </td><td class="mdescRight">Performance Callback. <a href="#ga0d2b5b6d5f7b8cb9246fd77d16ee00be">More...</a><br /></td></tr>
<tr class="separator:ga0d2b5b6d5f7b8cb9246fd77d16ee00be"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga92aa42c1db89446352dfcf80a86cb709"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#ga92aa42c1db89446352dfcf80a86cb709">globus_gass_copy_callback_t</a> )(void *callback_arg, <a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> *handle, globus_object_t *error)</td></tr>
<tr class="memdesc:ga92aa42c1db89446352dfcf80a86cb709"><td class="mdescLeft"> </td><td class="mdescRight">Copy Callback. <a href="#ga92aa42c1db89446352dfcf80a86cb709">More...</a><br /></td></tr>
<tr class="separator:ga92aa42c1db89446352dfcf80a86cb709"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafd9950dff15a6220af99ee676ca37fa9"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak" />
<a class="el" href="structglobus__gass__copy__attr__s.html">globus_gass_copy_attr_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#gafd9950dff15a6220af99ee676ca37fa9">globus_gass_copy_attr_t</a></td></tr>
<tr class="memdesc:gafd9950dff15a6220af99ee676ca37fa9"><td class="mdescLeft"> </td><td class="mdescRight">Attributes. <a href="#gafd9950dff15a6220af99ee676ca37fa9">More...</a><br /></td></tr>
<tr class="separator:gafd9950dff15a6220af99ee676ca37fa9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga90f8e87941f22a5ab054fccc9bbfc2d2"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak" />
<a class="el" href="structglobus__gass__copy__handleattr__s.html">globus_gass_copy_handleattr_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#ga90f8e87941f22a5ab054fccc9bbfc2d2">globus_gass_copy_handleattr_t</a></td></tr>
<tr class="memdesc:ga90f8e87941f22a5ab054fccc9bbfc2d2"><td class="mdescLeft"> </td><td class="mdescRight">Handle Attributes. <a href="#ga90f8e87941f22a5ab054fccc9bbfc2d2">More...</a><br /></td></tr>
<tr class="separator:ga90f8e87941f22a5ab054fccc9bbfc2d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaacbf8e5b4ae779dcddcc90a9a0e2af71"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#gaacbf8e5b4ae779dcddcc90a9a0e2af71">globus_gass_copy_glob_entry_cb_t</a> )(const char *url, const <a class="el" href="structglobus__gass__copy__glob__stat__t.html">globus_gass_copy_glob_stat_t</a> *info_stat, void *user_arg)</td></tr>
<tr class="memdesc:gaacbf8e5b4ae779dcddcc90a9a0e2af71"><td class="mdescLeft"> </td><td class="mdescRight">Gass copy glob entry callback. <a href="#gaacbf8e5b4ae779dcddcc90a9a0e2af71">More...</a><br /></td></tr>
<tr class="separator:gaacbf8e5b4ae779dcddcc90a9a0e2af71"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gadc5d1cc2cfb4b55c1d65c161c258c289"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gadc5d1cc2cfb4b55c1d65c161c258c289"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#gadc5d1cc2cfb4b55c1d65c161c258c289">globus_gass_copy_status_t</a> </td></tr>
<tr class="memdesc:gadc5d1cc2cfb4b55c1d65c161c258c289"><td class="mdescLeft"> </td><td class="mdescRight">Status States. <br /></td></tr>
<tr class="separator:gadc5d1cc2cfb4b55c1d65c161c258c289"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0c40e6169cbec2c997698000d24da2ab"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0c40e6169cbec2c997698000d24da2ab"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#ga0c40e6169cbec2c997698000d24da2ab">globus_gass_copy_url_mode_t</a> </td></tr>
<tr class="memdesc:ga0c40e6169cbec2c997698000d24da2ab"><td class="mdescLeft"> </td><td class="mdescRight">URL Modes. <br /></td></tr>
<tr class="separator:ga0c40e6169cbec2c997698000d24da2ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga36dbf746822bd9d5d5f8a4f57e6e5fab"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#ga36dbf746822bd9d5d5f8a4f57e6e5fab">globus_gass_copy_glob_entry_t</a> </td></tr>
<tr class="separator:ga36dbf746822bd9d5d5f8a4f57e6e5fab"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga61d8c79a0d7001292bfe256a6558bf45"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#ga61d8c79a0d7001292bfe256a6558bf45">globus_gass_copy_handle_init</a> (<a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> *handle, <a class="el" href="group__globus__gass__copy.html#ga90f8e87941f22a5ab054fccc9bbfc2d2">globus_gass_copy_handleattr_t</a> *attr)</td></tr>
<tr class="memdesc:ga61d8c79a0d7001292bfe256a6558bf45"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a GASS Copy handle. <a href="#ga61d8c79a0d7001292bfe256a6558bf45">More...</a><br /></td></tr>
<tr class="separator:ga61d8c79a0d7001292bfe256a6558bf45"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga99f73bc446fa70cf498b2b7d71060ebf"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#ga99f73bc446fa70cf498b2b7d71060ebf">globus_gass_copy_handle_destroy</a> (<a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> *handle)</td></tr>
<tr class="memdesc:ga99f73bc446fa70cf498b2b7d71060ebf"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a GASS Copy handle. <a href="#ga99f73bc446fa70cf498b2b7d71060ebf">More...</a><br /></td></tr>
<tr class="separator:ga99f73bc446fa70cf498b2b7d71060ebf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9e56d84d6b970ae20e26fb497defce6e"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#ga9e56d84d6b970ae20e26fb497defce6e">globus_gass_copy_set_buffer_length</a> (<a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> *handle, int length)</td></tr>
<tr class="memdesc:ga9e56d84d6b970ae20e26fb497defce6e"><td class="mdescLeft"> </td><td class="mdescRight">Set the size of the buffer to be used for doing transfers. <a href="#ga9e56d84d6b970ae20e26fb497defce6e">More...</a><br /></td></tr>
<tr class="separator:ga9e56d84d6b970ae20e26fb497defce6e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae1d163945b26e7e0bc8c88471eeb3487"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#gae1d163945b26e7e0bc8c88471eeb3487">globus_gass_copy_get_buffer_length</a> (<a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> *handle, int *length)</td></tr>
<tr class="memdesc:gae1d163945b26e7e0bc8c88471eeb3487"><td class="mdescLeft"> </td><td class="mdescRight">Get the size of the transfer buffer. <a href="#gae1d163945b26e7e0bc8c88471eeb3487">More...</a><br /></td></tr>
<tr class="separator:gae1d163945b26e7e0bc8c88471eeb3487"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga94b35859fce8470b6e514b2ce9701706"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#ga94b35859fce8470b6e514b2ce9701706">globus_gass_copy_set_no_third_party_transfers</a> (<a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> *handle, globus_bool_t no_third_party_transfers)</td></tr>
<tr class="memdesc:ga94b35859fce8470b6e514b2ce9701706"><td class="mdescLeft"> </td><td class="mdescRight">Enable/Disable third-party transfers. <a href="#ga94b35859fce8470b6e514b2ce9701706">More...</a><br /></td></tr>
<tr class="separator:ga94b35859fce8470b6e514b2ce9701706"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacd4d1bbf92b6942339daa8934868ceee"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#gacd4d1bbf92b6942339daa8934868ceee">globus_gass_copy_get_no_third_party_transfers</a> (<a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> *handle, globus_bool_t *no_third_party_transfers)</td></tr>
<tr class="memdesc:gacd4d1bbf92b6942339daa8934868ceee"><td class="mdescLeft"> </td><td class="mdescRight">Query third-party transfer status. <a href="#gacd4d1bbf92b6942339daa8934868ceee">More...</a><br /></td></tr>
<tr class="separator:gacd4d1bbf92b6942339daa8934868ceee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac2c1cfeafd510f9b010005e69e0494cf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac2c1cfeafd510f9b010005e69e0494cf"></a>
globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#gac2c1cfeafd510f9b010005e69e0494cf">globus_gass_copy_set_allocate</a> (<a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> *handle, globus_bool_t send_allo)</td></tr>
<tr class="memdesc:gac2c1cfeafd510f9b010005e69e0494cf"><td class="mdescLeft"> </td><td class="mdescRight">Set allo on or off. <br /></td></tr>
<tr class="separator:gac2c1cfeafd510f9b010005e69e0494cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabfc7d3235bab04b4e59f1cf5fca606b0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gabfc7d3235bab04b4e59f1cf5fca606b0"></a>
globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#gabfc7d3235bab04b4e59f1cf5fca606b0">globus_gass_copy_set_stat_on_expand</a> (<a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> *handle, globus_bool_t always_stat)</td></tr>
<tr class="memdesc:gabfc7d3235bab04b4e59f1cf5fca606b0"><td class="mdescLeft"> </td><td class="mdescRight">Make globus_gass_copy_expand_url() always send stat info. <br /></td></tr>
<tr class="separator:gabfc7d3235bab04b4e59f1cf5fca606b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8f70d7378a1b66fc53bf7d27b834eba9"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#ga8f70d7378a1b66fc53bf7d27b834eba9">globus_gass_copy_set_partial_offsets</a> (<a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> *handle, globus_off_t offset, globus_off_t end_offset)</td></tr>
<tr class="memdesc:ga8f70d7378a1b66fc53bf7d27b834eba9"><td class="mdescLeft"> </td><td class="mdescRight">Set partial file offsets. <a href="#ga8f70d7378a1b66fc53bf7d27b834eba9">More...</a><br /></td></tr>
<tr class="separator:ga8f70d7378a1b66fc53bf7d27b834eba9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa9375ae3b7860655dced7d6e91f8f1ec"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#gaa9375ae3b7860655dced7d6e91f8f1ec">globus_gass_copy_get_partial_offsets</a> (<a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> *handle, globus_off_t *offset, globus_off_t *end_offset)</td></tr>
<tr class="memdesc:gaa9375ae3b7860655dced7d6e91f8f1ec"><td class="mdescLeft"> </td><td class="mdescRight">Get partial transfer offsets. <a href="#gaa9375ae3b7860655dced7d6e91f8f1ec">More...</a><br /></td></tr>
<tr class="separator:gaa9375ae3b7860655dced7d6e91f8f1ec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4e83747383c97fdbc43ae03e280a8880"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#ga4e83747383c97fdbc43ae03e280a8880">globus_gass_copy_attr_init</a> (<a class="el" href="group__globus__gass__copy.html#gafd9950dff15a6220af99ee676ca37fa9">globus_gass_copy_attr_t</a> *attr)</td></tr>
<tr class="memdesc:ga4e83747383c97fdbc43ae03e280a8880"><td class="mdescLeft"> </td><td class="mdescRight">Initialize an attribute structure. <a href="#ga4e83747383c97fdbc43ae03e280a8880">More...</a><br /></td></tr>
<tr class="separator:ga4e83747383c97fdbc43ae03e280a8880"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga011a6b17268ce2a0527d2d182deff2c0"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#ga011a6b17268ce2a0527d2d182deff2c0">globus_gass_copy_attr_set_ftp</a> (<a class="el" href="group__globus__gass__copy.html#gafd9950dff15a6220af99ee676ca37fa9">globus_gass_copy_attr_t</a> *attr, globus_ftp_client_operationattr_t *ftp_attr)</td></tr>
<tr class="memdesc:ga011a6b17268ce2a0527d2d182deff2c0"><td class="mdescLeft"> </td><td class="mdescRight">Set the attributes for ftp/gsiftp transfers. <a href="#ga011a6b17268ce2a0527d2d182deff2c0">More...</a><br /></td></tr>
<tr class="separator:ga011a6b17268ce2a0527d2d182deff2c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab99d7a13d564345cd49834c79aaace6f"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#gab99d7a13d564345cd49834c79aaace6f">globus_gass_copy_attr_set_io</a> (<a class="el" href="group__globus__gass__copy.html#gafd9950dff15a6220af99ee676ca37fa9">globus_gass_copy_attr_t</a> *attr, globus_io_attr_t *io_attr)</td></tr>
<tr class="memdesc:gab99d7a13d564345cd49834c79aaace6f"><td class="mdescLeft"> </td><td class="mdescRight">Set file transfers attributes. <a href="#gab99d7a13d564345cd49834c79aaace6f">More...</a><br /></td></tr>
<tr class="separator:gab99d7a13d564345cd49834c79aaace6f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabec04bc6ec5e1ac0c2334ffcd8011497"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#gabec04bc6ec5e1ac0c2334ffcd8011497">globus_gass_copy_attr_set_gass</a> (<a class="el" href="group__globus__gass__copy.html#gafd9950dff15a6220af99ee676ca37fa9">globus_gass_copy_attr_t</a> *attr, globus_gass_transfer_requestattr_t *gass_attr)</td></tr>
<tr class="memdesc:gabec04bc6ec5e1ac0c2334ffcd8011497"><td class="mdescLeft"> </td><td class="mdescRight">Set the http/https attributes. <a href="#gabec04bc6ec5e1ac0c2334ffcd8011497">More...</a><br /></td></tr>
<tr class="separator:gabec04bc6ec5e1ac0c2334ffcd8011497"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4c58b047bb662db147d46b4b1007b78e"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#ga4c58b047bb662db147d46b4b1007b78e">globus_gass_copy_get_url_mode</a> (char *url, <a class="el" href="group__globus__gass__copy.html#ga0c40e6169cbec2c997698000d24da2ab">globus_gass_copy_url_mode_t</a> *mode)</td></tr>
<tr class="memdesc:ga4c58b047bb662db147d46b4b1007b78e"><td class="mdescLeft"> </td><td class="mdescRight">Get URL scheme. <a href="#ga4c58b047bb662db147d46b4b1007b78e">More...</a><br /></td></tr>
<tr class="separator:ga4c58b047bb662db147d46b4b1007b78e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf59abfbbbef6d9298d33c550b6648811"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#gaf59abfbbbef6d9298d33c550b6648811">globus_gass_copy_register_performance_cb</a> (<a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> *handle, <a class="el" href="group__globus__gass__copy.html#ga0d2b5b6d5f7b8cb9246fd77d16ee00be">globus_gass_copy_performance_cb_t</a> callback, void *user_arg)</td></tr>
<tr class="memdesc:gaf59abfbbbef6d9298d33c550b6648811"><td class="mdescLeft"> </td><td class="mdescRight">Register a performance information callback. <a href="#gaf59abfbbbef6d9298d33c550b6648811">More...</a><br /></td></tr>
<tr class="separator:gaf59abfbbbef6d9298d33c550b6648811"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2f01cfa265d71b96b679a20a26063244"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#ga2f01cfa265d71b96b679a20a26063244">globus_gass_copy_get_status</a> (<a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> *handle, <a class="el" href="group__globus__gass__copy.html#gadc5d1cc2cfb4b55c1d65c161c258c289">globus_gass_copy_status_t</a> *status)</td></tr>
<tr class="memdesc:ga2f01cfa265d71b96b679a20a26063244"><td class="mdescLeft"> </td><td class="mdescRight">Get the status code of a transfer. <a href="#ga2f01cfa265d71b96b679a20a26063244">More...</a><br /></td></tr>
<tr class="separator:ga2f01cfa265d71b96b679a20a26063244"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6a67acc06857281bac4ca7823d90ca00"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#ga6a67acc06857281bac4ca7823d90ca00">globus_gass_copy_get_status_string</a> (<a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> *handle)</td></tr>
<tr class="memdesc:ga6a67acc06857281bac4ca7823d90ca00"><td class="mdescLeft"> </td><td class="mdescRight">Get the status string of a transfer. <a href="#ga6a67acc06857281bac4ca7823d90ca00">More...</a><br /></td></tr>
<tr class="separator:ga6a67acc06857281bac4ca7823d90ca00"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaecf1a57ef1b64332bc58e5773486f105"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#gaecf1a57ef1b64332bc58e5773486f105">globus_gass_copy_glob_expand_url</a> (<a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> *handle, const char *url, <a class="el" href="group__globus__gass__copy.html#gafd9950dff15a6220af99ee676ca37fa9">globus_gass_copy_attr_t</a> *attr, <a class="el" href="group__globus__gass__copy.html#gaacbf8e5b4ae779dcddcc90a9a0e2af71">globus_gass_copy_glob_entry_cb_t</a> entry_cb, void *user_arg)</td></tr>
<tr class="memdesc:gaecf1a57ef1b64332bc58e5773486f105"><td class="mdescLeft"> </td><td class="mdescRight">Expand globbed url. <a href="#gaecf1a57ef1b64332bc58e5773486f105">More...</a><br /></td></tr>
<tr class="separator:gaecf1a57ef1b64332bc58e5773486f105"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf0f1b1882557a79d02f99e9a06c4dcdd"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__copy.html#gaf0f1b1882557a79d02f99e9a06c4dcdd">globus_gass_copy_mkdir</a> (<a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> *handle, char *url, <a class="el" href="group__globus__gass__copy.html#gafd9950dff15a6220af99ee676ca37fa9">globus_gass_copy_attr_t</a> *attr)</td></tr>
<tr class="memdesc:gaf0f1b1882557a79d02f99e9a06c4dcdd"><td class="mdescLeft"> </td><td class="mdescRight">Make directory. <a href="#gaf0f1b1882557a79d02f99e9a06c4dcdd">More...</a><br /></td></tr>
<tr class="separator:gaf0f1b1882557a79d02f99e9a06c4dcdd"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Protocol-Independent File Transfer. </p>
<p>The Globus GASS Copy library is motivated by the desire to provide a uniform interface to transfer files specified by different protocols.</p>
<p>The goals in doing this are to:</p>
<ul>
<li>Provide a robust way to describe and apply file transfer properties for a variety of protocols. These include the standard HTTP, FTP and GSIFTP options. Some of the new file transfer capabilities in GSIFTP are parallel, striping, authentication and TCP buffer sizing.</li>
<li>Provide a service to support nonblocking file transfer and handle asynchronous file and network events.</li>
<li>Provide a simple and portable way to implement file transfers.</li>
</ul>
<p>Any program that uses Globus GASS Copy functions must include "globus_gass_copy.h".</p>
<p>Globus GASS Copy uses standard Globus module activation and deactivation. Before any Globus GASS Copy functions are called, the following function must be called:</p>
<div class="fragment"><div class="line">globus_module_activate(<a class="code" href="group__globus__gass__copy.html#ga31d716567bc1e1a4440c84ff409b44fe">GLOBUS_GASS_COPY_MODULE</a>)</div>
</div><!-- fragment --><p>This function returns GLOBUS_SUCCESS if Globus GASS Copy was successfully initialized, and you are therefore allowed to subsequently call Globus GASS Copy functions. Otherwise, an error code is returned, and Globus GASS Copy functions should not be subsequently called. This function may be called multiple times.</p>
<p>To deactivate Globus GASS Copy, the following function must be called:</p>
<div class="fragment"><div class="line">globus_module_deactivate(<a class="code" href="group__globus__gass__copy.html#ga31d716567bc1e1a4440c84ff409b44fe">GLOBUS_GASS_COPY_MODULE</a>)</div>
</div><!-- fragment --><p>This function should be called once for each time Globus GASS Copy was activated. </p>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="gafd9950dff15a6220af99ee676ca37fa9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structglobus__gass__copy__attr__s.html">globus_gass_copy_attr_s</a> <a class="el" href="group__globus__gass__copy.html#gafd9950dff15a6220af99ee676ca37fa9">globus_gass_copy_attr_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Attributes. </p>
<p>Contains any/all attributes that are required to perform the supported transfer methods (ftp, gass, io). </p>
</div>
</div>
<a class="anchor" id="ga92aa42c1db89446352dfcf80a86cb709"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* globus_gass_copy_callback_t)(void *callback_arg, <a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> *handle, globus_object_t *error)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy Callback. </p>
<p>Signature of a callback from globus_gass_copy_register_*() functions. (nonblocking transfer functions) </p>
</div>
</div>
<a class="anchor" id="gaacbf8e5b4ae779dcddcc90a9a0e2af71"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* globus_gass_copy_glob_entry_cb_t)(const char *url, const <a class="el" href="structglobus__gass__copy__glob__stat__t.html">globus_gass_copy_glob_stat_t</a> *info_stat, void *user_arg)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Gass copy glob entry callback. </p>
<p>This callback is passed as a parameter to <a class="el" href="group__globus__gass__copy.html#gaecf1a57ef1b64332bc58e5773486f105" title="Expand globbed url. ">globus_gass_copy_glob_expand_url()</a>. It is called once for each entry that the original expands to.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">url</td><td>The full url to the expanded entry. A directory entry will end in a forward slash '/'.</td></tr>
<tr><td class="paramname">stat</td><td>A pointer to a <a class="el" href="structglobus__gass__copy__glob__stat__t.html" title="Glob expanded entry information. ">globus_gass_copy_glob_stat_t</a> containing information about the entry.</td></tr>
<tr><td class="paramname">user_arg</td><td>The user_arg passed to globus_gass_copy_glob_expand()</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structglobus__gass__copy__glob__stat__t.html" title="Glob expanded entry information. ">globus_gass_copy_glob_stat_t</a>, <a class="el" href="group__globus__gass__copy.html#gaecf1a57ef1b64332bc58e5773486f105" title="Expand globbed url. ">globus_gass_copy_glob_expand_url</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga90f8e87941f22a5ab054fccc9bbfc2d2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structglobus__gass__copy__handleattr__s.html">globus_gass_copy_handleattr_s</a> <a class="el" href="group__globus__gass__copy.html#ga90f8e87941f22a5ab054fccc9bbfc2d2">globus_gass_copy_handleattr_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Handle Attributes. </p>
<p>Contains any/all attributes that are required to create lower-level handles (ftp, gass, io). </p>
</div>
</div>
<a class="anchor" id="ga0d2b5b6d5f7b8cb9246fd77d16ee00be"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* globus_gass_copy_performance_cb_t)(void *user_arg, <a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> *handle, globus_off_t total_bytes, float instantaneous_throughput, float avg_throughput)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Performance Callback. </p>
<p>This callback is registered with 'globus_gass_copy_register_performance_cb' It will be called during a transfer to supply performance information on current transfer. Its frequency will be at most one per second, but it is possible to receive no callbacks. This is possible in very short transfers and in ftp transfers in which the server does not provide performance information.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>the gass copy handle this transfer is occurring on</td></tr>
<tr><td class="paramname">user_arg</td><td>a user pointer registered with 'globus_gass_copy_register_performance_cb'</td></tr>
<tr><td class="paramname">total_bytes</td><td>the total number of bytes transfer so far</td></tr>
<tr><td class="paramname">instantaneous_throughput</td><td>instantaneous rate of transfer (since last callback or start) (bytes / sec)</td></tr>
<tr><td class="paramname">avg_throughput</td><td>the avg thoughput calculated since the start of the transfer (bytes / sec)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>n/a </li>
</ul>
</dd></dl>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga36dbf746822bd9d5d5f8a4f57e6e5fab"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__globus__gass__copy.html#ga36dbf746822bd9d5d5f8a4f57e6e5fab">globus_gass_copy_glob_entry_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>globbed entry types </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga4e83747383c97fdbc43ae03e280a8880"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_gass_copy_attr_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__gass__copy.html#gafd9950dff15a6220af99ee676ca37fa9">globus_gass_copy_attr_t</a> * </td>
<td class="paramname"><em>attr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize an attribute structure. </p>
<p>The globus_gass_copy_attr_t can be used to pass the globus_gass_copy library information about how a transfer should be performed. It must first be initialized by calling this function. Then any or all of the following functions may be called to set attributes associated with a particular protocol: <a class="el" href="group__globus__gass__copy.html#ga011a6b17268ce2a0527d2d182deff2c0" title="Set the attributes for ftp/gsiftp transfers. ">globus_gass_copy_attr_set_ftp()</a>, <a class="el" href="group__globus__gass__copy.html#gabec04bc6ec5e1ac0c2334ffcd8011497" title="Set the http/https attributes. ">globus_gass_copy_attr_set_gass()</a>, <a class="el" href="group__globus__gass__copy.html#gab99d7a13d564345cd49834c79aaace6f" title="Set file transfers attributes. ">globus_gass_copy_attr_set_io()</a>. Any function which takes a globus_gass_copy_attr_t as an argument will also accept GLOBUS_NULL, in which case the appropriate set of default attributes will be used.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>The attribute structure to be initialized</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns GLOBUS_SUCCESS if successful, or a globus_result_t indicating the error that occurred.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__globus__gass__copy.html#ga011a6b17268ce2a0527d2d182deff2c0" title="Set the attributes for ftp/gsiftp transfers. ">globus_gass_copy_attr_set_ftp()</a>, <a class="el" href="group__globus__gass__copy.html#gabec04bc6ec5e1ac0c2334ffcd8011497" title="Set the http/https attributes. ">globus_gass_copy_attr_set_gass()</a>, <a class="el" href="group__globus__gass__copy.html#gab99d7a13d564345cd49834c79aaace6f" title="Set file transfers attributes. ">globus_gass_copy_attr_set_io()</a>, <a class="el" href="group__globus__gass__copy.html#ga4c58b047bb662db147d46b4b1007b78e" title="Get URL scheme. ">globus_gass_copy_get_url_mode()</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="ga011a6b17268ce2a0527d2d182deff2c0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_gass_copy_attr_set_ftp </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__gass__copy.html#gafd9950dff15a6220af99ee676ca37fa9">globus_gass_copy_attr_t</a> * </td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_ftp_client_operationattr_t * </td>
<td class="paramname"><em>ftp_attr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the attributes for ftp/gsiftp transfers. </p>
<p>In order to specify attributes for ftp/gsiftp transfers, a globus_ftp_client_operationattr_t should be initialized and its values set using the appropriate globus_ftp_client_operationattr_* functions. The globus_ftp_client_operationattr_t * can then be passed to the globus_gass_copy_attr_t via this function.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>A globus_gass_copy attribute structure </td></tr>
<tr><td class="paramname">ftp_attr</td><td>The ftp/gsiftp attributes to be used</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns GLOBUS_SUCCESS if successful, or a globus_result_t indicating the error that occurred.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__globus__gass__copy.html#ga4e83747383c97fdbc43ae03e280a8880" title="Initialize an attribute structure. ">globus_gass_copy_attr_init()</a>, <a class="el" href="group__globus__gass__copy.html#gabec04bc6ec5e1ac0c2334ffcd8011497" title="Set the http/https attributes. ">globus_gass_copy_attr_set_gass()</a>, <a class="el" href="group__globus__gass__copy.html#gab99d7a13d564345cd49834c79aaace6f" title="Set file transfers attributes. ">globus_gass_copy_attr_set_io()</a>, <a class="el" href="group__globus__gass__copy.html#ga4c58b047bb662db147d46b4b1007b78e" title="Get URL scheme. ">globus_gass_copy_get_url_mode()</a>, globus_ftp_client_operationattr_* </dd></dl>
</div>
</div>
<a class="anchor" id="gabec04bc6ec5e1ac0c2334ffcd8011497"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_gass_copy_attr_set_gass </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__gass__copy.html#gafd9950dff15a6220af99ee676ca37fa9">globus_gass_copy_attr_t</a> * </td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_gass_transfer_requestattr_t * </td>
<td class="paramname"><em>gass_attr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the http/https attributes. </p>
<p>In order to specify attributes for http/https transfers, a globus_gass_transfer_requestattr_t should be initialized and its values set using the appropriate globus_gass_transfer_requestattr_* functions. The globus_gass_transfer_requestattr_t can then be passed to the globus_gass_copy_attr_t via this function.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>A globus_gass_copy attribute structure </td></tr>
<tr><td class="paramname">gass_attr</td><td>The http/https attributes to be used</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns GLOBUS_SUCCESS if successful, or a globus_result_t indicating the error that occurred.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__globus__gass__copy.html#ga4e83747383c97fdbc43ae03e280a8880" title="Initialize an attribute structure. ">globus_gass_copy_attr_init()</a>, <a class="el" href="group__globus__gass__copy.html#gab99d7a13d564345cd49834c79aaace6f" title="Set file transfers attributes. ">globus_gass_copy_attr_set_io()</a>, <a class="el" href="group__globus__gass__copy.html#ga011a6b17268ce2a0527d2d182deff2c0" title="Set the attributes for ftp/gsiftp transfers. ">globus_gass_copy_attr_set_ftp()</a>, <a class="el" href="group__globus__gass__copy.html#ga4c58b047bb662db147d46b4b1007b78e" title="Get URL scheme. ">globus_gass_copy_get_url_mode()</a>, globus_gass_transfer_requestattr_* </dd></dl>
</div>
</div>
<a class="anchor" id="gab99d7a13d564345cd49834c79aaace6f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_gass_copy_attr_set_io </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__gass__copy.html#gafd9950dff15a6220af99ee676ca37fa9">globus_gass_copy_attr_t</a> * </td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_io_attr_t * </td>
<td class="paramname"><em>io_attr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set file transfers attributes. </p>
<p>In order to specify attributes for file transfers, a globus_io_attr_t should be initialized and its values set using the appropriate globus_io_attr_* functions. The globus_io_attr_t can then be passed to the globus_gass_copy_attr_t via this function.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>A globus_gass_copy attribute structure </td></tr>
<tr><td class="paramname">io_attr</td><td>The file attributes to be used</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns GLOBUS_SUCCESS if successful, or a globus_result_t indicating the error that occurred.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__globus__gass__copy.html#ga4e83747383c97fdbc43ae03e280a8880" title="Initialize an attribute structure. ">globus_gass_copy_attr_init()</a>, <a class="el" href="group__globus__gass__copy.html#gabec04bc6ec5e1ac0c2334ffcd8011497" title="Set the http/https attributes. ">globus_gass_copy_attr_set_gass()</a>, <a class="el" href="group__globus__gass__copy.html#ga011a6b17268ce2a0527d2d182deff2c0" title="Set the attributes for ftp/gsiftp transfers. ">globus_gass_copy_attr_set_ftp()</a>, <a class="el" href="group__globus__gass__copy.html#ga4c58b047bb662db147d46b4b1007b78e" title="Get URL scheme. ">globus_gass_copy_get_url_mode()</a>, globus_io_attr_* </dd></dl>
</div>
</div>
<a class="anchor" id="gae1d163945b26e7e0bc8c88471eeb3487"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_gass_copy_get_buffer_length </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> * </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>length</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the size of the transfer buffer. </p>
<p>This function allows the user to get the size of the buffer that is being used for doing transfers.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>Get the buffer length for transfers associated with this handle. </td></tr>
<tr><td class="paramname">length</td><td>The length, in bytes, of the buffer.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns GLOBUS_SUCCESS if successful, or a globus_result_t indicating the error that occurred. </dd></dl>
</div>
</div>
<a class="anchor" id="gacd4d1bbf92b6942339daa8934868ceee"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_gass_copy_get_no_third_party_transfers </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> * </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_bool_t * </td>
<td class="paramname"><em>no_third_party_transfers</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Query third-party transfer status. </p>
<p>This function allows the user to see if third-party transfers are turned on or off for ftp to ftp transfers associated with a particular handle. This is often desired if one of the servers involved in the transfer does not allow third-party transfers.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>See if third-party transfers are turned on or off for transfers associated with this handle. They are on by default. </td></tr>
<tr><td class="paramname">no_third_party_transfers</td><td>GLOBUS_FALSE if third-party transfers should be used. GLOBUS_TRUE if third-party transfers should not be used.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns GLOBUS_SUCCESS if successful, or a globus_result_t indicating the error that occurred. </dd></dl>
</div>
</div>
<a class="anchor" id="gaa9375ae3b7860655dced7d6e91f8f1ec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_gass_copy_get_partial_offsets </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> * </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_off_t * </td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_off_t * </td>
<td class="paramname"><em>end_offset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get partial transfer offsets. </p>
<p>This function allows the user to get the offsets that are being used for doing partial transfers. An offset of -1 means partial transfers are disabled.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>Get the offsets for partial transfers associated with this handle. </td></tr>
<tr><td class="paramname">offset</td><td>The starting offset for the partial transfer. </td></tr>
<tr><td class="paramname">end_offset</td><td>The ending offset for the partial transfer.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns GLOBUS_SUCCESS if successful, or a globus_result_t indicating the error that occurred. </dd></dl>
</div>
</div>
<a class="anchor" id="ga2f01cfa265d71b96b679a20a26063244"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_gass_copy_get_status </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> * </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__globus__gass__copy.html#gadc5d1cc2cfb4b55c1d65c161c258c289">globus_gass_copy_status_t</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the status code of a transfer. </p>
<p>Get the status of the last transfer to be initiated using the given handle. Only one transfer can be active on a handle at a given time, therefore new transfers may only be initiated when the current status is one of the following: GLOBUS_GASS_COPY_STATUS_NONE, GLOBUS_GASS_COPY_STATUS_DONE_SUCCESS, GLOBUS_GASS_COPY_STATUS_DONE_FAILURE, GLOBUS_GASS_COPY_STATUS_DONE_CANCELLED</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>A globus_gass_copy_handle </td></tr>
<tr><td class="paramname">status</td><td>Will be one of the following: GLOBUS_GASS_COPY_STATUS_NONE (No transfers have been initiated using this handle.) GLOBUS_GASS_COPY_STATUS_PENDING (A transfer is currently being set up.) GLOBUS_GASS_COPY_STATUS_TRANSFER_IN_PROGRESS (There is currently a transfer in progress.) GLOBUS_GASS_COPY_STATUS_CANCEL (The last transfer initiated using this handle has been cancelled by the user before completing, and is in the process of being cleaned up.) GLOBUS_GASS_COPY_STATUS_FAILURE (The last transfer initiated using this handle failed, and is in the process of being cleaned up.) GLOBUS_GASS_COPY_STATUS_DONE_SUCCESS (The last transfer initiated using this handle has completed successfully.) GLOBUS_GASS_COPY_STATUS_DONE_FAILURE (The last transfer initiated using this handle failed and has finished cleaning up.) GLOBUS_GASS_COPY_STATUS_DONE_CANCELLED (The last transfer initiated using this handle was cancelled and has finished cleaning up.) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns GLOBUS_SUCCESS if successful, or a globus_result_t indicating the error that occurred. </dd></dl>
</div>
</div>
<a class="anchor" id="ga6a67acc06857281bac4ca7823d90ca00"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* globus_gass_copy_get_status_string </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> * </td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the status string of a transfer. </p>
<p>Get the status of the last transfer to be initiated using the given handle. Only one transfer can be active on a handle at a given time, therefore new transfers may only be initiated when the current status is one of the following: GLOBUS_GASS_COPY_STATUS_NONE, GLOBUS_GASS_COPY_STATUS_DONE_SUCCESS, GLOBUS_GASS_COPY_STATUS_DONE_FAILURE, GLOBUS_GASS_COPY_STATUS_DONE_CANCELLED</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>A globus_gass_copy_handle</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a pointer to a character string describing the current status </dd></dl>
</div>
</div>
<a class="anchor" id="ga4c58b047bb662db147d46b4b1007b78e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_gass_copy_get_url_mode </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>url</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__globus__gass__copy.html#ga0c40e6169cbec2c997698000d24da2ab">globus_gass_copy_url_mode_t</a> * </td>
<td class="paramname"><em>mode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get URL scheme. </p>
<p>This function enables the user to determine what protocol will be used to transfer data to/from a particular url. This information can then be used to specify the appropriate attributes when initiating a transfer.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">url</td><td>The URL for schema checking </td></tr>
<tr><td class="paramname">mode</td><td>the filled in schema type of the URL param</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns GLOBUS_SUCCESS if successful, or a globus_result_t indicating the error that occurred.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__globus__gass__copy.html#ga4e83747383c97fdbc43ae03e280a8880" title="Initialize an attribute structure. ">globus_gass_copy_attr_init()</a>, <a class="el" href="group__globus__gass__copy.html#gab99d7a13d564345cd49834c79aaace6f" title="Set file transfers attributes. ">globus_gass_copy_attr_set_io()</a>, <a class="el" href="group__globus__gass__copy.html#ga011a6b17268ce2a0527d2d182deff2c0" title="Set the attributes for ftp/gsiftp transfers. ">globus_gass_copy_attr_set_ftp()</a>, globus_gass_copy_set_gass() </dd></dl>
</div>
</div>
<a class="anchor" id="gaecf1a57ef1b64332bc58e5773486f105"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_gass_copy_glob_expand_url </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> * </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>url</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__globus__gass__copy.html#gafd9950dff15a6220af99ee676ca37fa9">globus_gass_copy_attr_t</a> * </td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__globus__gass__copy.html#gaacbf8e5b4ae779dcddcc90a9a0e2af71">globus_gass_copy_glob_entry_cb_t</a> </td>
<td class="paramname"><em>entry_cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>user_arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Expand globbed url. </p>
<p>This function expands wildcards in a globbed url, and calls entry_cb() on each one.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>A gass copy handle to use for the operation.</td></tr>
<tr><td class="paramname">url</td><td>The URL to expand. The URL may be an ftp, gsiftp or file URL. Wildcard characters supported are '?' '*' '[ ]' in the filename portion of the url.</td></tr>
<tr><td class="paramname">attr</td><td>Gass copy attributes for this operation.</td></tr>
<tr><td class="paramname">entry_cb</td><td>Function to call with information about each entry</td></tr>
<tr><td class="paramname">user_arg</td><td>An argument to pass to entry_cb()</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns an error when any of these conditions are true:<ul>
<li>handle is GLOBUS_NULL</li>
<li>url is GLOBUS_NULL</li>
<li>url cannot be parsed</li>
<li>url is not a ftp, gsiftp or file url </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="ga99f73bc446fa70cf498b2b7d71060ebf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_gass_copy_handle_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> * </td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy a GASS Copy handle. </p>
<p>Destroy a gass_copy_handle, which was initialized using <a class="el" href="group__globus__gass__copy.html#ga61d8c79a0d7001292bfe256a6558bf45" title="Initialize a GASS Copy handle. ">globus_gass_copy_handle_init()</a>, that will no longer be used for doing transfers. Once the handle is detroyed, no further transfers should be associated with it.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The handle to be destroyed</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns GLOBUS_SUCCESS if successful, or a globus_result_t indicating the error that occurred.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__globus__gass__copy.html#ga61d8c79a0d7001292bfe256a6558bf45" title="Initialize a GASS Copy handle. ">globus_gass_copy_handle_init()</a>, globus_ftp_client_handle_destroy() </dd></dl>
</div>
</div>
<a class="anchor" id="ga61d8c79a0d7001292bfe256a6558bf45"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_gass_copy_handle_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> * </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__globus__gass__copy.html#ga90f8e87941f22a5ab054fccc9bbfc2d2">globus_gass_copy_handleattr_t</a> * </td>
<td class="paramname"><em>attr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize a GASS Copy handle. </p>
<p>A globus_gass_copy_handle must be initialized before any transfers may be associated with it. This function initializes a globus_gass_copy_handle to be used for doing transfers, this includes initializing a globus_ftp_client_handle which will be used for doing any ftp/gsiftp transfers. The same handle may be used to perform multiple, consecutive transfers. However, there can only be one transfer associated with a particular handle at any given time. After all transfers to be associated with this handle have completed, the handle should be destroyed by calling <a class="el" href="group__globus__gass__copy.html#ga99f73bc446fa70cf498b2b7d71060ebf" title="Destroy a GASS Copy handle. ">globus_gass_copy_handle_destroy()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The handle to be initialized </td></tr>
<tr><td class="paramname">attr</td><td>The handle attributes used to use with this handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns GLOBUS_SUCCESS if successful, or a globus_result_t indicating the error that occurred.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__globus__gass__copy.html#ga99f73bc446fa70cf498b2b7d71060ebf" title="Destroy a GASS Copy handle. ">globus_gass_copy_handle_destroy()</a> , globus_gass_copy_handleattr_init(), globus_ftp_client_hande_init() </dd></dl>
</div>
</div>
<a class="anchor" id="gaf0f1b1882557a79d02f99e9a06c4dcdd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_gass_copy_mkdir </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> * </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>url</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__globus__gass__copy.html#gafd9950dff15a6220af99ee676ca37fa9">globus_gass_copy_attr_t</a> * </td>
<td class="paramname"><em>attr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Make directory. </p>
<p>This function creates a directory given a ftp or file url.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>A gass copy handle to use for the mkdir operation. </td></tr>
<tr><td class="paramname">url</td><td>The URL for the directory to create. The URL may be an ftp, gsiftp or file URL. </td></tr>
<tr><td class="paramname">attr</td><td>Gass copy attributes for this operation.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns an error when any of these conditions are true:<ul>
<li>handle is GLOBUS_NULL</li>
<li>url is GLOBUS_NULL</li>
<li>url cannot be parsed</li>
<li>url is not a ftp, gsiftp or file url</li>
<li>the directory could not be created </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="gaf59abfbbbef6d9298d33c550b6648811"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_gass_copy_register_performance_cb </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> * </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__globus__gass__copy.html#ga0d2b5b6d5f7b8cb9246fd77d16ee00be">globus_gass_copy_performance_cb_t</a> </td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>user_arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Register a performance information callback. </p>
<p>Use this to register a performance information callback. You change or set to GLOBUS_NULL the callback any time a transfer is not occurring.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>an initialized gass copy handle for which you would like to see performance info</td></tr>
<tr><td class="paramname">callback</td><td>the performance callback</td></tr>
<tr><td class="paramname">user_arg</td><td>a user pointer that will be passed to all callbacks for a given handle</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>GLOBUS_SUCCESS</li>
<li>error on a NULL or busy handle</li>
</ul>
</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__globus__gass__copy.html#ga0d2b5b6d5f7b8cb9246fd77d16ee00be" title="Performance Callback. ">globus_gass_copy_performance_cb_t</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga9e56d84d6b970ae20e26fb497defce6e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_gass_copy_set_buffer_length </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> * </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>length</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the size of the buffer to be used for doing transfers. </p>
<p>This function allows the user to set the size of the buffer that will be used for doing transfers, if this function is not called the buffer size will default to 1M.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>Set the buffer length for transfers associated with this handle. </td></tr>
<tr><td class="paramname">length</td><td>The length, in bytes, to make the buffer.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns GLOBUS_SUCCESS if successful, or a globus_result_t indicating the error that occurred. </dd></dl>
</div>
</div>
<a class="anchor" id="ga94b35859fce8470b6e514b2ce9701706"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_gass_copy_set_no_third_party_transfers </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> * </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_bool_t </td>
<td class="paramname"><em>no_third_party_transfers</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable/Disable third-party transfers. </p>
<p>This function allows the user to turn third-party transfers on or off for ftp to ftp transfers associated with a particular handle. This is often desired if one of the servers involved in the transfer does not allow third-party transfers.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>Turn third-party transfers on or off for transfers associated with this handle. They are on by default. </td></tr>
<tr><td class="paramname">no_third_party_transfers</td><td>GLOBUS_FALSE if third-party transfers should be used. GLOBUS_TRUE if third-party transfers should not be used.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns GLOBUS_SUCCESS if successful, or a globus_result_t indicating the error that occurred. </dd></dl>
</div>
</div>
<a class="anchor" id="ga8f70d7378a1b66fc53bf7d27b834eba9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_gass_copy_set_partial_offsets </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structglobus__gass__copy__handle__s.html">globus_gass_copy_handle_t</a> * </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_off_t </td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_off_t </td>
<td class="paramname"><em>end_offset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set partial file offsets. </p>
<p>This function allows the user to set the offsets that will be used for doing partial transfers. An offset of -1 will disable partial transfers. An end_offset of -1 means EOF.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>Set the offsets for partial transfers associated with this handle. </td></tr>
<tr><td class="paramname">offset</td><td>The starting offset for the partial transfer. </td></tr>
<tr><td class="paramname">end_offset</td><td>The ending offset for the partial transfer.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns GLOBUS_SUCCESS if successful, or a globus_result_t indicating the error that occurred. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Nov 8 2014 23:47:34 for globus_gass_copy by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
|