This file is indexed.

/usr/share/doc/libglobus-gass-transfer-dev/html/group__globus__gass__transfer__request.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
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
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
<!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: Request Handles</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
   &#160;<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="#nested-classes">Data Structures</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Request Handles<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>Request Handles.  
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Request Handles:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group__globus__gass__transfer__request.png" border="0" alt="" usemap="#group____globus____gass____transfer____request"/>
<map name="group____globus____gass____transfer____request" id="group____globus____gass____transfer____request">
<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="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request handle.  <a href="structglobus__gass__transfer__request__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga5602a52b98af47f77e032fcdd913957f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__request.html#ga5602a52b98af47f77e032fcdd913957f">globus_gass_transfer_request_type_t</a> { <a class="el" href="group__globus__gass__transfer__request.html#gga5602a52b98af47f77e032fcdd913957fa419bb60ecf5c1b77f568cbf75aae4849">GLOBUS_GASS_TRANSFER_REQUEST_TYPE_INVALID</a>, 
<a class="el" href="group__globus__gass__transfer__request.html#gga5602a52b98af47f77e032fcdd913957fa83bbfcfb85a560accca8f9745dd9e278">GLOBUS_GASS_TRANSFER_REQUEST_TYPE_GET</a>, 
<a class="el" href="group__globus__gass__transfer__request.html#gga5602a52b98af47f77e032fcdd913957fac5675a8c4b950712e27dcec83192e628">GLOBUS_GASS_TRANSFER_REQUEST_TYPE_PUT</a>, 
<a class="el" href="group__globus__gass__transfer__request.html#gga5602a52b98af47f77e032fcdd913957fa97544dc3720e5c09efd1517b12a396ce">GLOBUS_GASS_TRANSFER_REQUEST_TYPE_APPEND</a>
 }</td></tr>
<tr class="separator:ga5602a52b98af47f77e032fcdd913957f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaa671d5ef2fae5a7034e0624c3bbc1b5"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__request.html#gaaa671d5ef2fae5a7034e0624c3bbc1b5">globus_gass_transfer_request_status_t</a> { <br />
&#160;&#160;<a class="el" href="group__globus__gass__transfer__request.html#ggaaa671d5ef2fae5a7034e0624c3bbc1b5ade06f705dc33c762108a6f9b8340878a">GLOBUS_GASS_TRANSFER_REQUEST_INVALID</a>, 
<a class="el" href="group__globus__gass__transfer__request.html#ggaaa671d5ef2fae5a7034e0624c3bbc1b5a3036a3bafba31ef8a63a2d63b34bcd1b">GLOBUS_GASS_TRANSFER_REQUEST_STARTING</a>, 
<a class="el" href="group__globus__gass__transfer__request.html#ggaaa671d5ef2fae5a7034e0624c3bbc1b5af4da259b0651a2fd9dea08179c083da4">GLOBUS_GASS_TRANSFER_REQUEST_PENDING</a>, 
<a class="el" href="group__globus__gass__transfer__request.html#ggaaa671d5ef2fae5a7034e0624c3bbc1b5a36f2ab83f649fdda5ce2d7a52f0c8bf5">GLOBUS_GASS_TRANSFER_REQUEST_FAILED</a>, 
<br />
&#160;&#160;<a class="el" href="group__globus__gass__transfer__request.html#ggaaa671d5ef2fae5a7034e0624c3bbc1b5a7c3742c6941000d4c5a60662ff9c02b2">GLOBUS_GASS_TRANSFER_REQUEST_REFERRED</a>, 
<a class="el" href="group__globus__gass__transfer__request.html#ggaaa671d5ef2fae5a7034e0624c3bbc1b5a8051bd31d3f57ca3ef4d385bd6b9b9f3">GLOBUS_GASS_TRANSFER_REQUEST_DENIED</a>, 
<a class="el" href="group__globus__gass__transfer__request.html#ggaaa671d5ef2fae5a7034e0624c3bbc1b5af2d7d1108388b66e5e8b9af0fb89ab6c">GLOBUS_GASS_TRANSFER_REQUEST_DONE</a>
<br />
 }</td></tr>
