/usr/share/doc/libglobus-gass-cache-dev/html/globus__i__gass__cache__config_8h_source.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 | <!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_i_gass_cache_config.h Source File</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><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>
</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="headertitle">
<div class="title">globus_i_gass_cache_config.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright 1999-2006 University of Chicago</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * </span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * You may obtain a copy of the License at</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * </span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * </span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> */</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef GLOBUS_DONT_DOCUMENT_INTERNAL</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#ifndef GLOBUS_I_GASS_CACHE_CONFIG_H</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#define GLOBUS_I_GASS_CACHE_CONFIG_H</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "globus_hashtable.h"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#define GLOBUS_L_ERROR_CONFIG_FILE_NOT_FOUND -200</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#define GLOBUS_L_ERROR_CONFIG_FILE_READ -201</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#define GLOBUS_L_ERROR_CONFIG_FILE_PARSE_ERROR -202</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">/* config structure definition */</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>globus_l_gass_cache_config_s </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordtype">char</span>* buf; <span class="comment">/* buffer that holds the config file */</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  globus_hashtable_t table; <span class="comment">/* parsed config entries (hashtable) */</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> } globus_l_gass_cache_config_t;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">/*</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * globus_l_gass_cache_config_init()</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> *</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * Inits the config structure by reading from a file.</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * </span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * Parameters:</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * - directory the GASS cache directory </span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * - config the config structure</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * </span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * Returns:</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * - GLOBUS_SUCCESS upon success</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> */</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="keywordtype">int</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> globus_l_gass_cache_config_init(<span class="keywordtype">char</span>* file,</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  globus_l_gass_cache_config_t *config);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">/*</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * globus_l_gass_cache_config_destroy()</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> *</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * Destroys the config structure</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * </span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * Parameters:</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * - config the config structure</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * </span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * Returns:</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> */</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="keywordtype">int</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> globus_l_gass_cache_config_destroy(globus_l_gass_cache_config_t *config);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment">/*</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> * globus_l_gass_cache_config_get()</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> *</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * Retrieves a config entry</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * </span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * Parameters:</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * - config the config structure</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * - key the config parameter</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * </span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> * Returns:</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> * the value associated with 'key', or GLOBUS_NULL</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> */</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="keywordtype">char</span>*</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> globus_l_gass_cache_config_get(globus_l_gass_cache_config_t *config,</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">char</span>* key);</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment">/*</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> * globus_l_gass_cache_config_get()</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> *</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> * Defines a new config entry</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> * </span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> * Parameters:</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> * - config the config structure</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * - key the config parameter</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> * - value the config parameter value</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * </span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> * Returns:</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> */</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="keywordtype">int</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> globus_l_gass_cache_config_set(globus_l_gass_cache_config_t *config,</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordtype">char</span> *key,</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keywordtype">char</span> *value);</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment">/*</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * globus_l_gass_cache_config_save()</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> *</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> * Saves the configuration to a file. NOTE: Any comments in the file</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> * will be lost!</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> * </span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> * Parameters:</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> * - config the config structure</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * - file the file to write to</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * - overwrite if TRUE, will overwrite existing file</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * </span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> * Returns:</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> */</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="keywordtype">int</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> globus_l_gass_cache_config_save(globus_l_gass_cache_config_t *config,</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keywordtype">char</span> *file,</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  globus_bool_t *overwrite);</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> }</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="preprocessor">#endif </span><span class="comment">/* GLOBUS_I_GASS_CACHE_CONFIG_H */</span><span class="preprocessor"></span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="preprocessor">#endif </span><span class="comment">/* GLOBUS_DONT_DOCUMENT_INTERNAL */</span><span class="preprocessor"></span></div></div><!-- fragment --></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>
|