/usr/share/doc/libglobus-gass-cache-dev/html/group__globus__gass__cache.html is in libglobus-gass-cache-doc 9.7-2.
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 | <!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.11"/>
<title>globus_gass_cache: Globus GASS Cache</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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">globus_gass_cache
 <span id="projectnumber">9.7</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<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 class="current"><a href="modules.html"><span>Modules</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)">
</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="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Globus GASS Cache</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga856da5e358be0e03f03c4f33fdc72588"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga856da5e358be0e03f03c4f33fdc72588"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__cache.html#ga856da5e358be0e03f03c4f33fdc72588">GLOBUS_GASS_CACHE_MODULE</a>   (&globus_i_gass_cache_module)</td></tr>
<tr class="memdesc:ga856da5e358be0e03f03c4f33fdc72588"><td class="mdescLeft"> </td><td class="mdescRight">module_descriptor <br /></td></tr>
<tr class="separator:ga856da5e358be0e03f03c4f33fdc72588"><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:gac7b08c687f5a11068ae4929b28bb33bf"><td class="memItemLeft" align="right" valign="top">typedef struct globus_i_gass_cache_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a></td></tr>
<tr class="memdesc:gac7b08c687f5a11068ae4929b28bb33bf"><td class="mdescLeft"> </td><td class="mdescRight">GASS Cache Handle. <a href="#gac7b08c687f5a11068ae4929b28bb33bf">More...</a><br /></td></tr>
<tr class="separator:gac7b08c687f5a11068ae4929b28bb33bf"><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:ga3c989ae2243b1fea8bedcca6a4d741ed"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__cache.html#ga3c989ae2243b1fea8bedcca6a4d741ed">globus_gass_cache_open</a> (const char *cache_directory_path, <a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a> *cache_handlep)</td></tr>
<tr class="memdesc:ga3c989ae2243b1fea8bedcca6a4d741ed"><td class="mdescLeft"> </td><td class="mdescRight">Open a GASS Cache. <a href="#ga3c989ae2243b1fea8bedcca6a4d741ed">More...</a><br /></td></tr>
<tr class="separator:ga3c989ae2243b1fea8bedcca6a4d741ed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0e5c16639ae45f42171604704b37110a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__cache.html#ga0e5c16639ae45f42171604704b37110a">globus_gass_cache_close</a> (<a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a> *cache_handlep)</td></tr>
<tr class="memdesc:ga0e5c16639ae45f42171604704b37110a"><td class="mdescLeft"> </td><td class="mdescRight">Close a cache handle. <a href="#ga0e5c16639ae45f42171604704b37110a">More...</a><br /></td></tr>
<tr class="separator:ga0e5c16639ae45f42171604704b37110a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaca303625ca1ed7f52f5d894ef451cbf0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__cache.html#gaca303625ca1ed7f52f5d894ef451cbf0">globus_gass_cache_add</a> (<a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a> cache_handle, const char *url, const char *tag, globus_bool_t create, unsigned long *timestamp, char **local_filename)</td></tr>
<tr class="memdesc:gaca303625ca1ed7f52f5d894ef451cbf0"><td class="mdescLeft"> </td><td class="mdescRight">Add a tag to an URL in the cache. <a href="#gaca303625ca1ed7f52f5d894ef451cbf0">More...</a><br /></td></tr>
<tr class="separator:gaca303625ca1ed7f52f5d894ef451cbf0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0ae7193171a64977cf05f3eaa3aa8b13"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__cache.html#ga0ae7193171a64977cf05f3eaa3aa8b13">globus_gass_cache_add_done</a> (<a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a> cache_handle, const char *url, const char *tag, unsigned long timestamp)</td></tr>
<tr class="memdesc:ga0ae7193171a64977cf05f3eaa3aa8b13"><td class="mdescLeft"> </td><td class="mdescRight">Complete adding a cache entry and unlock it. <a href="#ga0ae7193171a64977cf05f3eaa3aa8b13">More...</a><br /></td></tr>
<tr class="separator:ga0ae7193171a64977cf05f3eaa3aa8b13"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad9afcfebc9147b1e7c55661dffa932a6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__cache.html#gad9afcfebc9147b1e7c55661dffa932a6">globus_gass_cache_query</a> (<a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a> cache_handle, const char *url, const char *tag, globus_bool_t wait_for_lock, unsigned long *timestamp, char **local_filename, globus_bool_t *is_locked)</td></tr>
<tr class="memdesc:gad9afcfebc9147b1e7c55661dffa932a6"><td class="mdescLeft"> </td><td class="mdescRight">Query the GASS Cache. <a href="#gad9afcfebc9147b1e7c55661dffa932a6">More...</a><br /></td></tr>
<tr class="separator:gad9afcfebc9147b1e7c55661dffa932a6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga67947289f7bdfdcb86f97ab7aa551263"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__cache.html#ga67947289f7bdfdcb86f97ab7aa551263">globus_gass_cache_delete_start</a> (<a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a> cache_handle, const char *url, const char *tag, unsigned long *timestamp)</td></tr>
<tr class="memdesc:ga67947289f7bdfdcb86f97ab7aa551263"><td class="mdescLeft"> </td><td class="mdescRight">Remove a cache tag. <a href="#ga67947289f7bdfdcb86f97ab7aa551263">More...</a><br /></td></tr>
<tr class="separator:ga67947289f7bdfdcb86f97ab7aa551263"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac336211487f5e6c0bd155ff0227fbd3f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__cache.html#gac336211487f5e6c0bd155ff0227fbd3f">globus_gass_cache_delete</a> (<a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a> cache_handle, const char *url, const char *tag, unsigned long timestamp, globus_bool_t is_locked)</td></tr>
<tr class="memdesc:gac336211487f5e6c0bd155ff0227fbd3f"><td class="mdescLeft"> </td><td class="mdescRight">Remove one instance of the tag from the cache entry's tag list. <a href="#gac336211487f5e6c0bd155ff0227fbd3f">More...</a><br /></td></tr>
<tr class="separator:gac336211487f5e6c0bd155ff0227fbd3f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7a9fd887faee710170cc708a18211af2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__cache.html#ga7a9fd887faee710170cc708a18211af2">globus_gass_cache_cleanup_tag</a> (<a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a> cache_handle, const char *url, const char *tag)</td></tr>
<tr class="memdesc:ga7a9fd887faee710170cc708a18211af2"><td class="mdescLeft"> </td><td class="mdescRight">Remove a tag from a cache entry. <a href="#ga7a9fd887faee710170cc708a18211af2">More...</a><br /></td></tr>
<tr class="separator:ga7a9fd887faee710170cc708a18211af2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga14c0fe9defa4446ddba05261f0310bbe"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__cache.html#ga14c0fe9defa4446ddba05261f0310bbe">globus_gass_cache_cleanup_tag_all</a> (<a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a> cache_handle, char *tag)</td></tr>
<tr class="memdesc:ga14c0fe9defa4446ddba05261f0310bbe"><td class="mdescLeft"> </td><td class="mdescRight">Remove a tag from all cache entriesRemove all instances of the tag from the cache entry's tag list. If there are no more tags in the tag list, then remove this cache entry and delete the associated local cache file. If the cache entry is locked with the same tag as is passed to this function, then the entry is unlocked after removing the tags. Otherwise, the cache entry's lock is left untouched. <a href="#ga14c0fe9defa4446ddba05261f0310bbe">More...</a><br /></td></tr>
<tr class="separator:ga14c0fe9defa4446ddba05261f0310bbe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaeba4a59377908960626617413fadb656"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__cache.html#gaeba4a59377908960626617413fadb656">globus_gass_cache_mangle_url</a> (const <a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a> cache_handle, const char *url, char **mangled_url, int *length)</td></tr>
<tr class="memdesc:gaeba4a59377908960626617413fadb656"><td class="mdescLeft"> </td><td class="mdescRight">Convert a URL to a string suitable as a file path. <a href="#gaeba4a59377908960626617413fadb656">More...</a><br /></td></tr>
<tr class="separator:gaeba4a59377908960626617413fadb656"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga25f63572180ba1c86d0414c6a556cbec"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__cache.html#ga25f63572180ba1c86d0414c6a556cbec">globus_gass_cache_mangle_tag</a> (const <a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a> cache_handle, const char *tag, char **mangled_tag, int *length)</td></tr>
<tr class="memdesc:ga25f63572180ba1c86d0414c6a556cbec"><td class="mdescLeft"> </td><td class="mdescRight">Convert a tag to a string suitable as a file path. <a href="#ga25f63572180ba1c86d0414c6a556cbec">More...</a><br /></td></tr>
<tr class="separator:ga25f63572180ba1c86d0414c6a556cbec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga763c6dc14cbf28dc41c599411a1af654"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__cache.html#ga763c6dc14cbf28dc41c599411a1af654">globus_gass_cache_get_cache_dir</a> (const <a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a> cache_handle, char **cache_dir)</td></tr>
<tr class="memdesc:ga763c6dc14cbf28dc41c599411a1af654"><td class="mdescLeft"> </td><td class="mdescRight">Get the GASS Cache's root directory. <a href="#ga763c6dc14cbf28dc41c599411a1af654">More...</a><br /></td></tr>
<tr class="separator:ga763c6dc14cbf28dc41c599411a1af654"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0df369d28341998e2e715d415dc0233f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__cache.html#ga0df369d28341998e2e715d415dc0233f">globus_gass_cache_get_dirs</a> (const <a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a> cache_handle, const char *url, const char *tag, char **global_root, char **local_root, char **tmp_root, char **log_root, char **global_dir, char **local_dir)</td></tr>
<tr class="memdesc:ga0df369d28341998e2e715d415dc0233f"><td class="mdescLeft"> </td><td class="mdescRight">Get the set of directories used by a GASS Cache. <a href="#ga0df369d28341998e2e715d415dc0233f">More...</a><br /></td></tr>
<tr class="separator:ga0df369d28341998e2e715d415dc0233f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2174ee073ee291d117f2ed1b5febd1c7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__cache.html#ga2174ee073ee291d117f2ed1b5febd1c7">globus_gass_cache_get_cache_type_string</a> (const <a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a> cache_handle, char **cache_type)</td></tr>
<tr class="memdesc:ga2174ee073ee291d117f2ed1b5febd1c7"><td class="mdescLeft"> </td><td class="mdescRight">Get the type of GASS Cache directory layout. <a href="#ga2174ee073ee291d117f2ed1b5febd1c7">More...</a><br /></td></tr>
<tr class="separator:ga2174ee073ee291d117f2ed1b5febd1c7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0a4d0ff16d804609bb5b9044d1616cf4"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__cache.html#ga0a4d0ff16d804609bb5b9044d1616cf4">globus_gass_cache_error_string</a> (int error_code)</td></tr>
<tr class="memdesc:ga0a4d0ff16d804609bb5b9044d1616cf4"><td class="mdescLeft"> </td><td class="mdescRight">Look up the error string corresponding to a GASS Cache error. <a href="#ga0a4d0ff16d804609bb5b9044d1616cf4">More...</a><br /></td></tr>
<tr class="separator:ga0a4d0ff16d804609bb5b9044d1616cf4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>The GASS cache management API is part of the Globus module called "GASS", (Global Access to Secondary Storage) The GASS cache management API defines calls for manipulating a local file cache.</p>
<p>Each cache entry can be locked during addition and deletion to allow for atomic handling of the cache file contents.</p>
<p>Each cache entry also has an associated timestamp. This timestamp is independent of the local cache file's modification time. Rather, the cache entry timestamp is maintained by the user. It can, for example, be used to keep track of the timestamp of a remote file that is associated with the cache entry.</p>
<p>Note: all timestamps are as seconds since the epoch. (01 Jan 1970, 00:00 GMT)</p>
<p>The following functions are part of the API:</p>
<ul>
<li><a class="el" href="group__globus__gass__cache.html#ga3c989ae2243b1fea8bedcca6a4d741ed" title="Open a GASS Cache. ">globus_gass_cache_open()</a></li>
<li><a class="el" href="group__globus__gass__cache.html#ga0e5c16639ae45f42171604704b37110a" title="Close a cache handle. ">globus_gass_cache_close()</a></li>
<li><a class="el" href="group__globus__gass__cache.html#gaca303625ca1ed7f52f5d894ef451cbf0" title="Add a tag to an URL in the cache. ">globus_gass_cache_add()</a></li>
<li><a class="el" href="group__globus__gass__cache.html#ga0ae7193171a64977cf05f3eaa3aa8b13" title="Complete adding a cache entry and unlock it. ">globus_gass_cache_add_done()</a></li>
<li><a class="el" href="group__globus__gass__cache.html#ga67947289f7bdfdcb86f97ab7aa551263" title="Remove a cache tag. ">globus_gass_cache_delete_start()</a></li>
<li><a class="el" href="group__globus__gass__cache.html#gac336211487f5e6c0bd155ff0227fbd3f" title="Remove one instance of the tag from the cache entry's tag list. ">globus_gass_cache_delete()</a></li>
<li><a class="el" href="group__globus__gass__cache.html#ga7a9fd887faee710170cc708a18211af2" title="Remove a tag from a cache entry. ">globus_gass_cache_cleanup_tag()</a></li>
<li><a class="el" href="group__globus__gass__cache.html#ga14c0fe9defa4446ddba05261f0310bbe" title="Remove a tag from all cache entriesRemove all instances of the tag from the cache entry's tag list...">globus_gass_cache_cleanup_tag_all()</a></li>
<li><a class="el" href="group__globus__gass__cache.html#gaeba4a59377908960626617413fadb656" title="Convert a URL to a string suitable as a file path. ">globus_gass_cache_mangle_url()</a></li>
<li><a class="el" href="group__globus__gass__cache.html#ga25f63572180ba1c86d0414c6a556cbec" title="Convert a tag to a string suitable as a file path. ">globus_gass_cache_mangle_tag()</a></li>
<li><a class="el" href="group__globus__gass__cache.html#ga0df369d28341998e2e715d415dc0233f" title="Get the set of directories used by a GASS Cache. ">globus_gass_cache_get_dirs()</a></li>
<li><a class="el" href="group__globus__gass__cache.html#ga763c6dc14cbf28dc41c599411a1af654" title="Get the GASS Cache's root directory. ">globus_gass_cache_get_cache_dir()</a> </li>
</ul>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="gac7b08c687f5a11068ae4929b28bb33bf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct globus_i_gass_cache_t* <a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>GASS Cache Handle. </p>
<p>Data structure used to store informations concerning an open cache directory. This structure MUST NOT be modified directly, but passed to the globus_gass_cache functions </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gaca303625ca1ed7f52f5d894ef451cbf0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_cache_add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a> </td>
<td class="paramname"><em>cache_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">const char * </td>
<td class="paramname"><em>tag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_bool_t </td>
<td class="paramname"><em>create</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long * </td>
<td class="paramname"><em>timestamp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>local_filename</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a tag to an URL in the cache. </p>
<p>Create a new cache file or add a tag on it.</p>
<p>If the URL is already in the cache but is locked, then this call will block until the cache entry is unlocked, then will proceed with the subsequent operations.</p>
<p>If the URL is already in the cache and unlocked, then add the tag to the cache entry's tag list, return the local cache filename in *local_filename, return the entry's current timestamp in *timestamp, lock the cache entry, and return GLOBUS_GASS_CACHE_ADD_EXISTS.</p>
<p>If the URL is not in the cache, and create==GLOBUS_TRUE, then create a new unique empty local cache file, add it to the cache with the specified tag, return the filename in *local_filename, return *timestamp set to GLOBUS_GASS_CACHE_TIMESTAMP_UNKNOWN, lock the cache entry, and return GLOBUS_GASS_CACHE_ADD_NEW.</p>
<p>If the URL is not in the cache, and create==GLOBUS_FALSE, then do not add it to the cache, and return GLOBUS_GASS_CACHE_URL_NOT_FOUND.</p>
<p>If this function returns GLOBUS_GASS_CACHE_ADD_EXISTS or GLOBUS_GASS_CACHE_ADD_NEW, then <a class="el" href="group__globus__gass__cache.html#ga0ae7193171a64977cf05f3eaa3aa8b13" title="Complete adding a cache entry and unlock it. ">globus_gass_cache_add_done()</a> or <a class="el" href="group__globus__gass__cache.html#gac336211487f5e6c0bd155ff0227fbd3f" title="Remove one instance of the tag from the cache entry's tag list. ">globus_gass_cache_delete()</a> must be subsequently called to unlock the cache entry.</p>
<p>Subsequent calls to <a class="el" href="group__globus__gass__cache.html#gaca303625ca1ed7f52f5d894ef451cbf0" title="Add a tag to an URL in the cache. ">globus_gass_cache_add()</a> and <a class="el" href="group__globus__gass__cache.html#ga67947289f7bdfdcb86f97ab7aa551263" title="Remove a cache tag. ">globus_gass_cache_delete_start()</a> on the same cache and url, made either from this process or another, will block until the cache entry is unlocked.</p>
<p>If tag==NULL, then a tag with the value "null" will be added to the cache entry's tag list.</p>
<p>The same tag can be used multiple times, in which case this tag will be added to the entry's tag list multiple times.</p>
<p>Note: It is recommended that proglobus_grams started via GLOBUS_GRAM pass a tag value of getenv("GLOBUS_GRAM_JOB_CONTACT"), since upon completion of a job GLOBUS_GRAM will automatically cleanup entries with this tag.</p>
<dl class="section note"><dt>Note</dt><dd>the local_filename MUST be free by the user in a subsequent operation, using free()</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cache_handle</td><td>Handle to the opened cache directory to use. </td></tr>
<tr><td class="paramname">url</td><td>URL of the file to be cached. It is used as the main key to the cache entries. </td></tr>
<tr><td class="paramname">tag</td><td>Tag specifying which job is/are using the cache. This is usually the GLOBUS_GRAM_JOB_CONTACT. Can be NULL or empty; the tag "null" is then used. create - Tells if the cache entry should be created if it is not already existing. </td></tr>
<tr><td class="paramname">create</td><td>Flag to create if it does not already exist. </td></tr>
<tr><td class="paramname">timestamp</td><td>Timestamp of the cached file, set by globus_gass_cache_done(), (or <a class="el" href="group__globus__gass__cache.html#gac336211487f5e6c0bd155ff0227fbd3f" title="Remove one instance of the tag from the cache entry's tag list. ">globus_gass_cache_delete()</a> ). </td></tr>
<tr><td class="paramname">local_filename</td><td>Path the the local file caching the file specified by "url". NULL if "url" not yet cached and creation not requested (create false).</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>GLOBUS_GASS_CACHE_URL_NOT_FOUND</li>
<li>GLOBUS_GASS_CACHE_ADD_NEW</li>
<li>GLOBUS_GASS_CACHE_ADD_EXISTS</li>
<li>or any of the defined gass error code. </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="ga0ae7193171a64977cf05f3eaa3aa8b13"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_cache_add_done </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a> </td>
<td class="paramname"><em>cache_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">const char * </td>
<td class="paramname"><em>tag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>timestamp</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Complete adding a cache entry and unlock it. </p>
<p><a class="el" href="group__globus__gass__cache.html#ga0ae7193171a64977cf05f3eaa3aa8b13" title="Complete adding a cache entry and unlock it. ">globus_gass_cache_add_done()</a> MUST be called after <a class="el" href="group__globus__gass__cache.html#gaca303625ca1ed7f52f5d894ef451cbf0" title="Add a tag to an URL in the cache. ">globus_gass_cache_add()</a>, to set the timestamp in the cache entry for the URL, and then unlock the cache entry. (The only case it does not need to be called is if <a class="el" href="group__globus__gass__cache.html#gaca303625ca1ed7f52f5d894ef451cbf0" title="Add a tag to an URL in the cache. ">globus_gass_cache_add()</a> has returned GLOBUS_GASS_CACHE_URL_NOT_FOUND, of course.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cache_handle</td><td>Handle to the opened cache directory to use. </td></tr>
<tr><td class="paramname">url</td><td>URL of the cached file to set as "done" (unlock) </td></tr>
<tr><td class="paramname">tag</td><td>Tag specifying which job has locked the cache and must therefore be unlocked. It is an error to call this function with a tag which does not currently own the cache lock. </td></tr>
<tr><td class="paramname">timestamp</td><td>Timestamp of the cached file.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__globus__gass__cache.html#ga0ae7193171a64977cf05f3eaa3aa8b13" title="Complete adding a cache entry and unlock it. ">globus_gass_cache_add_done()</a> returns GLOBUS_SUCCESS or any of the defined GASS Cache error codes. </dd></dl>
</div>
</div>
<a class="anchor" id="ga7a9fd887faee710170cc708a18211af2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_cache_cleanup_tag </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a> </td>
<td class="paramname"><em>cache_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">const char * </td>
<td class="paramname"><em>tag</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove a tag from a cache entry. </p>
<p>Remove all instances of the tag from the cache entry's tag list. If there are no more tags in the tag list, then remove this cache entry and delete the associated local cache file. If the cache entry is locked with the same tag as is passed to this function, then the entry is unlocked after removing the tags. Otherwise, the cache entry's lock is left untouched.</p>
<p>This function does not block on a locked reference.</p>
<dl class="section note"><dt>Note</dt><dd>The GLOBUS_GRAM job manager will automatically call this function with a tag of getenv("GLOBUS_GRAM_JOB_CONTACT") upon completion of a job.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cache_handle</td><td>Handle to the opened cache directory to use. </td></tr>
<tr><td class="paramname">url</td><td>URL of the file to be cached. It is used as the main key to the cache entries. </td></tr>
<tr><td class="paramname">tag</td><td>Tag specifying which job is/are using the cache. This is usually the GLOBUS_GRAM_JOB_CONTACT. Can be NULL or empty; the tag "null" is then used. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="group__globus__gass__cache.html#ga7a9fd887faee710170cc708a18211af2" title="Remove a tag from a cache entry. ">globus_gass_cache_cleanup_tag()</a> function returns GLOBUS_SUCCESS or any of the defined GASS Cache error codes. </dd></dl>
</div>
</div>
<a class="anchor" id="ga14c0fe9defa4446ddba05261f0310bbe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_cache_cleanup_tag_all </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a> </td>
<td class="paramname"><em>cache_handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>tag</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove a tag from all cache entriesRemove all instances of the tag from the cache entry's tag list. If there are no more tags in the tag list, then remove this cache entry and delete the associated local cache file. If the cache entry is locked with the same tag as is passed to this function, then the entry is unlocked after removing the tags. Otherwise, the cache entry's lock is left untouched. </p>
<p>This function does not block on a locked reference. This function differs from <a class="el" href="group__globus__gass__cache.html#ga7a9fd887faee710170cc708a18211af2" title="Remove a tag from a cache entry. ">globus_gass_cache_cleanup_tag()</a> in that this cleans up <b>all</b> URLs related with this tag.</p>
<dl class="section note"><dt>Note</dt><dd>The GLOBUS_GRAM job manager will automatically call this function with a tag of getenv("GLOBUS_GRAM_JOB_CONTACT") upon completion of a job.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cache_handle</td><td>Handle to the opened cache directory to use. </td></tr>
<tr><td class="paramname">tag</td><td>Tag specifying which job is/are using the cache. This is usually the GLOBUS_GRAM_JOB_CONTACT. Can be NULL or empty; the tag "null" is then used.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="group__globus__gass__cache.html#ga14c0fe9defa4446ddba05261f0310bbe" title="Remove a tag from all cache entriesRemove all instances of the tag from the cache entry's tag list...">globus_gass_cache_cleanup_tag_all()</a> function returns GLOBUS_SUCCESS or any of the defined GASS Cache error codes. </dd></dl>
</div>
</div>
<a class="anchor" id="ga0e5c16639ae45f42171604704b37110a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_cache_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a> * </td>
<td class="paramname"><em>cache_handlep</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close a cache handle. </p>
<p>Close (NOT delete) a previously opened cache:</p><ul>
<li>close the opened files and</li>
<li>free the memory allocated for the cache_handle.</li>
<li>mark the handle as "not initialized".</li>
</ul>
<p>Parameters: cache_handle: Handle to the opened cache directory to use.</p>
<p>cache_handle->is_init set to "not initialized" and all the files opened bu globus_gass_cache_open are closed .</p>
<p>Returns: GLOBUS_SUCCESS or error code: GLOBUS_GASS_CACHE_ERROR_CACHE_NOT_OPENED </p>
</div>
</div>
<a class="anchor" id="gac336211487f5e6c0bd155ff0227fbd3f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_cache_delete </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a> </td>
<td class="paramname"><em>cache_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">const char * </td>
<td class="paramname"><em>tag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>timestamp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_bool_t </td>
<td class="paramname"><em>is_locked</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove one instance of the tag from the cache entry's tag list. </p>
<p>If there are no more tags in the tag list, then remove this cache entry and delete the associated local cache file.</p>
<p>Otherwise, update the timestamp to the passed value.</p>
<p>This call will leave the cache entry unlocked.</p>
<p>If is_locked==GLOBUS_TRUE, then this cache entry was locked during a previous call to <a class="el" href="group__globus__gass__cache.html#gaca303625ca1ed7f52f5d894ef451cbf0" title="Add a tag to an URL in the cache. ">globus_gass_cache_add()</a> or <a class="el" href="group__globus__gass__cache.html#ga67947289f7bdfdcb86f97ab7aa551263" title="Remove a cache tag. ">globus_gass_cache_delete_start()</a>. The cache file should be locked by the corresponding url/tag, or an error is returned. If it is locked by the corresponding url/tag, then the normal operation occur, whithout blocking (remove one instance from the tag update the timestamp and unlock the cache).</p>
<p>If is_locked==GLOBUS_FALSE, eventually wait the cache is not locked any more, and then proceed with the normal operations.(remove one instance from the tag list and update the timestamp).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cache_handle</td><td>Handle to the opened cache directory to use. </td></tr>
<tr><td class="paramname">url</td><td>URL of the file to be cached. It is used as the main key to the cache entries. </td></tr>
<tr><td class="paramname">tag</td><td>Tag specifying which job is/are using the cache. This is usually the GLOBUS_GRAM_JOB_CONTACT. Can be NULL or empty; the tag "null" is then used. </td></tr>
<tr><td class="paramname">timestamp</td><td>Timestamp of the cached file. </td></tr>
<tr><td class="paramname">is_locked</td><td>Indicate if this cache entry was locked during a previous call to <a class="el" href="group__globus__gass__cache.html#gaca303625ca1ed7f52f5d894ef451cbf0" title="Add a tag to an URL in the cache. ">globus_gass_cache_add()</a> or <a class="el" href="group__globus__gass__cache.html#ga67947289f7bdfdcb86f97ab7aa551263" title="Remove a cache tag. ">globus_gass_cache_delete_start()</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="group__globus__gass__cache.html#gac336211487f5e6c0bd155ff0227fbd3f" title="Remove one instance of the tag from the cache entry's tag list. ">globus_gass_cache_delete()</a> function returns GLOBUS_SUCCESS or any of the defined GASS Cache error codes. </dd></dl>
</div>
</div>
<a class="anchor" id="ga67947289f7bdfdcb86f97ab7aa551263"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_cache_delete_start </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a> </td>
<td class="paramname"><em>cache_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">const char * </td>
<td class="paramname"><em>tag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long * </td>
<td class="paramname"><em>timestamp</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove a cache tag. </p>
<p>Lock the cache entry for the URL, and return the cache entry's current timestamp in *timestamp. This function will block if the data file is already locked, until it is unlocked.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cache_handle</td><td>Handle to the opened cache directory to use.</td></tr>
<tr><td class="paramname">url</td><td>URL of the cached file to set as "done" (unlock) </td></tr>
<tr><td class="paramname">tag</td><td>Tag specifying which job has locked the cache and must therefore be unlocked. It is an error to call this function with a tag which does not currently own the cache lock. </td></tr>
<tr><td class="paramname">timestamp</td><td>Timestamp of the cached file, set by globus_gass_cache_done(), (or <a class="el" href="group__globus__gass__cache.html#gac336211487f5e6c0bd155ff0227fbd3f" title="Remove one instance of the tag from the cache entry's tag list. ">globus_gass_cache_delete()</a> ).</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="group__globus__gass__cache.html#ga67947289f7bdfdcb86f97ab7aa551263" title="Remove a cache tag. ">globus_gass_cache_delete_start()</a> function returns GLOBUS_SUCCESS or any of the defined GASS Cache error code. </dd></dl>
</div>
</div>
<a class="anchor" id="ga0a4d0ff16d804609bb5b9044d1616cf4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* globus_gass_cache_error_string </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>error_code</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Look up the error string corresponding to a GASS Cache error. </p>
<p>Return a pointer on an error description string.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">error_code</td><td>error code returned by a previously called globus_gass_cache function.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="group__globus__gass__cache.html#ga0a4d0ff16d804609bb5b9044d1616cf4" title="Look up the error string corresponding to a GASS Cache error. ">globus_gass_cache_error_string()</a> function returns a pointer to an error message, or NULL if error_code is invalid. </dd></dl>
</div>
</div>
<a class="anchor" id="ga763c6dc14cbf28dc41c599411a1af654"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_cache_get_cache_dir </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a> </td>
<td class="paramname"><em>cache_handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>cache_dir</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the GASS Cache's root directory. </p>
<p>Get a the root cache of directory. This is exported for use in the globus_gass_cache program.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cache_handle</td><td>Handle to the opened cache directory to use. </td></tr>
<tr><td class="paramname">cache_dir</td><td>Pointer to the cache directory</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">GLOBUS_SUCCESS</td><td>Success </td></tr>
<tr><td class="paramname">GLOBUS_GASS_CACHE_ERROR_NO_MEMORY</td><td>No memory </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga2174ee073ee291d117f2ed1b5febd1c7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_cache_get_cache_type_string </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a> </td>
<td class="paramname"><em>cache_handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>cache_type</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the type of GASS Cache directory layout. </p>
<p>Get a string which describes the cache type ("normal" or "flat")</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cache_handle</td><td>Handle to the opened cache directory to use. </td></tr>
<tr><td class="paramname">cache_type</td><td>Pointer to the strdup()ed string</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">GLOBUS_SUCCESS</td><td>Success </td></tr>
<tr><td class="paramname">GLOBUS_GASS_CACHE_ERROR_NO_MEMORY</td><td>No memory </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga0df369d28341998e2e715d415dc0233f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_cache_get_dirs </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a> </td>
<td class="paramname"><em>cache_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">const char * </td>
<td class="paramname"><em>tag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>global_root</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>local_root</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>tmp_root</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>log_root</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>global_dir</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>local_dir</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the set of directories used by a GASS Cache. </p>
<p>Gets a bunch of directories. This is exported for use in the globus_gass_cache program.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cache_handle</td><td>Handle to the opened cache directory to use. </td></tr>
<tr><td class="paramname">url</td><td>The incoming URL </td></tr>
<tr><td class="paramname">tag</td><td>The incoming tag </td></tr>
<tr><td class="paramname">local_root</td><td>Pointer to the "local root" directory </td></tr>
<tr><td class="paramname">global_root</td><td>Pointer to the "global root" directory </td></tr>
<tr><td class="paramname">tmp_root</td><td>Pointer to the "tmp root" directory </td></tr>
<tr><td class="paramname">log_root</td><td>Pointer to the root log directory </td></tr>
<tr><td class="paramname">local_dir</td><td>Pointer to the related "local" directory </td></tr>
<tr><td class="paramname">global_dir</td><td>Pointer to the related "global" directory</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">GLOBUS_SUCCESS</td><td>Success </td></tr>
<tr><td class="paramname">GLOBUS_GASS_CACHE_ERROR_NO_MEMORY</td><td>No memory </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga25f63572180ba1c86d0414c6a556cbec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_cache_mangle_tag </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a> </td>
<td class="paramname"><em>cache_handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>tag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>mangled_tag</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>Convert a tag to a string suitable as a file path. </p>
<p>Mangles the given tag into a chunk suitable for using as a file / path name. This is exported for use in the globus_gass_cache program.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cache_handle</td><td>Handle to the opened cache directory to use. </td></tr>
<tr><td class="paramname">tag</td><td>The incoming tag to mangle (NULL-terminated) </td></tr>
<tr><td class="paramname">mangled_tag</td><td>Pointer to the output string; a buffer for the real string is malloc()ed for the application. If mangled is NULL, then no such buffer is allocated, and no mangled string is created. This can be useful to just get the length of the mangled string. </td></tr>
<tr><td class="paramname">length</td><td>A pointer to the length of the resulting string. If NULL, this is not assigned to.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">GLOBUS_SUCCESS</td><td>Success </td></tr>
<tr><td class="paramname">GLOBUS_GASS_CACHE_ERROR_NO_MEMORY</td><td>No memory </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaeba4a59377908960626617413fadb656"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_cache_mangle_url </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a> </td>
<td class="paramname"><em>cache_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">char ** </td>
<td class="paramname"><em>mangled_url</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>Convert a URL to a string suitable as a file path. </p>
<p>Mangles the given URL into a chunk suitable for using as a file / path name. This is exported for use in the globus_gass_cache program.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cache_handle</td><td>Handle to the opened cache directory to use. </td></tr>
<tr><td class="paramname">url</td><td>The incoming URL to mangle (NULL-terminated) </td></tr>
<tr><td class="paramname">mangled_url</td><td>Pointer to the output string; a buffer for the real string is malloc()ed for the application. If mangled is NULL, then no such buffer is allocated, and no mangled string is created. This can be useful to just get the length of the mangled string. </td></tr>
<tr><td class="paramname">length</td><td>A pointer to the length of the resulting string. If NULL, this is not assigned to.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">GLOBUS_SUCCESS</td><td>Success </td></tr>
<tr><td class="paramname">GLOBUS_GASS_CACHE_ERROR_NO_MEMORY</td><td>No memory </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga3c989ae2243b1fea8bedcca6a4d741ed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_cache_open </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>cache_directory_path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a> * </td>
<td class="paramname"><em>cache_handlep</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open a GASS Cache. </p>
<p>Open the cache specified by the cache_directory_path argument, and return a cache handle that can be used in subsequent cache calls.</p>
<p>If cache_directory_path is NULL, then use the value contained in the GLOBUS_GASS_CACHE_DEFAULT environment variable if it is defined, otherwise use ~/.globus_gass_cache.</p>
<p>The cache_directory_path must be a directory. If it is a file, this call will fail with a non-0 return value.</p>
<p>If the specified directory does not exist, then this call will create the directory.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cache_directory_path</td><td>Path to the cache directory to open. Can be NULL (see above) </td></tr>
<tr><td class="paramname">cache_handlep</td><td>Structure containning all the necessary information to access the cache (file names, descriptor,...) (see globus_gass_gache.h) Some files are also opened: <a class="el" href="group__globus__gass__cache.html#ga0e5c16639ae45f42171604704b37110a" title="Close a cache handle. ">globus_gass_cache_close()</a> must be called subsequently to close those files. This parameter is modified by the <a class="el" href="group__globus__gass__cache.html#ga3c989ae2243b1fea8bedcca6a4d741ed" title="Open a GASS Cache. ">globus_gass_cache_open()</a></td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">GLOBUS_SUCCESS</td><td>Success </td></tr>
<tr><td class="paramname">GLOBUS_GASS_CACHE_ERROR_CACHE_ALREADY_OPENED</td><td>Handle already opened </td></tr>
<tr><td class="paramname">GLOBUS_GASS_CACHE_ERROR_NAME_TOO_LONG</td><td>Path name too long </td></tr>
<tr><td class="paramname">GLOBUS_GASS_CACHE_ERROR_NO_HOME</td><td>Can't find home directory for default cache path </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gad9afcfebc9147b1e7c55661dffa932a6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_cache_query </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__gass__cache.html#gac7b08c687f5a11068ae4929b28bb33bf">globus_gass_cache_t</a> </td>
<td class="paramname"><em>cache_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">const char * </td>
<td class="paramname"><em>tag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_bool_t </td>
<td class="paramname"><em>wait_for_lock</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long * </td>
<td class="paramname"><em>timestamp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>local_filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_bool_t * </td>
<td class="paramname"><em>is_locked</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Query the GASS Cache. </p>
<p>Query if an item is in the cache</p>
<p>This call will block only if wait_for_lock is GLOBUS_TRUE</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cache_handle</td><td>Handle to the opened cache directory to use. </td></tr>
<tr><td class="paramname">url</td><td>URL of the file to query. It is used as the main key to the cache entries. </td></tr>
<tr><td class="paramname">tag</td><td>Tag specifying which job is/are using the cache. This is usually the GLOBUS_GRAM_JOB_CONTACT. Can be NULL or empty; the tag "null" is then used. </td></tr>
<tr><td class="paramname">wait_for_lock</td><td>If GLOBUS_TRUE, wait for any lock existing lock to be released. If GLOBUS_FALSE, doesn't wait for a lock to be released. </td></tr>
<tr><td class="paramname">timestamp</td><td>Timestamp of the cached file, set by globus_gass_cache_done(), (or <a class="el" href="group__globus__gass__cache.html#gac336211487f5e6c0bd155ff0227fbd3f" title="Remove one instance of the tag from the cache entry's tag list. ">globus_gass_cache_delete()</a> ). </td></tr>
<tr><td class="paramname">local_filename</td><td>Path the the local file caching the file specified by "url". NULL if "url" not yet cached and creation not requested (create false). </td></tr>
<tr><td class="paramname">is_locked</td><td>GLOBUS_TRUE if the file is currently (at return time) locked.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="group__globus__gass__cache.html#gad9afcfebc9147b1e7c55661dffa932a6" title="Query the GASS Cache. ">globus_gass_cache_query()</a> function returns GLOBUS_SUCCESS, GLOBUS_GASS_CACHE_URL_NOT_FOUND, or any of the defined gass error code. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
|