<tr class="separator:gaaa671d5ef2fae5a7034e0624c3bbc1b5"><td class="memSeparator" colspan="2">&#160;</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:gad31d82c6169b5d8e8edb88b4ac56c7bb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__globus__gass__transfer__request.html#ga5602a52b98af47f77e032fcdd913957f">globus_gass_transfer_request_type_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__request.html#gad31d82c6169b5d8e8edb88b4ac56c7bb">globus_gass_transfer_request_get_type</a> (<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request)</td></tr>
<tr class="separator:gad31d82c6169b5d8e8edb88b4ac56c7bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad757b053500c6a3b8bd641dbf8f46430"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__request.html#gad757b053500c6a3b8bd641dbf8f46430">globus_gass_transfer_request_get_user_pointer</a> (<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request)</td></tr>
<tr class="separator:gad757b053500c6a3b8bd641dbf8f46430"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9b43a82b60dc9dd6aed0fc14f5eae1ff"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__request.html#ga9b43a82b60dc9dd6aed0fc14f5eae1ff">globus_gass_transfer_request_set_user_pointer</a> (<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request, void *user_pointer)</td></tr>
<tr class="separator:ga9b43a82b60dc9dd6aed0fc14f5eae1ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7392dbde70c0c18201871095dfb7b143"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__globus__gass__transfer__request.html#gaaa671d5ef2fae5a7034e0624c3bbc1b5">globus_gass_transfer_request_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__request.html#ga7392dbde70c0c18201871095dfb7b143">globus_gass_transfer_request_get_status</a> (<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request)</td></tr>
<tr class="separator:ga7392dbde70c0c18201871095dfb7b143"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaadb0e60f7ca80cdf416efeca8e38c0e0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__request.html#gaadb0e60f7ca80cdf416efeca8e38c0e0">globus_gass_transfer_request_get_referral</a> (<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request, globus_gass_transfer_referral_t *referral)</td></tr>
<tr class="separator:gaadb0e60f7ca80cdf416efeca8e38c0e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacc7dae1d1e5febbe00314c00da7babe3"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__request.html#gacc7dae1d1e5febbe00314c00da7babe3">globus_gass_transfer_request_get_url</a> (<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request)</td></tr>
<tr class="separator:gacc7dae1d1e5febbe00314c00da7babe3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga96d739c6b11cc3a091ab11c8b41322b1"><td class="memItemLeft" align="right" valign="top">globus_size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__request.html#ga96d739c6b11cc3a091ab11c8b41322b1">globus_gass_transfer_request_get_length</a> (<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request)</td></tr>
<tr class="separator:ga96d739c6b11cc3a091ab11c8b41322b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga966e907ec04e84836f545570eff004d3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__request.html#ga966e907ec04e84836f545570eff004d3">globus_gass_transfer_request_set_type</a> (<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request, <a class="el" href="group__globus__gass__transfer__request.html#ga5602a52b98af47f77e032fcdd913957f">globus_gass_transfer_request_type_t</a> type)</td></tr>
<tr class="separator:ga966e907ec04e84836f545570eff004d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab1f9279d919f88e652a4e8729cc7ca47"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__request.html#gab1f9279d919f88e652a4e8729cc7ca47">globus_gass_transfer_request_set_url</a> (<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request, char *url)</td></tr>
<tr class="separator:gab1f9279d919f88e652a4e8729cc7ca47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga771a876dd39d4399f8e68b41aa50346a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__request.html#ga771a876dd39d4399f8e68b41aa50346a">globus_gass_transfer_request_set_length</a> (<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request, globus_size_t length)</td></tr>
<tr class="separator:ga771a876dd39d4399f8e68b41aa50346a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaa938edb5e75f9fef3db92dfbb1a71f1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__request.html#gaaa938edb5e75f9fef3db92dfbb1a71f1">globus_gass_transfer_request_get_denial_reason</a> (<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request)</td></tr>
<tr class="separator:gaaa938edb5e75f9fef3db92dfbb1a71f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga55d67452e1fac012178ce566f9b3f312"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__request.html#ga55d67452e1fac012178ce566f9b3f312">globus_gass_transfer_request_get_denial_message</a> (<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request)</td></tr>
<tr class="separator:ga55d67452e1fac012178ce566f9b3f312"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf690e56b7e4cdcad4dc7a6aafb120385"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__request.html#gaf690e56b7e4cdcad4dc7a6aafb120385">globus_gass_transfer_request_get_subject</a> (<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request)</td></tr>
<tr class="separator:gaf690e56b7e4cdcad4dc7a6aafb120385"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga375fb762623cf1c34caaaeb3b01f15e7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__request.html#ga375fb762623cf1c34caaaeb3b01f15e7">globus_gass_transfer_request_destroy</a> (<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request)</td></tr>
<tr class="separator:ga375fb762623cf1c34caaaeb3b01f15e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Request Handles. </p>
<p>Request handles are used by the GASS Transfer API to associate operations with a single file transfer request. Specifically, they are used to register multiple byte range buffers with a file transfer request, and to query the state of a transfer in-progress.</p>
<p>To implement a server, the request handle is populated by the protocol module implementation. The server may use the functions in this section to determine information about what the client is requesting.</p>
<p>To implement a client, the request handle should be queried after the blocking call or initial callback has been invoked to determine if the request has been authorized or referred, and after EOF, to determine whether the request has completed successfully.</p>
<p>A request handle contains a pointer which may be used by the handler of the request to store a pointer to arbitrary application-specific data. </p>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="gaaa671d5ef2fae5a7034e0624c3bbc1b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaaa671d5ef2fae5a7034e0624c3bbc1b5">&#9670;&nbsp;</a></span>globus_gass_transfer_request_status_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__globus__gass__transfer__request.html#gaaa671d5ef2fae5a7034e0624c3bbc1b5">globus_gass_transfer_request_status_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Request Status </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggaaa671d5ef2fae5a7034e0624c3bbc1b5ade06f705dc33c762108a6f9b8340878a"></a>GLOBUS_GASS_TRANSFER_REQUEST_INVALID&#160;</td><td class="fielddoc"><p>Handle is no longer valid </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaaa671d5ef2fae5a7034e0624c3bbc1b5a3036a3bafba31ef8a63a2d63b34bcd1b"></a>GLOBUS_GASS_TRANSFER_REQUEST_STARTING&#160;</td><td class="fielddoc"><p>Initial connection and authorization is not yet completed </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaaa671d5ef2fae5a7034e0624c3bbc1b5af4da259b0651a2fd9dea08179c083da4"></a>GLOBUS_GASS_TRANSFER_REQUEST_PENDING&#160;</td><td class="fielddoc"><p>Request is authorized. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaaa671d5ef2fae5a7034e0624c3bbc1b5a36f2ab83f649fdda5ce2d7a52f0c8bf5"></a>GLOBUS_GASS_TRANSFER_REQUEST_FAILED&#160;</td><td class="fielddoc"><p>Request failed due to protocol error or client or server aborting the request </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaaa671d5ef2fae5a7034e0624c3bbc1b5a7c3742c6941000d4c5a60662ff9c02b2"></a>GLOBUS_GASS_TRANSFER_REQUEST_REFERRED&#160;</td><td class="fielddoc"><p>Request can not be processed by this server, referred to another URL or URLs </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaaa671d5ef2fae5a7034e0624c3bbc1b5a8051bd31d3f57ca3ef4d385bd6b9b9f3"></a>GLOBUS_GASS_TRANSFER_REQUEST_DENIED&#160;</td><td class="fielddoc"><p>The server denied this request </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaaa671d5ef2fae5a7034e0624c3bbc1b5af2d7d1108388b66e5e8b9af0fb89ab6c"></a>GLOBUS_GASS_TRANSFER_REQUEST_DONE&#160;</td><td class="fielddoc"><p>All callbacks have completed </p>
</td></tr>
</table>

