/usr/share/doc/libglobus-gass-cache-dev/html/globus__gass__cache_8h.html is in libglobus-gass-cache-doc 9.4-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 | <!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_cache: globus_gass_cache.h File Reference</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_cache
 <span id="projectnumber">9.4</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 class="current"><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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<!-- 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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Modules</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><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><!-- top -->
<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.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>GASS Cache API.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "globus_common.h"</code><br />
<code>#include <sys/param.h></code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for globus_gass_cache.h:</div>
<div class="dyncontent">
<div class="center"><img src="globus__gass__cache_8h__incl.png" border="0" usemap="#globus__gass__cache_8h" alt=""/></div>
<map name="globus__gass__cache_8h" id="globus__gass__cache_8h">
</map>
</div>
</div>
<p><a href="globus__gass__cache_8h_source.html">Go to the source code of this file.</a></p>
<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 <br class="typebreak" />
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="group__globus__gass__cache.html#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_handle)</td></tr>
<tr class="memdesc:ga3c989ae2243b1fea8bedcca6a4d741ed"><td class="mdescLeft"> </td><td class="mdescRight">Open a GASS Cache. <a href="group__globus__gass__cache.html#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_handle)</td></tr>
<tr class="memdesc:ga0e5c16639ae45f42171604704b37110a"><td class="mdescLeft"> </td><td class="mdescRight">Close a cache handle. <a href="group__globus__gass__cache.html#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="group__globus__gass__cache.html#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="group__globus__gass__cache.html#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="group__globus__gass__cache.html#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="group__globus__gass__cache.html#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="group__globus__gass__cache.html#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="group__globus__gass__cache.html#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="group__globus__gass__cache.html#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="group__globus__gass__cache.html#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="group__globus__gass__cache.html#ga25f63572180ba1c86d0414c6a556cbec">More...</a><br /></td></tr>
<tr class="separator:ga25f63572180ba1c86d0414c6a556cbec"><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="group__globus__gass__cache.html#ga0df369d28341998e2e715d415dc0233f">More...</a><br /></td></tr>
<tr class="separator:ga0df369d28341998e2e715d415dc0233f"><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="group__globus__gass__cache.html#ga763c6dc14cbf28dc41c599411a1af654">More...</a><br /></td></tr>
<tr class="separator:ga763c6dc14cbf28dc41c599411a1af654"><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="group__globus__gass__cache.html#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="group__globus__gass__cache.html#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>
<div class="textblock"><p>GASS Cache API. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Oct 2 2014 16:19:57 for globus_gass_cache 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>
|