/usr/share/doc/libglobus-gass-transfer-dev/html/group__globus__gass__transfer__data.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 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 | <!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: Sending and Receiving Data</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="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Sending and Receiving Data</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga6ec33acb4a5a518b8c45db10daba7160"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__data.html#ga6ec33acb4a5a518b8c45db10daba7160">globus_gass_transfer_bytes_callback_t</a>) (void *arg, <a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request, globus_byte_t *bytes, globus_size_t length, globus_bool_t last_data)</td></tr>
<tr class="separator:ga6ec33acb4a5a518b8c45db10daba7160"><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:gaf9fafa443774f59abd5a6584bdeee646"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__data.html#gaf9fafa443774f59abd5a6584bdeee646">globus_gass_transfer_send_bytes</a> (<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request, globus_byte_t *bytes, globus_size_t send_length, globus_bool_t last_data, <a class="el" href="group__globus__gass__transfer__data.html#ga6ec33acb4a5a518b8c45db10daba7160">globus_gass_transfer_bytes_callback_t</a> callback, void *user_arg)</td></tr>
<tr class="separator:gaf9fafa443774f59abd5a6584bdeee646"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacd7c5a82e0018c76dfce993035a5bf6a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__data.html#gacd7c5a82e0018c76dfce993035a5bf6a">globus_gass_transfer_receive_bytes</a> (<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request, globus_byte_t *bytes, globus_size_t max_length, globus_size_t wait_for_length, <a class="el" href="group__globus__gass__transfer__data.html#ga6ec33acb4a5a518b8c45db10daba7160">globus_gass_transfer_bytes_callback_t</a> callback, void *user_arg)</td></tr>
<tr class="separator:gacd7c5a82e0018c76dfce993035a5bf6a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga6ec33acb4a5a518b8c45db10daba7160"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6ec33acb4a5a518b8c45db10daba7160">◆ </a></span>globus_gass_transfer_bytes_callback_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* globus_gass_transfer_bytes_callback_t) (void *arg, <a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request, globus_byte_t *bytes, globus_size_t length, globus_bool_t last_data)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Byte send or receive callback function.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">arg</td><td>The user_arg passed to the function which registered this callback. The user may use this value for any purpose. </td></tr>
<tr><td class="paramname">request</td><td>The request handle associated with this byte array. </td></tr>
<tr><td class="paramname">bytes</td><td>The byte array which was sent or received. </td></tr>
<tr><td class="paramname">length</td><td>The length of data which was sent or received. </td></tr>
<tr><td class="paramname">last_data</td><td>Boolean flag whether this is the final byte array for this request.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__globus__gass__transfer__data.html#gaf9fafa443774f59abd5a6584bdeee646">globus_gass_transfer_send_bytes()</a>, <a class="el" href="group__globus__gass__transfer__data.html#gacd7c5a82e0018c76dfce993035a5bf6a">globus_gass_transfer_receive_bytes()</a> </dd></dl>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gacd7c5a82e0018c76dfce993035a5bf6a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacd7c5a82e0018c76dfce993035a5bf6a">◆ </a></span>globus_gass_transfer_receive_bytes()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_transfer_receive_bytes </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> </td>
<td class="paramname"><em>request</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_byte_t * </td>
<td class="paramname"><em>bytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_size_t </td>
<td class="paramname"><em>max_length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_size_t </td>
<td class="paramname"><em>wait_for_length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__globus__gass__transfer__data.html#ga6ec33acb4a5a518b8c45db10daba7160">globus_gass_transfer_bytes_callback_t</a> </td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>user_arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Receive a byte array associated with a request handle.</p>
<p>This function receives a block of data from a server or client as part of the processing for a request. Multiple data blocks may be registered with the GASS transfer library at once.</p>
<p>When processing a server request, this function may only be used in conjunction with "put" or "append" requests. The user must call <a class="el" href="group__globus__gass__transfer__server.html#ga068c0c63ed4e2635d273c2f61c823c0b">globus_gass_transfer_authorize()</a> before calling this function.</p>
<p>When processing a client request, this function may only be used in conjunction with "get" requests. This function may not be called before either the callback function has been invoked, or the blocking globus_gass_tranfser_put() or <a class="el" href="group__globus__gass__transfer__client.html#ga5055caf41715f0d4a01a3f785fc61440">globus_gass_transfer_append()</a> function has returned.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">request</td><td>The request handle with which this block of bytes is associated. </td></tr>
<tr><td class="paramname">bytes</td><td>A user-supplied buffer containing the data associated with the request. </td></tr>
<tr><td class="paramname">max_length</td><td>The length of the <em>bytes</em> array. </td></tr>
<tr><td class="paramname">wait_for_length</td><td>The minimum amount of data to wait for before invoking the <em>callback</em> function. A partial byte array of at least this amount will be returned in the callback, unless end-of-file is reached before this amount. </td></tr>
<tr><td class="paramname">callback</td><td>Function to call once the <em>bytes</em> array has been received. </td></tr>
<tr><td class="paramname">user_arg</td><td>Argument to be passed to the <em>callback</em> function.</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 <em>bytes</em> array was successfully registered with the GASS transfer library. The <em>callback</em> function will be invoked once it has been received. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER</td><td>The <em>bytes</em> or <em>callback</em> parameter was NULL. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_INVALID_USER</td><td>The <em>request</em> was invalid, or it is not one on which bytes can be sent. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NOT_INITIALIZED</td><td>The callback to a non-blocking file request has not been invoked yet, a blocking file request has not returned, or the request has not yet been authorized. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_REQUEST_FAILED</td><td>The <em>request</em> has failed by either the client, server, or protocol module implementation. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_DONE</td><td>The <em>request</em> has already been completed. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaf9fafa443774f59abd5a6584bdeee646"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf9fafa443774f59abd5a6584bdeee646">◆ </a></span>globus_gass_transfer_send_bytes()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_transfer_send_bytes </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> </td>
<td class="paramname"><em>request</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_byte_t * </td>
<td class="paramname"><em>bytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_size_t </td>
<td class="paramname"><em>send_length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_bool_t </td>
<td class="paramname"><em>last_data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__globus__gass__transfer__data.html#ga6ec33acb4a5a518b8c45db10daba7160">globus_gass_transfer_bytes_callback_t</a> </td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>user_arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send a byte array associated with a request handle.</p>
<p>This function sends a block of data to a server or client as part of the processing for a request. Multiple data blocks may be registered with the GASS transfer library at once.</p>
<p>When processing a server request, this function may only be used in conjunction with "get" requests. The user must call <a class="el" href="group__globus__gass__transfer__server.html#ga068c0c63ed4e2635d273c2f61c823c0b">globus_gass_transfer_authorize()</a> before calling this function.</p>
<p>When processing a client request, this function may only be used in conjunction with "put" or "append" requests. This function may not be called before either the callback function has been invoked, or the blocking globus_gass_tranfser_put() or <a class="el" href="group__globus__gass__transfer__client.html#ga5055caf41715f0d4a01a3f785fc61440">globus_gass_transfer_append()</a> function has returned.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">request</td><td>The request handle with which this block of bytes is associated. </td></tr>
<tr><td class="paramname">bytes</td><td>A user-supplied buffer containing the data associated with the request. </td></tr>
<tr><td class="paramname">send_length</td><td>The length of the <em>bytes</em> array. </td></tr>
<tr><td class="paramname">last_data</td><td>A flag to indicate whether this is the final block of data for the request. If this is true, then the <em>callback</em> function will be delayed until the server acknowledges that the file has been completely received. </td></tr>
<tr><td class="paramname">callback</td><td>Function to call once the <em>bytes</em> array has been sent. </td></tr>
<tr><td class="paramname">user_arg</td><td>Argument to be passed to the <em>callback</em> function.</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 <em>bytes</em> array was successfully registered with the GASS transfer library. The <em>callback</em> function will be invoked once it has been sent. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER</td><td>The <em>bytes</em> or <em>callback</em> parameter was NULL. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_INVALID_USER</td><td>The <em>request</em> was invalid, or it is not one on which bytes can be sent. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NOT_INITIALIZED</td><td>The callback to a non-blocking file request has not been invoked yet, a blocking file request has not returned, or the request has not yet been authorized. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_REQUEST_FAILED</td><td>The <em>request</em> has failed by either the client, server, or protocol module implementation. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_DONE</td><td>The <em>request</em> has already been completed. </td></tr>
</table>
</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>
|