</div>
</div>
<a id="ga5602a52b98af47f77e032fcdd913957f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5602a52b98af47f77e032fcdd913957f">&#9670;&nbsp;</a></span>globus_gass_transfer_request_type_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__globus__gass__transfer__request.html#ga5602a52b98af47f77e032fcdd913957f">globus_gass_transfer_request_type_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Type of operation associated with a request handle. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga5602a52b98af47f77e032fcdd913957fa419bb60ecf5c1b77f568cbf75aae4849"></a>GLOBUS_GASS_TRANSFER_REQUEST_TYPE_INVALID&#160;</td><td class="fielddoc"><p>Handle no longer valid </p>
</td></tr>
<tr><td class="fieldname"><a id="gga5602a52b98af47f77e032fcdd913957fa83bbfcfb85a560accca8f9745dd9e278"></a>GLOBUS_GASS_TRANSFER_REQUEST_TYPE_GET&#160;</td><td class="fielddoc"><p>A get request </p>
</td></tr>
<tr><td class="fieldname"><a id="gga5602a52b98af47f77e032fcdd913957fac5675a8c4b950712e27dcec83192e628"></a>GLOBUS_GASS_TRANSFER_REQUEST_TYPE_PUT&#160;</td><td class="fielddoc"><p>A put request </p>
</td></tr>
<tr><td class="fieldname"><a id="gga5602a52b98af47f77e032fcdd913957fa97544dc3720e5c09efd1517b12a396ce"></a>GLOBUS_GASS_TRANSFER_REQUEST_TYPE_APPEND&#160;</td><td class="fielddoc"><p>An append request </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga375fb762623cf1c34caaaeb3b01f15e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga375fb762623cf1c34caaaeb3b01f15e7">&#9670;&nbsp;</a></span>globus_gass_transfer_request_destroy()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int globus_gass_transfer_request_destroy </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><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Destroy a request handle.</p>
<p>This function destroys the caller's reference to a request handle. It must be called for all request handles which are created by calling functions in the "@ref globus_gass_transfer_client" or "@ref globus_gass_transfer_server" sections of this manual. After calling the function, the caller must not attempt to use the request handle for any purpose.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">request</td><td>The request 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 request handle reference was successfully destroyed. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_INVALID_USE</td><td>Either an invalid request handle or one which is actively being used was passed to this function as the <em>request</em> parameter. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga55d67452e1fac012178ce566f9b3f312"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga55d67452e1fac012178ce566f9b3f312">&#9670;&nbsp;</a></span>globus_gass_transfer_request_get_denial_message()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* globus_gass_transfer_request_get_denial_message </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><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get an string describing why a request was denied.</p>
<p>This function queries a request which was denied by a server to determine why it was denied. The denial reason will be expressed as a response string. The string must be freed by the caller.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">request</td><td>A handle to the request to query.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A string indicating why the request was denied. If the request handle is invalid or the request was not denied, then this function returns GLOBUS_NULL. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__globus__gass__transfer__request.html#gaaa938edb5e75f9fef3db92dfbb1a71f1">globus_gass_transfer_request_get_denial_reason()</a> </dd></dl>

