/usr/share/doc/libglobus-gass-transfer-dev/html/group__globus__gass__transfer__referral.html is in libglobus-gass-transfer-doc 8.10-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 | <!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>globus_gass_transfer: Referrals</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>
<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_transfer
 <span id="projectnumber">8.10</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Referrals<div class="ingroups"><a class="el" href="group__globus__gass__transfer.html">GASS Transfer API</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>GASS Referrals.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Referrals:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group__globus__gass__transfer__referral.png" border="0" alt="" usemap="#group____globus____gass____transfer____referral"/>
<map name="group____globus____gass____transfer____referral" id="group____globus____gass____transfer____referral">
<area shape="rect" id="node2" href="group__globus__gass__transfer.html" title="GASS Transfer API. " alt="" coords="5,5,144,32"/>
</map>
</td></tr></table></center>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga94a96c132f5e471b146a9645848081ce"><td class="memItemLeft" align="right" valign="top">globus_size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__referral.html#ga94a96c132f5e471b146a9645848081ce">globus_gass_transfer_referral_get_count</a> (globus_gass_transfer_referral_t *referral)</td></tr>
<tr class="separator:ga94a96c132f5e471b146a9645848081ce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3bff48d2b5c72ed1c4b7a02aec2089c7"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__referral.html#ga3bff48d2b5c72ed1c4b7a02aec2089c7">globus_gass_transfer_referral_get_url</a> (globus_gass_transfer_referral_t *referral, globus_size_t index)</td></tr>
<tr class="separator:ga3bff48d2b5c72ed1c4b7a02aec2089c7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae83589cda7d1515d778db2c3a8f8969e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__referral.html#gae83589cda7d1515d778db2c3a8f8969e">globus_gass_transfer_referral_destroy</a> (globus_gass_transfer_referral_t *referral)</td></tr>
<tr class="separator:gae83589cda7d1515d778db2c3a8f8969e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>GASS Referrals. </p>
<p>The GASS Transfer API supports referring URL requests to alternate URLs via referrals. Referrals are essentially pointers to another URL or URLs which contain the same file as the original location which a client has requested of a server. Referrals may span multiple protocol schemes, though not all protocols may be able to generate referrals. For example, an HTTP server may refer a client to another HTTP server, an HTTPS server.</p>
<p>Upon receiving a referred response from a server, a client should query the request handle to determine from where the file can be retrieved. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="gae83589cda7d1515d778db2c3a8f8969e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae83589cda7d1515d778db2c3a8f8969e">◆ </a></span>globus_gass_transfer_referral_destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_transfer_referral_destroy </td>
<td>(</td>
<td class="paramtype">globus_gass_transfer_referral_t * </td>
<td class="paramname"><em>referral</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free all memory used by a referral.</p>
<p>This function frees all memory used by this referral. After calling this function, the strings returned by calling <a class="el" href="group__globus__gass__transfer__referral.html#ga3bff48d2b5c72ed1c4b7a02aec2089c7">globus_gass_transfer_referral_get_url()</a> must not be accessed. Any further attempts to extract informatoin from this referral will fail.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">referral</td><td>The referral to destroy.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">GLOBUS_SUCCESS</td><td>The referral was successfully destroyed. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER</td><td>The referral parameter was GLOBUS_NULL. It could not be destroyed. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga94a96c132f5e471b146a9645848081ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga94a96c132f5e471b146a9645848081ce">◆ </a></span>globus_gass_transfer_referral_get_count()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_size_t globus_gass_transfer_referral_get_count </td>
<td>(</td>
<td class="paramtype">globus_gass_transfer_referral_t * </td>
<td class="paramname"><em>referral</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of URLs in this referral.</p>
<p>This function examines the referral to determine if the number of URLs which are contained in it. Each of these URLs should either point to another referral, or to a URL containing the equivalent file as the original URL request which caused this referral.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">referral</td><td>The referral structure to query.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns the number of URL entries in the referral, or 0, if there are none. </dd></dl>
</div>
</div>
<a id="ga3bff48d2b5c72ed1c4b7a02aec2089c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3bff48d2b5c72ed1c4b7a02aec2089c7">◆ </a></span>globus_gass_transfer_referral_get_url()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* globus_gass_transfer_referral_get_url </td>
<td>(</td>
<td class="paramtype">globus_gass_transfer_referral_t * </td>
<td class="paramname"><em>referral</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_size_t </td>
<td class="paramname"><em>index</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a URL string from a referral.</p>
<p>This function examines the referral to retrieve a URL string from it. A valid referal will contain one or more strings. They are indexed from 0 to the value returned by <a class="el" href="group__globus__gass__transfer__referral.html#ga94a96c132f5e471b146a9645848081ce">globus_gass_transfer_referral_get_count()</a> - 1.</p>
<p>The string returned by this function must not be freed by the caller. It will remain valid until the referral structure is destroyed.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">referral</td><td>The referral structure to query.</td></tr>
<tr><td class="paramname">index</td><td>The URL to extract from the referral. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns a string pointer containing the URL, or NULL if the index or referral were invalid. </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.13
</small></address>
</body>
</html>
|