libglobus-gass-transfer-doc 7.1-1 / usr / share / doc / libglobus-gass-transfer-dev / html / group__globus__gass__transfer__client.html

This file is indexed.

/usr/share/doc/libglobus-gass-transfer-dev/html/group__globus__gass__transfer__client.html is in libglobus-gass-transfer-doc 7.1-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
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta name="robots" content="noindex">
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<!-- THIS FILE IS AUTOMATICALLY GENERATED FROM THE GLOBUS SOURCE CODE
     DO NOT MODIFY.
-->
<title>Globus Reference Manual</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<body>
<!-- Generated by Doxygen 1.7.6.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('group__globus__gass__transfer__client.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Client-Initiated Operations</div>  </div>
</div><!--header-->
<div class="contents">
<h2><a name="func-members"></a>
Functions</h2>
<ul>
<li>int <a class="el" href="group__globus__gass__transfer__client.html#ga22123aa34226df1b6b667c115524f007">globus_gass_transfer_register_get</a> (<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> *request, globus_gass_transfer_requestattr_t *attr, char *url, globus_gass_transfer_callback_t callback, void *user_arg)
<li>int <a class="el" href="group__globus__gass__transfer__client.html#gad318d8499a359b3d07763ab0e31d80f1">globus_gass_transfer_get</a> (<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> *request, globus_gass_transfer_requestattr_t *attr, char *url)
<li>int <a class="el" href="group__globus__gass__transfer__client.html#ga58637ef8607c6bd2e7e60ab39844d14f">globus_gass_transfer_register_put</a> (<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> *request, globus_gass_transfer_requestattr_t *attr, char *url, globus_size_t length, globus_gass_transfer_callback_t callback, void *user_arg)
<li>int <a class="el" href="group__globus__gass__transfer__client.html#gae31996ee610f99379a1b6ec1ce7dac23">globus_gass_transfer_put</a> (<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> *request, globus_gass_transfer_requestattr_t *attr, char *url, globus_size_t length)
<li>int <a class="el" href="group__globus__gass__transfer__client.html#gaa62e6ef29ef82640291874af8a010a19">globus_gass_transfer_register_append</a> (<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> *request, globus_gass_transfer_requestattr_t *attr, char *url, globus_size_t length, globus_gass_transfer_callback_t callback, void *user_arg)
<li>int <a class="el" href="group__globus__gass__transfer__client.html#ga5055caf41715f0d4a01a3f785fc61440">globus_gass_transfer_append</a> (<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> *request, globus_gass_transfer_requestattr_t *attr, char *url, globus_size_t length)
</ul>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>GASS Transfer Client Operations. </p>
<p>One mode of using the GASS Transfer API is to initiate file transfers. The operations supported by the GASS Transfer API are file get, put, and append. These operations are provided for HTTP, and HTTPS file servers. The <a class="el" href="group__globus__gass__transfer__protocol.html">protocol module interface</a> allows support for additional protocols to be added easily.</p>
<p>The GASS transfer library provides both blocking and non-blocking versions of all its client functions. When a blocking function completes, or the non-blocking function's callback is called, the user should check the request's status to discover whether the transfer was completed successfully, denied, or referred. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga22123aa34226df1b6b667c115524f007"></a><!-- doxytag: member="globus_gass_transfer_client.c::globus_gass_transfer_register_get" ref="ga22123aa34226df1b6b667c115524f007" args="(globus_gass_transfer_request_t *request, globus_gass_transfer_requestattr_t *attr, char *url, globus_gass_transfer_callback_t callback, void *user_arg)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="group__globus__gass__transfer__client.html#ga22123aa34226df1b6b667c115524f007">globus_gass_transfer_register_get</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> *&#160;</td>
          <td class="paramname"><em>request</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">globus_gass_transfer_requestattr_t *&#160;</td>
          <td class="paramname"><em>attr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>url</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">globus_gass_transfer_callback_t&#160;</td>
          <td class="paramname"><em>callback</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>user_arg</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Nonblocking file get. </p>
<p>This function initiates a new "get" request of the file named by <em>url</em>. The entire file will be transfered from the server if the file exists and user is authorized to do so. This function does not block; instead, the user's callback function will be called once the GASS library has determined whether the file can be retrieved or not.</p>
<p>Upon returning from this function, the request handle is initialized to refer to the <em>get</em> request's state.</p>
<p>If the server can't store the file at <em>url</em>, but has an alternative location for the user to store to, then the callback function will be called with the request's status set to <em>GLOBUS_GASS_TRANSFER_REQUEST_REFERRED</em>.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">request</td><td>A pointer to an uninitialized request handle. </td></tr>
    <tr><td class="paramname">attr</td><td>Request attributes. </td></tr>
    <tr><td class="paramname">url</td><td>URL to get </td></tr>
    <tr><td class="paramname">callback</td><td>Function to call once the URL has been accepted, referred, or denied by the server. </td></tr>
    <tr><td class="paramname">user_arg</td><td>User-supplied argument to the callback function.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt><b>Return values:</b></dt><dd>
  <table class="retval">
    <tr><td class="paramname">GLOBUS_SUCCESS</td><td>The get was successfully initiated. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER</td><td>One of request, attr, or callback was GLOBUS_NULL. The get could not be processed. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_INTERNAL_ERROR</td><td>An internal resource was not available to process the get. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NOT_IMPLEMENTED</td><td>No protocol handler for doing a get on this URL type is implemented. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_BAD_URL</td><td>The URL could not be parsed.</td></tr>
  </table>
  </dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__globus__gass__transfer__client.html#gad318d8499a359b3d07763ab0e31d80f1" title="Blocking file get.">globus_gass_transfer_get()</a> </dd></dl>

</div>
</div>
<a class="anchor" id="gad318d8499a359b3d07763ab0e31d80f1"></a><!-- doxytag: member="globus_gass_transfer_client.c::globus_gass_transfer_get" ref="gad318d8499a359b3d07763ab0e31d80f1" args="(globus_gass_transfer_request_t *request, globus_gass_transfer_requestattr_t *attr, char *url)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="group__globus__gass__transfer__client.html#gad318d8499a359b3d07763ab0e31d80f1">globus_gass_transfer_get</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> *&#160;</td>
          <td class="paramname"><em>request</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">globus_gass_transfer_requestattr_t *&#160;</td>
          <td class="paramname"><em>attr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>url</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Blocking file get. </p>
<p>This function initiates a new "get" request of the file named by <em>url</em>. The entire file will be transfered from the server if the file exists and user is authorized to do so. This function blocks until the GASS library has determined whether the file may be retrievied by the caller, may not because it is a referral to another URL or URLs, or the server has denied the request.</p>
<p>Upon returning from this function, the request handle is initialized to refer to the <em>get</em> request's state. This request handle must be destroyed after the user has finished processing the data associated with the callback.</p>
<p>If the file doesn't exist at <em>url</em>, but a referral does, then this function will return with the request's status set to <em>GLOBUS_GASS_TRANSFER_REQUEST_REFERRED</em>.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">request</td><td>A pointer to an uninitialized request handle. </td></tr>
    <tr><td class="paramname">attr</td><td>Request attributes. </td></tr>
    <tr><td class="paramname">url</td><td>URL to get</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt><b>Return values:</b></dt><dd>
  <table class="retval">
    <tr><td class="paramname">GLOBUS_SUCCESS</td><td>The get was successfully initiated. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER</td><td>One of request or attr was GLOBUS_NULL. The get could not be processed. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_INTERNAL_ERROR</td><td>An internal resource was not available to process the get. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NOT_IMPLEMENTED</td><td>No protocol handler for doing a get on this URL type is implemented. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_BAD_URL</td><td>The URL could not be parsed.</td></tr>
  </table>
  </dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__globus__gass__transfer__client.html#ga22123aa34226df1b6b667c115524f007" title="Nonblocking file get.">globus_gass_transfer_register_get()</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga58637ef8607c6bd2e7e60ab39844d14f"></a><!-- doxytag: member="globus_gass_transfer_client.c::globus_gass_transfer_register_put" ref="ga58637ef8607c6bd2e7e60ab39844d14f" args="(globus_gass_transfer_request_t *request, globus_gass_transfer_requestattr_t *attr, char *url, globus_size_t length, globus_gass_transfer_callback_t callback, void *user_arg)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="group__globus__gass__transfer__client.html#ga58637ef8607c6bd2e7e60ab39844d14f">globus_gass_transfer_register_put</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> *&#160;</td>
          <td class="paramname"><em>request</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">globus_gass_transfer_requestattr_t *&#160;</td>
          <td class="paramname"><em>attr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>url</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">globus_size_t&#160;</td>
          <td class="paramname"><em>length</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">globus_gass_transfer_callback_t&#160;</td>
          <td class="paramname"><em>callback</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>user_arg</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Nonblocking file put. </p>
<p>This function initiates a new "put" request of the file named by <em>url</em>. The entire file will be transfered to the server if the user is authorized to do so. This function does not block; instead, the user's callback function will be called once the GASS library has determined whether the file may be stored or not.</p>
<p>Upon returning from this function, the request handle is initialized to refer to the <em>put</em> request's state.</p>
<p>If the server can't store the file at <em>url</em>, but has an alternative location for the user to store to, then the callback function will be called with the request's status set to <em>GLOBUS_GASS_TRANSFER_REQUEST_REFERRED</em>.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">request</td><td>A pointer to an uninitialized request handle. </td></tr>
    <tr><td class="paramname">attr</td><td>Request attributes. </td></tr>
    <tr><td class="paramname">url</td><td>URL to put. </td></tr>
    <tr><td class="paramname">length</td><td>The length of the data to put to the url, if known. If this parameter is set to <em>GLOBUS_GASS_LENGTH_UNKNOWN</em>, then the put may fail if the protocol does not support arbitrarily-length files. </td></tr>
    <tr><td class="paramname">callback</td><td>Function to call once the URL has been accepted, referred, or denied by the server. </td></tr>
    <tr><td class="paramname">user_arg</td><td>User-supplied argument to the callback function.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt><b>Return values:</b></dt><dd>
  <table class="retval">
    <tr><td class="paramname">GLOBUS_SUCCESS</td><td>The put was successfully initiated. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER</td><td>One of request, attr, or callback was GLOBUS_NULL. The put could not be processed. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_INTERNAL_ERROR</td><td>An internal resource was not available to process the put. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NOT_IMPLEMENTED</td><td>No protocol handler for doing a put on this URL type is implemented. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_BAD_URL</td><td>The URL could not be parsed.</td></tr>
  </table>
  </dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__globus__gass__transfer__client.html#gae31996ee610f99379a1b6ec1ce7dac23" title="Blocking file put.">globus_gass_transfer_put()</a> </dd></dl>

</div>
</div>
<a class="anchor" id="gae31996ee610f99379a1b6ec1ce7dac23"></a><!-- doxytag: member="globus_gass_transfer_client.c::globus_gass_transfer_put" ref="gae31996ee610f99379a1b6ec1ce7dac23" args="(globus_gass_transfer_request_t *request, globus_gass_transfer_requestattr_t *attr, char *url, globus_size_t length)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="group__globus__gass__transfer__client.html#gae31996ee610f99379a1b6ec1ce7dac23">globus_gass_transfer_put</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> *&#160;</td>
          <td class="paramname"><em>request</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">globus_gass_transfer_requestattr_t *&#160;</td>
          <td class="paramname"><em>attr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>url</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">globus_size_t&#160;</td>
          <td class="paramname"><em>length</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Blocking file put. </p>
<p>This function initiates a new "put" request of the file named by <em>url</em>. The entire file will be transfered to the server if the user is authorized to do so. This function blocks until the GASS library has determined whether the file may be retrieved by the caller, may not because it is a referral to another URL or URLs, or the server has denied the request.</p>
<p>Upon returning from this function, the request handle is initialized to refer to the <em>put</em> request's state.</p>
<p>If the server can't store the file at <em>url</em>, but has an alternative location for the user to store to, then this function return with request's status set to <em>GLOBUS_GASS_TRANSFER_REQUEST_REFERRED</em>.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">request</td><td>A pointer to an uninitialized request handle. </td></tr>
    <tr><td class="paramname">attr</td><td>Request attributes. </td></tr>
    <tr><td class="paramname">url</td><td>URL to put. </td></tr>
    <tr><td class="paramname">length</td><td>The length of the data to put to the url, if known. If this parameter is set to <em>GLOBUS_GASS_LENGTH_UNKNOWN</em>, then the put may fail if the protocol does not support arbitrarily-length files.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt><b>Return values:</b></dt><dd>
  <table class="retval">
    <tr><td class="paramname">GLOBUS_SUCCESS</td><td>The get was successfully initiated. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER</td><td>One of request or attr was GLOBUS_NULL. The get could not be processed. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_INTERNAL_ERROR</td><td>An internal resource was not available to process the get. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NOT_IMPLEMENTED</td><td>No protocol handler for doing a put on this URL type is implemented. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_BAD_URL</td><td>The URL could not be parsed.</td></tr>
  </table>
  </dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__globus__gass__transfer__client.html#ga58637ef8607c6bd2e7e60ab39844d14f" title="Nonblocking file put.">globus_gass_transfer_register_put()</a> </dd></dl>

</div>
</div>
<a class="anchor" id="gaa62e6ef29ef82640291874af8a010a19"></a><!-- doxytag: member="globus_gass_transfer_client.c::globus_gass_transfer_register_append" ref="gaa62e6ef29ef82640291874af8a010a19" args="(globus_gass_transfer_request_t *request, globus_gass_transfer_requestattr_t *attr, char *url, globus_size_t length, globus_gass_transfer_callback_t callback, void *user_arg)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="group__globus__gass__transfer__client.html#gaa62e6ef29ef82640291874af8a010a19">globus_gass_transfer_register_append</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> *&#160;</td>
          <td class="paramname"><em>request</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">globus_gass_transfer_requestattr_t *&#160;</td>
          <td class="paramname"><em>attr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>url</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">globus_size_t&#160;</td>
          <td class="paramname"><em>length</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">globus_gass_transfer_callback_t&#160;</td>
          <td class="paramname"><em>callback</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>user_arg</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Nonblocking file append. </p>
<p>This function initiates a new "append" request of the file named by <em>url</em>. The entire file will be transfered to the server if the user is authorized to do so. This function does not block; instead, the user's callback function will be called once the GASS library has determined whether the file may be stored or not.</p>
<p>Upon returning from this function, the request handle is initialized to refer to the <em>append</em> request's state.</p>
<p>If the server can't store the file at <em>url</em>, but has an alternative location for the user to store to, then the callback function will be called with the request's status set to <em>GLOBUS_GASS_TRANSFER_REQUEST_REFERRED</em>.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">request</td><td>A pointer to an uninitialized request handle. </td></tr>
    <tr><td class="paramname">attr</td><td>Request attributes. </td></tr>
    <tr><td class="paramname">url</td><td>URL to append to. </td></tr>
    <tr><td class="paramname">length</td><td>The length of the data to append to the url, if known. If this parameter is set to <em>GLOBUS_GASS_LENGTH_UNKNOWN</em>, then the append may fail if the protocol does not support arbitrarily-length files. </td></tr>
    <tr><td class="paramname">callback</td><td>Function to call once the URL has been accepted, referred, or denied by the server. </td></tr>
    <tr><td class="paramname">user_arg</td><td>User-supplied argument to the callback function.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt><b>Return values:</b></dt><dd>
  <table class="retval">
    <tr><td class="paramname">GLOBUS_SUCCESS</td><td>The put was successfully initiated. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER</td><td>One of request, attr, or callback was GLOBUS_NULL. The put could not be processed. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_INTERNAL_ERROR</td><td>An internal resource was not available to process the put. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NOT_IMPLEMENTED</td><td>No protocol handler for doing a append on this URL type is implemented. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_BAD_URL</td><td>The URL could not be parsed.</td></tr>
  </table>
  </dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__globus__gass__transfer__client.html#ga5055caf41715f0d4a01a3f785fc61440" title="Blocking file append.">globus_gass_transfer_append()</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga5055caf41715f0d4a01a3f785fc61440"></a><!-- doxytag: member="globus_gass_transfer_client.c::globus_gass_transfer_append" ref="ga5055caf41715f0d4a01a3f785fc61440" args="(globus_gass_transfer_request_t *request, globus_gass_transfer_requestattr_t *attr, char *url, globus_size_t length)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="group__globus__gass__transfer__client.html#ga5055caf41715f0d4a01a3f785fc61440">globus_gass_transfer_append</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> *&#160;</td>
          <td class="paramname"><em>request</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">globus_gass_transfer_requestattr_t *&#160;</td>
          <td class="paramname"><em>attr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>url</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">globus_size_t&#160;</td>
          <td class="paramname"><em>length</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Blocking file append. </p>
<p>This function initiates a new "append" request of the file named by <em>url</em>. The entire file will be transfered to the server if the user is authorized to do so. This function blocks until the GASS library has determined whether the file may be retrieved by the caller, may not because it is a referral to another URL or URLs, or the server has denied the request.</p>
<p>Upon returning from this function, the request handle is initialized to refer to the <em>append</em> request's state.</p>
<p>If the server can't store the file at <em>url</em>, but has an alternative location for the user to store to, then this function return with request's status set to <em>GLOBUS_GASS_TRANSFER_REQUEST_REFERRED</em>.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">request</td><td>A pointer to an uninitialized request handle. </td></tr>
    <tr><td class="paramname">attr</td><td>Request attributes. </td></tr>
    <tr><td class="paramname">url</td><td>URL to append to. </td></tr>
    <tr><td class="paramname">length</td><td>The length of the data to append to the url, if known. If this parameter is set to <em>GLOBUS_GASS_LENGTH_UNKNOWN</em>, then the append may fail if the protocol does not support arbitrarily-length files.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt><b>Return values:</b></dt><dd>
  <table class="retval">
    <tr><td class="paramname">GLOBUS_SUCCESS</td><td>The put was successfully initiated. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER</td><td>One of request, attr, or callback was GLOBUS_NULL. The put could not be processed. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_INTERNAL_ERROR</td><td>An internal resource was not available to process the put. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NOT_IMPLEMENTED</td><td>No protocol handler for doing a append on this URL type is implemented. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_BAD_URL</td><td>The URL could not be parsed.</td></tr>
  </table>
  </dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__globus__gass__transfer__client.html#gaa62e6ef29ef82640291874af8a010a19" title="Nonblocking file append.">globus_gass_transfer_register_append()</a> </dd></dl>

</div>
</div>
</div><!-- contents -->
</div>
  <div id="nav-path" class="navpath">
    <ul>
<hr>
<p align="center">
<a href="http://www.globus.org/toolkit/about.html" target="_top">about globus</a> |
<a href="http://www.globus.org/toolkit/" target="_top">globus toolkit</a> |
<a href="https://dev.globus.org/wiki/Welcome/" target="_top">dev.globus</a>
<br>
<br>
Comments? <a href="mailto:webmaster@globus.org">webmaster@globus.org</a>

</body>
</html>

APT Browse - Built by Thomas Orozco.