</div>
</div>
<a id="gaaa938edb5e75f9fef3db92dfbb1a71f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaaa938edb5e75f9fef3db92dfbb1a71f1">&#9670;&nbsp;</a></span>globus_gass_transfer_request_get_denial_reason()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int globus_gass_transfer_request_get_denial_reason </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><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get an integer code describing why the request was denied.</p>
<p>This function queries a request which was denied by a server to determine why it was denied. The denial reason will be expressed in a protocol-specific response code. Knowledge of the protocol is needed to understand this response.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">request</td><td>A handle to the request to query.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A protocol-specific integer indicating why the request was denied. If the request handle is invalid or the request was not denied, then this function returns 0. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__globus__gass__transfer__request.html#ga55d67452e1fac012178ce566f9b3f312">globus_gass_transfer_request_get_denial_message()</a> </dd></dl>

</div>
</div>
<a id="ga96d739c6b11cc3a091ab11c8b41322b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga96d739c6b11cc3a091ab11c8b41322b1">&#9670;&nbsp;</a></span>globus_gass_transfer_request_get_length()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">globus_size_t globus_gass_transfer_request_get_length </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><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the length of a file to be transferred using GASS.</p>
<p>This function queries the request handle to determine the amount of data that will be transferred to copy the URL. The length may be <em>GLOBUS_GASS_TRANSFER_LENGTH_UNKNOWN</em> if the sender can not determine the length before making or authorizing the request.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">request</td><td>The request to query.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The length of the file located at the request's URL, or <em>GLOBUS_GASS_TRANSFER_LENGTH_UNKNOWN</em> if that cannot be determined. </dd></dl>

