<!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.6"/>
<title>globus_gass_transfer: Protocol Modules</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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">globus_gass_transfer
 <span id="projectnumber">8.8</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></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> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Protocol Modules<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>Protocol Implementation API.
<a href="#details">More...</a></p>
<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  </td><td class="memItemRight" valign="bottom"><a class="el" href="structglobus__gass__transfer__request__proto__s.html">globus_gass_transfer_request_proto_s</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Protocol module request handling structure. <a href="structglobus__gass__transfer__request__proto__s.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structglobus__gass__transfer__listener__proto__s.html">globus_gass_transfer_listener_proto_s</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Protocol module listener handling structure. <a href="structglobus__gass__transfer__listener__proto__s.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structglobus__gass__transfer__proto__descriptor__t.html">globus_gass_transfer_proto_descriptor_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Protocol module descriptor structure. <a href="structglobus__gass__transfer__proto__descriptor__t.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gaaa1078847d85de85d5b9e4d83cf4a575"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="structglobus__gass__transfer__request__proto__s.html">globus_gass_transfer_request_proto_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__protocol.html#gaaa1078847d85de85d5b9e4d83cf4a575">globus_gass_transfer_request_proto_t</a></td></tr>
<tr class="separator:gaaa1078847d85de85d5b9e4d83cf4a575"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga893db9d9f79492c49f7ac8e147939b1a"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="structglobus__gass__transfer__listener__proto__s.html">globus_gass_transfer_listener_proto_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__protocol.html#ga893db9d9f79492c49f7ac8e147939b1a">globus_gass_transfer_listener_proto_t</a></td></tr>
<tr class="separator:ga893db9d9f79492c49f7ac8e147939b1a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga07dd4dd5d7ef7760438de6aa8f3bdad4"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__protocol.html#ga07dd4dd5d7ef7760438de6aa8f3bdad4">globus_gass_transfer_proto_send_t</a> )(<a class="el" href="group__globus__gass__transfer__protocol.html#gaaa1078847d85de85d5b9e4d83cf4a575">globus_gass_transfer_request_proto_t</a> *proto, <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)</td></tr>
<tr class="separator:ga07dd4dd5d7ef7760438de6aa8f3bdad4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga032bf11045041dc3151f54580e0ef5c4"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__protocol.html#ga032bf11045041dc3151f54580e0ef5c4">globus_gass_transfer_proto_receive_t</a> )(<a class="el" href="group__globus__gass__transfer__protocol.html#gaaa1078847d85de85d5b9e4d83cf4a575">globus_gass_transfer_request_proto_t</a> *proto, <a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request, globus_byte_t *bytes, globus_size_t bytes_length, globus_size_t wait_for_length)</td></tr>
<tr class="separator:ga032bf11045041dc3151f54580e0ef5c4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaaa0a01e0b020f072dc15fd9deb46f99a"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__protocol.html#gaaa0a01e0b020f072dc15fd9deb46f99a">globus_gass_transfer_proto_func_t</a> )(<a class="el" href="group__globus__gass__transfer__protocol.html#gaaa1078847d85de85d5b9e4d83cf4a575">globus_gass_transfer_request_proto_t</a> *proto, <a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request)</td></tr>
<tr class="separator:gaaa0a01e0b020f072dc15fd9deb46f99a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa49ac171608bf5379858c8c1106c6d93"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__protocol.html#gaa49ac171608bf5379858c8c1106c6d93">globus_gass_transfer_proto_new_request_t</a> )(<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request, globus_gass_transfer_requestattr_t *attr)</td></tr>
<tr class="separator:gaa49ac171608bf5379858c8c1106c6d93"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga67a9a9ff6620102111781ba49c3eeebf"><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__protocol.html#ga67a9a9ff6620102111781ba49c3eeebf">globus_gass_transfer_proto_create_listener_t</a> )(globus_gass_transfer_listener_t listener, globus_gass_transfer_listenerattr_t *attr, char *scheme, char **base_url, <a class="el" href="group__globus__gass__transfer__protocol.html#ga893db9d9f79492c49f7ac8e147939b1a">globus_gass_transfer_listener_proto_t</a> **proto)</td></tr>
<tr class="separator:ga67a9a9ff6620102111781ba49c3eeebf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadf55877c01a71ad4215787c566b19d08"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__protocol.html#gadf55877c01a71ad4215787c566b19d08">globus_gass_transfer_proto_listener_t</a> )(<a class="el" href="group__globus__gass__transfer__protocol.html#ga893db9d9f79492c49f7ac8e147939b1a">globus_gass_transfer_listener_proto_t</a> *proto, globus_gass_transfer_listener_t listener)</td></tr>
<tr class="separator:gadf55877c01a71ad4215787c566b19d08"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga08596e3286a90eebef68530519a40431"><td class="memItemLeft" align="right" valign="top">typedef globus_object_t *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__protocol.html#ga08596e3286a90eebef68530519a40431">globus_gass_transfer_proto_new_attr_t</a> )(char *url_scheme)</td></tr>
<tr class="separator:ga08596e3286a90eebef68530519a40431"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad62e21f36ecf72d5ce87967e3c6d2cdb"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__protocol.html#gad62e21f36ecf72d5ce87967e3c6d2cdb">globus_gass_transfer_proto_accept_t</a> )(<a class="el" href="group__globus__gass__transfer__protocol.html#ga893db9d9f79492c49f7ac8e147939b1a">globus_gass_transfer_listener_proto_t</a> *proto, globus_gass_transfer_listener_t listener, <a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request, globus_gass_transfer_requestattr_t *attr)</td></tr>
<tr class="separator:gad62e21f36ecf72d5ce87967e3c6d2cdb"><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:ga504ed11be998da980c66aa54beaf5872"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__protocol.html#ga504ed11be998da980c66aa54beaf5872">globus_gass_transfer_proto_send_complete</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 nbytes, globus_bool_t failed, globus_bool_t last_data)</td></tr>
<tr class="separator:ga504ed11be998da980c66aa54beaf5872"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5ddbe8ac72bc8d742e5edcdd7bcb1812"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__protocol.html#ga5ddbe8ac72bc8d742e5edcdd7bcb1812">globus_gass_transfer_proto_receive_complete</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 nbytes, globus_bool_t failed, globus_bool_t last_data)</td></tr>
<tr class="separator:ga5ddbe8ac72bc8d742e5edcdd7bcb1812"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4c7f2424daf72260b0629ad6c8b8b1e5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__protocol.html#ga4c7f2424daf72260b0629ad6c8b8b1e5">globus_gass_transfer_proto_listener_ready</a> (globus_gass_transfer_listener_t listener)</td></tr>
<tr class="separator:ga4c7f2424daf72260b0629ad6c8b8b1e5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0458b3b620922d0ad0c50a950a14c40d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__protocol.html#ga0458b3b620922d0ad0c50a950a14c40d">globus_gass_transfer_proto_register_protocol</a> (<a class="el" href="structglobus__gass__transfer__proto__descriptor__t.html">globus_gass_transfer_proto_descriptor_t</a> *proto_desc)</td></tr>
<tr class="separator:ga0458b3b620922d0ad0c50a950a14c40d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga36927fbdf3d9374e5a0a6d72c00c4de3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__protocol.html#ga36927fbdf3d9374e5a0a6d72c00c4de3">globus_gass_transfer_proto_unregister_protocol</a> (<a class="el" href="structglobus__gass__transfer__proto__descriptor__t.html">globus_gass_transfer_proto_descriptor_t</a> *proto_desc)</td></tr>
<tr class="separator:ga36927fbdf3d9374e5a0a6d72c00c4de3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5606790bad7454992afd4d0ae4ce3d6d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__protocol.html#ga5606790bad7454992afd4d0ae4ce3d6d">globus_gass_transfer_proto_request_ready</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__protocol.html#gaaa1078847d85de85d5b9e4d83cf4a575">globus_gass_transfer_request_proto_t</a> *proto)</td></tr>
<tr class="separator:ga5606790bad7454992afd4d0ae4ce3d6d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga517e838bdece326043d00b9b1c48e361"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__protocol.html#ga517e838bdece326043d00b9b1c48e361">globus_gass_transfer_proto_new_listener_request</a> (globus_gass_transfer_listener_t listener, <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__protocol.html#gaaa1078847d85de85d5b9e4d83cf4a575">globus_gass_transfer_request_proto_t</a> *proto)</td></tr>
<tr class="separator:ga517e838bdece326043d00b9b1c48e361"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf79e71910ff1d18bb09e51bb1fde7aea"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__protocol.html#gaf79e71910ff1d18bb09e51bb1fde7aea">globus_gass_transfer_proto_request_denied</a> (<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request, int reason, char *message)</td></tr>
<tr class="separator:gaf79e71910ff1d18bb09e51bb1fde7aea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5fe775f62b3f425ace38383811b637f3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__protocol.html#ga5fe775f62b3f425ace38383811b637f3">globus_gass_transfer_proto_request_referred</a> (<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request, char **url, globus_size_t num_urls)</td></tr>
<tr class="separator:ga5fe775f62b3f425ace38383811b637f3"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Protocol Implementation API. </p>
<p>The GASS Protocol Module API is designed to make it possible to extend the GASS client and server APIs to support additional protocols without making any changes to the core of the GASS implementation. GASS protocol modules are intended to to handle protocol-specific connection and data handling. The GASS Transfer library includes protocol modules which implement the HTTP, HTTPS, FTP, and GSI-FTP protocols.</p>
<p>Every protocol module implementation must include the following header file: </p>
<div class="fragment"><div class="line"><span class="preprocessor">#include "<a class="code" href="globus__gass__transfer__proto_8h.html">globus_gass_transfer_proto.h</a>"</span></div>
</div><!-- fragment --><p>To implement a protocol module, one must create a <a class="el" href="structglobus__gass__transfer__proto__descriptor__t.html" title="Protocol module descriptor structure. ">globus_gass_transfer_proto_descriptor_t</a> structure which indicates what the protocol module is able to do. This structure contains the URL scheme which the protocol module supports, and function pointers which indicate what type of operations (client or server) that the module implements. To implement a client-side protocol module, the new_requestattr and new_request fields must be set to the protocol module's implementations of those functions. To implement a server-side protocol module, the new_listenerattr and new_listener functions must be set to the protocol module's implementations of those functions.</p>
<p>A protocol module implementor registers a protocol module with the GASS Transfer library by calling the function <a class="el" href="group__globus__gass__transfer__protocol.html#ga0458b3b620922d0ad0c50a950a14c40d">globus_gass_transfer_proto_register_protocol()</a>, and unregisters the module by calling <a class="el" href="group__globus__gass__transfer__protocol.html#ga36927fbdf3d9374e5a0a6d72c00c4de3">globus_gass_transfer_proto_unregister_protocol()</a>. This functions must be called after the <a class="el" href="group__globus__gass__transfer__activation.html#ga3c4edff0d27f1038ef7d8df297d205ea">GLOBUS_GASS_TRANSFER_MODULE</a> has already been activated. Once registered, applications may use URLs of the scheme type provided by the protocol module for the standard <a class="el" href="group__globus__gass__transfer__client.html">client</a> or <a class="el" href="group__globus__gass__transfer__server.html">server</a> operations. </p>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga893db9d9f79492c49f7ac8e147939b1a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structglobus__gass__transfer__listener__proto__s.html">globus_gass_transfer_listener_proto_s</a> <a class="el" href="group__globus__gass__transfer__protocol.html#ga893db9d9f79492c49f7ac8e147939b1a">globus_gass_transfer_listener_proto_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Protocol module listener handling structure.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="structglobus__gass__transfer__listener__proto__s.html" title="Protocol module listener handling structure. ">globus_gass_transfer_listener_proto_s</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gad62e21f36ecf72d5ce87967e3c6d2cdb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* globus_gass_transfer_proto_accept_t)(<a class="el" href="group__globus__gass__transfer__protocol.html#ga893db9d9f79492c49f7ac8e147939b1a">globus_gass_transfer_listener_proto_t</a> *proto, globus_gass_transfer_listener_t listener, <a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request, globus_gass_transfer_requestattr_t *attr)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Protocol module implementation function type for server request parsing.</p>
<p>Function pointers of this type are associated with the <a class="el" href="group__globus__gass__transfer__protocol.html#ga893db9d9f79492c49f7ac8e147939b1a">globus_gass_transfer_listener_proto_t</a> associated with a particular listener handle. They are called when a server implementation wants to accept a new connection from the listener. A new request is generated based on the protocol-specific request done on the new connection.</p>
<p>The new request will be created with the attributes specified in the <em>attr</em> parameter. Once the protocol module has parsed the request, it must call <a class="el" href="group__globus__gass__transfer__protocol.html#ga517e838bdece326043d00b9b1c48e361">globus_gass_transfer_proto_new_listener_request()</a> to let the server implementation decide how to process this request.</p>
<p>The protocol module should update the <em>request</em> to indicate the type of operation being requested, the size of the file (if applicable), and the identity of the client (if applicable).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">proto</td><td>The protocol specific listener data structure associated with the listener handle. </td></tr>
<tr><td class="paramname">listener</td><td>The listener handle which the user requested the listen on. </td></tr>
<tr><td class="paramname">request</td><td>The new request handle. </td></tr>
<tr><td class="paramname">attr</td><td>The request attribute set to be used when processing this request. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga67a9a9ff6620102111781ba49c3eeebf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int(* globus_gass_transfer_proto_create_listener_t)(globus_gass_transfer_listener_t listener, globus_gass_transfer_listenerattr_t *attr, char *scheme, char **base_url, <a class="el" href="group__globus__gass__transfer__protocol.html#ga893db9d9f79492c49f7ac8e147939b1a">globus_gass_transfer_listener_proto_t</a> **proto)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Protocol module implementation function type for new server listeners.</p>
<p>A function pointer of this type is associated with the <a class="el" href="structglobus__gass__transfer__proto__descriptor__t.html" title="Protocol module descriptor structure. ">globus_gass_transfer_proto_descriptor_t</a> for a particular protocol module's implementation. It is called when the server has called <a class="el" href="group__globus__gass__transfer__server.html#ga7a1f665a5bded635bbfc827fb19f8cfb">globus_gass_transfer_create_listener()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">listener</td><td>The listener handle to assocate with the new <em>proto</em> created by the protocol module. </td></tr>
<tr><td class="paramname">attr</td><td>A protocol-specific attribute set, created by calling the protocol module's <a class="el" href="structglobus__gass__transfer__proto__descriptor__t.html#a5f5d98eb70200a3c03b0d079eea80648">new_listenerattr function pointer</a>. </td></tr>
<tr><td class="paramname">scheme</td><td>The URL scheme that the server has requested for the new listener. This will be one the scheme associated with a particular protocol module. </td></tr>
<tr><td class="paramname">base_url</td><td>A pointer to be set the value of the base url of this listener. For most protocols, this will contain the scheme, hostname, and port number of the listener. This string must be allocated using one of the memory allocators defined in the globus_common library. It will be freed by the GASS Transfer library when the listener is closed. </td></tr>
<tr><td class="paramname">proto</td><td>A pointer to be set to a new globus_gass_transfer_listener_proto_t which will be associated with this listener. This must be allocated by the protocol module using one of the memory allocators defined in the globus_common library. It will be freed by the GASS Transfer library when the listener is closed.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A GASS error value, or GLOBUS_SUCCESS. </dd></dl>
</div>
</div>
<a class="anchor" id="gaaa0a01e0b020f072dc15fd9deb46f99a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* globus_gass_transfer_proto_func_t)(<a class="el" href="group__globus__gass__transfer__protocol.html#gaaa1078847d85de85d5b9e4d83cf4a575">globus_gass_transfer_request_proto_t</a> *proto, <a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Protocol module implementation function type.</p>
<p>Function pointers of this type are associated with the <a class="el" href="group__globus__gass__transfer__protocol.html#gaaa1078847d85de85d5b9e4d83cf4a575">globus_gass_transfer_request_proto_t</a> associated with a particular request handle. They are called when certain functions which modify the status of a request have been called by a client or server.</p>
<p>A function of this type is used for the fail, deny, refer, authorize, and destroy fields of the <a class="el" href="group__globus__gass__transfer__protocol.html#gaaa1078847d85de85d5b9e4d83cf4a575">globus_gass_transfer_request_proto_t</a>. A protocol module can query the request handle to determine the status and, if applicable, denial reasons if necessary.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">proto</td><td>The protocol module's request handler. </td></tr>
<tr><td class="paramname">request</td><td>The request handle. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gadf55877c01a71ad4215787c566b19d08"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* globus_gass_transfer_proto_listener_t)(<a class="el" href="group__globus__gass__transfer__protocol.html#ga893db9d9f79492c49f7ac8e147939b1a">globus_gass_transfer_listener_proto_t</a> *proto, globus_gass_transfer_listener_t listener)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Protocol module implementation function type for server operations.</p>
<p>Function pointers of this type are associated with the <a class="el" href="group__globus__gass__transfer__protocol.html#ga893db9d9f79492c49f7ac8e147939b1a">globus_gass_transfer_listener_proto_t</a> associated with a particular listener handle. They are called when a server implementation wants to close the listener, listen for new connections, or destroy the listener.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">proto</td><td>The protocol-specific implementation of the <a class="el" href="group__globus__gass__transfer__protocol.html#ga893db9d9f79492c49f7ac8e147939b1a">globus_gass_transfer_listener_proto_t</a> for a particular listener. </td></tr>
<tr><td class="paramname">listener</td><td>The listener handle associated with the <em>proto</em>. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__globus__gass__transfer__protocol.html#ga67a9a9ff6620102111781ba49c3eeebf">globus_gass_transfer_proto_create_listener_t</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga08596e3286a90eebef68530519a40431"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef globus_object_t*(* globus_gass_transfer_proto_new_attr_t)(char *url_scheme)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Protocol module implementation function type for attribute creation.</p>
<p>A function pointer of this type is associated with the <a class="el" href="structglobus__gass__transfer__proto__descriptor__t.html" title="Protocol module descriptor structure. ">globus_gass_transfer_proto_descriptor_t</a> defining a protocol module. It is called when a client requests a new request attribute set be created for a URL scheme handled by a protocol module. The function implementation must create a new request attribute usuable by the protocol.</p>
<p>The returned attribute must be a globus object which inherits from one of the base attributes defined in the GASS Transfer API. A client or server operation will use a request attribute generated by this function when creating a new <a class="el" href="group__globus__gass__transfer__protocol.html#gaaa1078847d85de85d5b9e4d83cf4a575">globus_gass_transfer_request_proto_t</a> to handle a request.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">url_scheme</td><td>The URL scheme that the request attribute should be compatible with.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A globus_object_t-based request attribute.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__globus__gass__transfer__protocol.html#gaa49ac171608bf5379858c8c1106c6d93">globus_gass_transfer_proto_new_request_t</a>, <a class="el" href="group__globus__gass__transfer__protocol.html#gad62e21f36ecf72d5ce87967e3c6d2cdb">globus_gass_transfer_proto_accept_t</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaa49ac171608bf5379858c8c1106c6d93"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* globus_gass_transfer_proto_new_request_t)(<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request, globus_gass_transfer_requestattr_t *attr)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Protocol module implementation function type for new client requests.</p>
<p>A function pointer of this type is associated with the <a class="el" href="structglobus__gass__transfer__proto__descriptor__t.html" title="Protocol module descriptor structure. ">globus_gass_transfer_proto_descriptor_t</a> for a particular protocol module's implementation. It is called when the client has begun a file transfer request by calling one of the functions in the "@ref globus_gass_transfer_client" section of this manual.</p>
<p>When this function is called for a protocol module, the module should query the request handle to determine the URL which is being requested by the client, and the operation being done on that URL. The protocol module should initiate the request, and once it has determined that it has been authorized, denied, or referred, one of <a class="el" href="group__globus__gass__transfer__protocol.html#ga5606790bad7454992afd4d0ae4ce3d6d">globus_gass_transfer_proto_request_ready()</a>, <a class="el" href="group__globus__gass__transfer__protocol.html#gaf79e71910ff1d18bb09e51bb1fde7aea">globus_gass_transfer_proto_request_denied()</a>, or <a class="el" href="group__globus__gass__transfer__protocol.html#ga5fe775f62b3f425ace38383811b637f3">globus_gass_transfer_proto_request_referred()</a> must be called.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">request</td><td>The request handle containing the information about the request. </td></tr>
<tr><td class="paramname">attr</td><td>A protocol-specific attribute set, created by calling the protocol module's <a class="el" href="structglobus__gass__transfer__proto__descriptor__t.html#acd75372874ae7c590ebe8562777241ed">new_requestattr function pointer</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga032bf11045041dc3151f54580e0ef5c4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* globus_gass_transfer_proto_receive_t)(<a class="el" href="group__globus__gass__transfer__protocol.html#gaaa1078847d85de85d5b9e4d83cf4a575">globus_gass_transfer_request_proto_t</a> *proto, <a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request, globus_byte_t *bytes, globus_size_t bytes_length, globus_size_t wait_for_length)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Protocol module function type to handle receiving data.</p>
<p>A function pointer of this type is associated with the <a class="el" href="group__globus__gass__transfer__protocol.html#gaaa1078847d85de85d5b9e4d83cf4a575">globus_gass_transfer_request_proto_t</a> associated with a request handle. It is called when client or server has registered a bytes array for receiving from the client or server which is handling the request. The GASS Transfer Library will only pass one <em>bytes</em> array to the protocol module for processing per request at any given time.</p>
<p>Once the protocol module has processed the array, it must call <a class="el" href="group__globus__gass__transfer__protocol.html#ga5ddbe8ac72bc8d742e5edcdd7bcb1812">globus_gass_transfer_proto_receive_complete()</a> to let the GASS Transfer library continue to process the request.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">proto</td><td>The protocol module's request handler. </td></tr>
<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>The user-supplied byte array containing the data associated with the request. </td></tr>
<tr><td class="paramname">bytes_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 receive before calling <a class="el" href="group__globus__gass__transfer__protocol.html#ga5ddbe8ac72bc8d742e5edcdd7bcb1812">globus_gass_transfer_proto_receive_complete()</a> for the request. The GASS Transfer protocol module may call that function with a smaller value for the amount received if EOF has been reached. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__globus__gass__transfer__data.html#gacd7c5a82e0018c76dfce993035a5bf6a">globus_gass_transfer_receive_bytes()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga07dd4dd5d7ef7760438de6aa8f3bdad4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* globus_gass_transfer_proto_send_t)(<a class="el" href="group__globus__gass__transfer__protocol.html#gaaa1078847d85de85d5b9e4d83cf4a575">globus_gass_transfer_request_proto_t</a> *proto, <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)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Protocol module function type to handle sending data.</p>
<p>A function pointer of this type is associated with the <a class="el" href="group__globus__gass__transfer__protocol.html#gaaa1078847d85de85d5b9e4d83cf4a575">globus_gass_transfer_request_proto_t</a> associated with a request handle. It is called when client or server has registered a bytes array for sending to the client or server which is handling the request. The GASS Transfer Library will only pass one <em>bytes</em> array to the protocol module for processing per request at any given time.</p>
<p>Once the protocol module has processed the array, it must call <a class="el" href="group__globus__gass__transfer__protocol.html#ga504ed11be998da980c66aa54beaf5872">globus_gass_transfer_proto_send_complete()</a> to let the GASS Transfer library continue to process the request.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">proto</td><td>The protocol module's request handler. </td></tr>
<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>The user-supplied byte array containing the data associated with the request. </td></tr>
<tr><td class="paramname">bytes_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>
</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> </dd></dl>
</div>
</div>
<a class="anchor" id="gaaa1078847d85de85d5b9e4d83cf4a575"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structglobus__gass__transfer__request__proto__s.html">globus_gass_transfer_request_proto_s</a> <a class="el" href="group__globus__gass__transfer__protocol.html#gaaa1078847d85de85d5b9e4d83cf4a575">globus_gass_transfer_request_proto_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Protocol module request handling structure.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="structglobus__gass__transfer__request__proto__s.html" title="Protocol module request handling structure. ">globus_gass_transfer_request_proto_s</a> </dd></dl>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga4c7f2424daf72260b0629ad6c8b8b1e5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void globus_gass_transfer_proto_listener_ready </td>
<td>(</td>
<td class="paramtype">globus_gass_transfer_listener_t </td>
<td class="paramname"><em>listener</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Server listener ready.</p>
<p>This function notifies the GASS Transfer Library that the protocol module has decided that a new request can be accepted on this particular listener. It must only be called after the GASS Transfer Library has called the <a class="el" href="structglobus__gass__transfer__listener__proto__s.html#adaeeaaa668decf8bdb8d2346d174229d">listen function</a> in a <a class="el" href="group__globus__gass__transfer__protocol.html#ga893db9d9f79492c49f7ac8e147939b1a">globus_gass_transfer_listener_proto_t</a> protocol module-specific listener structure.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">listener</td><td>The listener handle which is now ready for accepting a new connection. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga517e838bdece326043d00b9b1c48e361"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void globus_gass_transfer_proto_new_listener_request </td>
<td>(</td>
<td class="paramtype">globus_gass_transfer_listener_t </td>
<td class="paramname"><em>listener</em>, </td>
</tr>
<tr>
<td class="paramkey"></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"><a class="el" href="group__globus__gass__transfer__protocol.html#gaaa1078847d85de85d5b9e4d83cf4a575">globus_gass_transfer_request_proto_t</a> * </td>
<td class="paramname"><em>proto</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>New listener request.</p>
<p>This function notifies the GASS Transfer Library that new request generated by a server calling the <a class="el" href="group__globus__gass__transfer__server.html#gab4e154bc89c309651d030399cf5b7ec3">globus_gass_transfer_register_accept()</a> function has begun processing in a protocol module, and that protocol module is now ready to send or receive data to handle this request.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">listener</td><td>The listener handle used to accept this request. </td></tr>
<tr><td class="paramname">request</td><td>The request handle used for this request. This was created by the user calling one of the functions in the "@ref
globus_gass_transfer_client" section of this manual. </td></tr>
<tr><td class="paramname">proto</td><td>The protocol-module specific request structure. This structure contains a set of function pointers to allow GASS to continue to process this request. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga5ddbe8ac72bc8d742e5edcdd7bcb1812"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void globus_gass_transfer_proto_receive_complete </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>nbytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_bool_t </td>
<td class="paramname"><em>failed</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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Data receive complete.</p>
<p>A protocol module must call this function once a byte range registered for receive via the protocol module's recv_buffer method has been completely processed. This function is called for protocol modules implementing either server or client functionality.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<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 received into. This should be the same as the pointer passed in the send_buffer method. </td></tr>
<tr><td class="paramname">nbytes</td><td>The number of bytes which were sent from this byte array. This may be different than length passed to the send_buffer method if an error occurred or EOF was reached while receiving the data. </td></tr>
<tr><td class="paramname">failed</td><td>A boolean indicating whether this byte range was successfully received or not. This should be set to <em>GLOBUS_TRUE</em> if either a protocol error or a user-generated abort has occurred while processing the byte range. If this is set to <em>GLOBUS_TRUE</em>, then the <em>last_data</em> parameter must also be set to <em>GLOBUS_TRUE</em>. </td></tr>
<tr><td class="paramname">last_data</td><td>A boolean indicating whether this byte range was the final one which can be processed for this request. This should be set to <em>GLOBUS_TRUE</em> if an error occurred while processing this byte range, and user-generated abort occurred, or this is the final byte range in the data transfer.</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> </dd></dl>
</div>
</div>
<a class="anchor" id="ga0458b3b620922d0ad0c50a950a14c40d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_transfer_proto_register_protocol </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structglobus__gass__transfer__proto__descriptor__t.html">globus_gass_transfer_proto_descriptor_t</a> * </td>
<td class="paramname"><em>proto_desc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Register protocol.</p>
<p>This function registers a protocol module handler with the GASS Transfer library. If this succeeds, then users of the library may use the URLs with the protocol scheme implemented by this module descriptor in GASS Transfer operations.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">proto_desc</td><td>The protocol module descriptor. See the "@ref
globus_gass_transfer_protocol" section of the manual for information on this structure.</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 protocol module was successfully registered with GASS. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER</td><td>The <em>proto_desc</em> parameter was <em>GLOBUS_NULL</em>. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_ALREADY_REGISTERED</td><td>A protocol module has already been registered with GASS to handle this URL scheme. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaf79e71910ff1d18bb09e51bb1fde7aea"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void globus_gass_transfer_proto_request_denied </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">int </td>
<td class="paramname"><em>reason</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>message</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Request denied.</p>
<p>This function notifies the GASS Transfer Library that new request generated by a client calling one of the functions in the "@ref globus_gass_transfer_client" section of the manual has been denied by the server, and so cannot be processed by the protocol module.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">request</td><td>The request handle used for this request. This was created by the user calling one of the functions in the "@ref
globus_gass_transfer_client" section of this manual. </td></tr>
<tr><td class="paramname">reason</td><td>A protocol-specific reason code. </td></tr>
<tr><td class="paramname">message</td><td>A string containing a message describing why the request was denied. The GASS Transfer library is responsible for freeing this message. It must be allocated using one of the memory allocators defined in the Globus Common Library.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__globus__gass__transfer__protocol.html#ga5606790bad7454992afd4d0ae4ce3d6d">globus_gass_transfer_proto_request_ready()</a>, <a class="el" href="group__globus__gass__transfer__protocol.html#ga5fe775f62b3f425ace38383811b637f3">globus_gass_transfer_proto_request_referred()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga5606790bad7454992afd4d0ae4ce3d6d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void globus_gass_transfer_proto_request_ready </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"><a class="el" href="group__globus__gass__transfer__protocol.html#gaaa1078847d85de85d5b9e4d83cf4a575">globus_gass_transfer_request_proto_t</a> * </td>
<td class="paramname"><em>proto</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Request ready.</p>
<p>This function notifies the GASS Transfer Library that new request generated by a client has begun processing in a protocol module, and that protocol module is now ready to send or receive data to handle this request.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">request</td><td>The request handle used for this request. This was created by the user calling one of the functions in the "@ref
globus_gass_transfer_client" section of this manual. </td></tr>
<tr><td class="paramname">proto</td><td>The protocol-module specific request structure. This structure contains a set of function pointers to allow GASS to continue to process this request.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__globus__gass__transfer__protocol.html#ga5fe775f62b3f425ace38383811b637f3">globus_gass_transfer_proto_request_referred()</a>, <a class="el" href="group__globus__gass__transfer__protocol.html#gaf79e71910ff1d18bb09e51bb1fde7aea">globus_gass_transfer_proto_request_denied()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga5fe775f62b3f425ace38383811b637f3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void globus_gass_transfer_proto_request_referred </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">char ** </td>
<td class="paramname"><em>url</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_size_t </td>
<td class="paramname"><em>num_urls</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Request referred.</p>
<p>This function notifies the GASS Transfer Library that new request generated by a client calling one of the functions in the "@ref globus_gass_transfer_client" section of the manual has been referred to another URL by the server, and so processing has stopped.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">request</td><td>The request handle used for this request. This was created by the user calling one of the functions in the "@ref
globus_gass_transfer_client" section of this manual. </td></tr>
<tr><td class="paramname">url</td><td>An array of url strings containing alternate locations for this file. The GASS transfer library is responsible for freeing this array. It must be allocated using one of the memory allocators defined in the Globus Common Library. </td></tr>
<tr><td class="paramname">num_urls</td><td>The length of the <em>url</em> array.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__globus__gass__transfer__protocol.html#ga5606790bad7454992afd4d0ae4ce3d6d">globus_gass_transfer_proto_request_ready()</a>, <a class="el" href="group__globus__gass__transfer__protocol.html#gaf79e71910ff1d18bb09e51bb1fde7aea">globus_gass_transfer_proto_request_denied()</a>, <a class="el" href="group__globus__gass__transfer__protocol.html#ga5fe775f62b3f425ace38383811b637f3">globus_gass_transfer_proto_request_referred()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga504ed11be998da980c66aa54beaf5872"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void globus_gass_transfer_proto_send_complete </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>nbytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_bool_t </td>
<td class="paramname"><em>failed</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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Data send complete.</p>
<p>A protocol module must call this function once a byte range registered for sending via the protocol module's send_buffer method has been completely processed. This function is called for protocol modules implementing either server or client functionality.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<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. This should be the same as the pointer passed in the send_buffer method. </td></tr>
<tr><td class="paramname">nbytes</td><td>The number of bytes which were sent from this byte array. This may be different than length passed to the send_buffer method if an error occurred. </td></tr>
<tr><td class="paramname">failed</td><td>A boolean indicating whether this byte range was successfully sent or not. This should be set to <em>GLOBUS_TRUE</em> if either a protocol error or a user-generated abort has occurred while processing the byte range. If this is set to <em>GLOBUS_TRUE</em>, then the <em>last_data</em> parameter must also be set to <em>GLOBUS_TRUE</em>. </td></tr>
<tr><td class="paramname">last_data</td><td>A boolean indicating whether this byte range was the final one which can be processed for this request. This should be set to <em>GLOBUS_TRUE</em> if an error occurred while processing this byte range, and user-generated abort occurred, or this is the final byte range in the data transfer.</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> </dd></dl>
</div>
</div>
<a class="anchor" id="ga36927fbdf3d9374e5a0a6d72c00c4de3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_transfer_proto_unregister_protocol </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structglobus__gass__transfer__proto__descriptor__t.html">globus_gass_transfer_proto_descriptor_t</a> * </td>
<td class="paramname"><em>proto_desc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unregister protocol.</p>
<p>This function unregisters a protocol module handler from the GASS Transfer library. If this succeeds, then users of the library may no longer user URLs with the protocol scheme implemented by this module descriptor in GASS Transfer operations.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">proto_desc</td><td>The protocol module descriptor. See the "@ref
globus_gass_transfer_protocol" section of the manual for information on this structure.</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 protocol module was successfully registered with GASS. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER</td><td>The <em>proto_desc</em> parameter was <em>GLOBUS_NULL</em>. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_INVALID_USE</td><td>A protocol module has not been registered with GASS to handle this URL scheme. </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.6
</small></address>
</body>
</html>