</div>
</div>
<a id="gaadb0e60f7ca80cdf416efeca8e38c0e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaadb0e60f7ca80cdf416efeca8e38c0e0">&#9670;&nbsp;</a></span>globus_gass_transfer_request_get_referral()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int globus_gass_transfer_request_get_referral </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_referral_t *&#160;</td>
          <td class="paramname"><em>referral</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Extract referral information from a request handle.</p>
<p>This function queries the request handle to determine any referral information that it contains. This function should only be called on request handles in the GLOBUS_GASS_TRANSFER_REQUEST_REFERRED state. If no referral information is stored in the request handle, then the referral will be initialized to an empty referral. The referral must be destroyed by calling <a class="el" href="group__globus__gass__transfer__referral.html#gae83589cda7d1515d778db2c3a8f8969e">globus_gass_transfer_referral_destroy()</a> by the caller.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">request</td><td>The request handle to query. </td></tr>
    <tr><td class="paramname">referral</td><td>A pointer to an uninitialized referral structure. It will be populated by calling this 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 referral was successfully extracted from the request handle. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER</td><td>The referral pointer was GLOBUS_NULL; </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga7392dbde70c0c18201871095dfb7b143"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7392dbde70c0c18201871095dfb7b143">&#9670;&nbsp;</a></span>globus_gass_transfer_request_get_status()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__globus__gass__transfer__request.html#gaaa671d5ef2fae5a7034e0624c3bbc1b5">globus_gass_transfer_request_status_t</a> globus_gass_transfer_request_get_status </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><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Check the status of a request.</p>
<p>This function queries a request to determine the status of the request. This function should be called after EOF has been reached, or after the initial get, put, or append has returned or had it's callback function called to determine if it is possible to procede, or whether the file transfer was successfully processed.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">request</td><td>The request handle to query.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="group__globus__gass__transfer__request.html#gaaa671d5ef2fae5a7034e0624c3bbc1b5">globus_gass_transfer_request_status_t</a> indicating the current status of the request. </dd></dl>

</div>
</div>
<a id="gaf690e56b7e4cdcad4dc7a6aafb120385"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf690e56b7e4cdcad4dc7a6aafb120385">&#9670;&nbsp;</a></span>globus_gass_transfer_request_get_subject()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* globus_gass_transfer_request_get_subject </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><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the subject string associated with a request.</p>
<p>This function queries a request handle to determine the subject identity of the client who initiated the request. The string must not be freed by the caller.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">request</td><td>A handle to the request to query.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A string containing the request initiator's subject identity. If the request handle is invalid or a credential was not used to initiate the request, this value will be GLOBUS_NULL. </dd></dl>

</div>
</div>
<a id="gad31d82c6169b5d8e8edb88b4ac56c7bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad31d82c6169b5d8e8edb88b4ac56c7bb">&#9670;&nbsp;</a></span>globus_gass_transfer_request_get_type()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__globus__gass__transfer__request.html#ga5602a52b98af47f77e032fcdd913957f">globus_gass_transfer_request_type_t</a> globus_gass_transfer_request_get_type </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><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Determine the type of a request.</p>
<p>This function is used by GASS server implementations to discover what type of operation the client is requesting for an URL.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">request</td><td>The request to query.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="group__globus__gass__transfer__request.html#ga5602a52b98af47f77e032fcdd913957f">type</a> of the request. </dd></dl>

</div>
</div>
<a id="gacc7dae1d1e5febbe00314c00da7babe3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacc7dae1d1e5febbe00314c00da7babe3">&#9670;&nbsp;</a></span>globus_gass_transfer_request_get_url()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* globus_gass_transfer_request_get_url </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><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the URL from a request handle.</p>
<p>This function queries the request handle to determine the URL associated with the request. This function is intended to be useful to GASS server implementors.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">request</td><td>The request handle to query.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the URL, or GLOBUS_NULL if the request handle is invalid. The string which is returned must not be freed by the caller. It may not be accessed after the request has been destroyed. </dd></dl>

</div>
</div>
<a id="gad757b053500c6a3b8bd641dbf8f46430"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad757b053500c6a3b8bd641dbf8f46430">&#9670;&nbsp;</a></span>globus_gass_transfer_request_get_user_pointer()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* globus_gass_transfer_request_get_user_pointer </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><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the user pointer associated with a request</p>
<p>This function extracts the user pointer from a request handle. The user-pointer may be used by the application which is generating or servicing the request to store a pointer to any application-specific piece of data.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">request</td><td>The request to query.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The user pointer's value. </dd></dl>

</div>
</div>
<a id="ga771a876dd39d4399f8e68b41aa50346a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga771a876dd39d4399f8e68b41aa50346a">&#9670;&nbsp;</a></span>globus_gass_transfer_request_set_length()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void globus_gass_transfer_request_set_length </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_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>Set the length of a transfer associated request handle.</p>
<p>This function modifies the given request handle so that it's length field is set to give length parameter.</p>
<p>This function must only be called by protocol modules when constructing a request handle when receiving the response to a get request. This function can only be called once per request handle.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">request</td><td>A handle to the request to modify. </td></tr>
    <tr><td class="paramname">length</td><td>The length of the file request.</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 URL was set for the request handle. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_INVALID_USE</td><td>The request handle was invalid, or the URL had already been set. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga966e907ec04e84836f545570eff004d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga966e907ec04e84836f545570eff004d3">&#9670;&nbsp;</a></span>globus_gass_transfer_request_set_type()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int globus_gass_transfer_request_set_type </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"><a class="el" href="group__globus__gass__transfer__request.html#ga5602a52b98af47f77e032fcdd913957f">globus_gass_transfer_request_type_t</a>&#160;</td>
          <td class="paramname"><em>type</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set the type of a request.</p>
<p>This function modifies a request handle by setting the type of operation that it is being used for. This function may only be called once per handle, and only from a GASS protocol module implementation.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">request</td><td>The request handle to modify. </td></tr>
    <tr><td class="paramname">type</td><td>The type of operation that this request handle will be used for.</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 request handle's type has been set. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_INVALID_USE</td><td>The request handle was invalid or it's type was already set. The request handle was not modified.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Only GASS Protocol modules may call this function. </dd></dl>

</div>
</div>
<a id="gab1f9279d919f88e652a4e8729cc7ca47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab1f9279d919f88e652a4e8729cc7ca47">&#9670;&nbsp;</a></span>globus_gass_transfer_request_set_url()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int globus_gass_transfer_request_set_url </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">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>Set the URL to which a request handle refers.</p>
<p>This function modifies the given request handle so that it's URL field is set to string pointed to by <em>url</em>.</p>
<p>No copy is made of the string, so the caller must not free it. It must be allocated by calling one of the memory allocators in globus_libc, as it will be freed when the request handle is destroyed.</p>
<p>This function must only be called by protocol modules when constructing a request handle when accepting a new request. This function can only be called once per request handle.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">request</td><td>A handle to the request to modify. </td></tr>
    <tr><td class="paramname">url</td><td>A string containing the URL that this request will be associated with.</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 URL was set for the request handle. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_INVALID_USE</td><td>The request handle was invalid, or the URL had already been set. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga9b43a82b60dc9dd6aed0fc14f5eae1ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9b43a82b60dc9dd6aed0fc14f5eae1ff">&#9670;&nbsp;</a></span>globus_gass_transfer_request_set_user_pointer()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int globus_gass_transfer_request_set_user_pointer </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">void *&#160;</td>
          <td class="paramname"><em>user_pointer</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set the user pointer associated with a request handle.</p>
<p>This function sets the user pointer from a request handle. The user-pointer may be used by the application which is generating or servicing the request to store a pointer to any application-specific piece of data.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">request</td><td>The request to modify. </td></tr>
    <tr><td class="paramname">user_pointer</td><td>The new value of the user pointer for the request.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">GLOBUS_SUCCES</td><td>The user pointer's value was set. </td></tr>
    <tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_INVALID_USE</td><td>An invalid request handle was passed to this function </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>