<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta name="robots" content="noindex">
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<!-- THIS FILE IS AUTOMATICALLY GENERATED FROM THE GLOBUS SOURCE CODE
DO NOT MODIFY.
-->
<title>Globus Reference Manual</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<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>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('group__globus__gass__transfer__server.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Implementing Servers</div> </div>
</div>
<div class="contents">
<p>GASS Server Implementation API.
<a href="#details">More...</a></p>
<h2><a name="typedef-members"></a>
Typedefs</h2>
<ul>
<li>typedef void(* <a class="el" href="group__globus__gass__transfer__server.html#gaf7d16b1ec66f320b016549f1d339e893">globus_gass_transfer_close_callback_t</a> )(void *callback_arg, globus_gass_transfer_listener_t listener)
<li>typedef void(* <a class="el" href="group__globus__gass__transfer__server.html#ga1c50f2e6b9d521ab78c58d52ea8dd022">globus_gass_transfer_listen_callback_t</a> )(void *callback_arg, globus_gass_transfer_listener_t listener)
</ul>
<h2><a name="func-members"></a>
Functions</h2>
<ul>
<li>int <a class="el" href="group__globus__gass__transfer__server.html#ga7a1f665a5bded635bbfc827fb19f8cfb">globus_gass_transfer_create_listener</a> (globus_gass_transfer_listener_t *listener, globus_gass_transfer_listenerattr_t *attr, char *scheme)
<li>int <a class="el" href="group__globus__gass__transfer__server.html#ga3463614692379d6916d815334677fc8a">globus_gass_transfer_close_listener</a> (globus_gass_transfer_listener_t listener, <a class="el" href="group__globus__gass__transfer__server.html#gaf7d16b1ec66f320b016549f1d339e893">globus_gass_transfer_close_callback_t</a> callback, void *user_arg)
<li>int <a class="el" href="group__globus__gass__transfer__server.html#gaed8889aac80108c0b29757cb87a58b4c">globus_gass_transfer_register_listen</a> (globus_gass_transfer_listener_t listener, <a class="el" href="group__globus__gass__transfer__server.html#ga1c50f2e6b9d521ab78c58d52ea8dd022">globus_gass_transfer_listen_callback_t</a> callback, void *user_arg)
<li>int <a class="el" href="group__globus__gass__transfer__server.html#gab4e154bc89c309651d030399cf5b7ec3">globus_gass_transfer_register_accept</a> (<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> *request, globus_gass_transfer_requestattr_t *attr, globus_gass_transfer_listener_t listener, globus_gass_transfer_callback_t callback, void *user_arg)
<li>void * <a class="el" href="group__globus__gass__transfer__server.html#ga365267c9798a08ecab8a80e8f128d19f">globus_gass_transfer_listener_get_user_pointer</a> (globus_gass_transfer_listener_t listener)
<li>int <a class="el" href="group__globus__gass__transfer__server.html#ga381f95f7eafe7048f0057974d9509ecf">globus_gass_transfer_listener_set_user_pointer</a> (globus_gass_transfer_listener_t listener, void *user_pointer)
<li>char * <a class="el" href="group__globus__gass__transfer__server.html#gadaa337dc4df4f0a68326aa9cdd29d29c">globus_gass_transfer_listener_get_base_url</a> (globus_gass_transfer_listener_t listener)
<li>int <a class="el" href="group__globus__gass__transfer__server.html#ga2604152dc7e5751c83c215bc076171c0">globus_gass_transfer_refer</a> (<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request, char **urls, globus_size_t num_urls)
<li>int <a class="el" href="group__globus__gass__transfer__server.html#ga068c0c63ed4e2635d273c2f61c823c0b">globus_gass_transfer_authorize</a> (<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request, globus_size_t total_length)
<li>int <a class="el" href="group__globus__gass__transfer__server.html#gaa8ab9a7b1b036264c11ecde6c3c565de">globus_gass_transfer_deny</a> (<a class="el" href="structglobus__gass__transfer__request__t.html">globus_gass_transfer_request_t</a> request, int reason, char *message)
</ul>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>GASS Server Implementation API. </p>
<p>Another mode of using the GASS Transfer API is to implement data servers. The primary difference between the client and server parts of the GASS Transfer API are how requests are generated.</p>
<p>To implement a server, the user would call <a class="el" href="group__globus__gass__transfer__server.html#ga7a1f665a5bded635bbfc827fb19f8cfb" title="Create a new protocol-specific listener socket for a GASS server.">globus_gass_transfer_create_listener()</a> to create a new server port on which a specific protocol will be used to request file transfer operations. The user may obtain the URL that the listener is bound to by calling <a class="el" href="group__globus__gass__transfer__server.html#gadaa337dc4df4f0a68326aa9cdd29d29c" title="Get the base URL of a listener.">globus_gass_transfer_listener_get_base_url()</a>.</p>
<p>Once the listener is created, the user can call <a class="el" href="group__globus__gass__transfer__server.html#gaed8889aac80108c0b29757cb87a58b4c" title="Listen for new client connections.">globus_gass_transfer_register_listen()</a> to wait for clients to connect to it. Once the server has detected an attempt to connect by a client, the use can call <a class="el" href="group__globus__gass__transfer__server.html#gab4e154bc89c309651d030399cf5b7ec3" title="Accept new client connections.">globus_gass_transfer_register_accept()</a> to accept the connection from the client and parse the request.</p>
<p>In the callback associated with <a class="el" href="group__globus__gass__transfer__server.html#gab4e154bc89c309651d030399cf5b7ec3" title="Accept new client connections.">globus_gass_transfer_register_accept()</a>, the server can decide how to process the request. The user may choose to authorize the request by calling <a class="el" href="group__globus__gass__transfer__server.html#ga068c0c63ed4e2635d273c2f61c823c0b" title="Authorize a request.">globus_gass_transfer_authorize()</a>, refer it to another URL or URLs by calling <a class="el" href="group__globus__gass__transfer__server.html#ga2604152dc7e5751c83c215bc076171c0" title="Refer a request.">globus_gass_transfer_refer()</a> or deny the client access to the URL by calling <a class="el" href="group__globus__gass__transfer__server.html#gaa8ab9a7b1b036264c11ecde6c3c565de" title="Deny a request.">globus_gass_transfer_deny()</a>. </p>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="gaf7d16b1ec66f320b016549f1d339e893"></a><!-- doxytag: member="globus_gass_transfer.h::globus_gass_transfer_close_callback_t" ref="gaf7d16b1ec66f320b016549f1d339e893" args=")(void *callback_arg, globus_gass_transfer_listener_t listener)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* <a class="el" href="group__globus__gass__transfer__server.html#gaf7d16b1ec66f320b016549f1d339e893">globus_gass_transfer_close_callback_t</a>)(void *callback_arg, globus_gass_transfer_listener_t listener)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Listener close callback. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">callback_arg</td><td></td></tr>
<tr><td class="paramname">listener</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga1c50f2e6b9d521ab78c58d52ea8dd022"></a><!-- doxytag: member="globus_gass_transfer.h::globus_gass_transfer_listen_callback_t" ref="ga1c50f2e6b9d521ab78c58d52ea8dd022" args=")(void *callback_arg, globus_gass_transfer_listener_t listener)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* <a class="el" href="group__globus__gass__transfer__server.html#ga1c50f2e6b9d521ab78c58d52ea8dd022">globus_gass_transfer_listen_callback_t</a>)(void *callback_arg, globus_gass_transfer_listener_t listener)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Listen callback. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">callback_arg</td><td></td></tr>
<tr><td class="paramname">listener</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga7a1f665a5bded635bbfc827fb19f8cfb"></a><!-- doxytag: member="globus_gass_transfer_server.c::globus_gass_transfer_create_listener" ref="ga7a1f665a5bded635bbfc827fb19f8cfb" args="(globus_gass_transfer_listener_t *listener, globus_gass_transfer_listenerattr_t *attr, char *scheme)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_transfer_create_listener </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">globus_gass_transfer_listenerattr_t * </td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>scheme</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a new protocol-specific listener socket for a GASS server. </p>
<p>This function creates a new socket to listen for client connections as a GASS server. The listener handle pointer is initialized to contain the a new handle which can be used in subsequent server operations.</p>
<p>After calling this function, a user may call the <a class="el" href="group__globus__gass__transfer__server.html#gaed8889aac80108c0b29757cb87a58b4c" title="Listen for new client connections.">globus_gass_transfer_register_listen()</a> or <a class="el" href="group__globus__gass__transfer__server.html#ga3463614692379d6916d815334677fc8a" title="Close a GASS listener.">globus_gass_transfer_close_listener()</a> functions with this listener handle.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">listener</td><td>A new listener handle to initialize. </td></tr>
<tr><td class="paramname">attr</td><td>Protocol-specific attributes for the new listener. </td></tr>
<tr><td class="paramname">scheme</td><td>The protocol scheme to implement for the listener.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table class="retval">
<tr><td class="paramname">GLOBUS_SUCCESS</td><td>The listener was successfully created. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER</td><td>The <em>listener</em> or <em>scheme</em> parameter was NULL </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NOT_IMPLEMENTED</td><td>The <em>scheme</em> is not supported by any protocol module. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_MALLOC_FAILED</td><td>Data structures associated with the transfer could not be allocated. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga3463614692379d6916d815334677fc8a"></a><!-- doxytag: member="globus_gass_transfer_server.c::globus_gass_transfer_close_listener" ref="ga3463614692379d6916d815334677fc8a" args="(globus_gass_transfer_listener_t listener, globus_gass_transfer_close_callback_t callback, void *user_arg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_transfer_close_listener </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="group__globus__gass__transfer__server.html#gaf7d16b1ec66f320b016549f1d339e893">globus_gass_transfer_close_callback_t</a> </td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>user_arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Close a GASS listener. </p>
<p>This function calls the protocol specific function needed to close a GASS server listener port. Callbacks for any outstanding accepts will be called before the close callback is invoked.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">listener</td><td>Listener handle created by calling <a class="el" href="group__globus__gass__transfer__server.html#ga7a1f665a5bded635bbfc827fb19f8cfb" title="Create a new protocol-specific listener socket for a GASS server.">globus_gass_transfer_create_listener()</a>. </td></tr>
<tr><td class="paramname">callback</td><td>Function to call once the listener handle has been closed. </td></tr>
<tr><td class="paramname">user_arg</td><td>Argument to be passed to the <em>callback</em> function.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table class="retval">
<tr><td class="paramname">GLOBUS_SUCCESS</td><td>The close operation was successfully registered on the listener. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_INVALID_USE</td><td>The listener handle was invalid. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NOT_INITIALIZED</td><td>The listener handle was not properly initialized. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_DONE</td><td>A close has already been registered on the listener. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaed8889aac80108c0b29757cb87a58b4c"></a><!-- doxytag: member="globus_gass_transfer_server.c::globus_gass_transfer_register_listen" ref="gaed8889aac80108c0b29757cb87a58b4c" args="(globus_gass_transfer_listener_t listener, globus_gass_transfer_listen_callback_t callback, void *user_arg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_transfer_register_listen </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="group__globus__gass__transfer__server.html#ga1c50f2e6b9d521ab78c58d52ea8dd022">globus_gass_transfer_listen_callback_t</a> </td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>user_arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Listen for new client connections. </p>
<p>This function causes the listener handle to listen for new client connections. When one is ready, it calls the specified <em>callback</em> function, letting the server implementer continue to accept the connection and process the request.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">listener</td><td>The listener handle to register for new connections. </td></tr>
<tr><td class="paramname">callback</td><td>Function to call when a new connection may be accepted. </td></tr>
<tr><td class="paramname">user_arg</td><td>Argument to be passed to the callback function.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table class="retval">
<tr><td class="paramname">GLOBUS_SUCCESS</td><td>The listen callback has been registered with the protocol module. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_INVALID_USE</td><td>An invalid <em>listener</em> handle was passed to this function. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NOT_INITIALIZED</td><td>An uninitialized <em>listener</em> handle was passed to this function. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_ALREADY_REGISTERED</td><td>The listener has already been registered for a new connection. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_DONE</td><td>The listener has been registered for closing.</td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__globus__gass__transfer__server.html#gab4e154bc89c309651d030399cf5b7ec3" title="Accept new client connections.">globus_gass_transfer_register_accept()</a>; </dd></dl>
</div>
</div>
<a class="anchor" id="gab4e154bc89c309651d030399cf5b7ec3"></a><!-- doxytag: member="globus_gass_transfer_server.c::globus_gass_transfer_register_accept" ref="gab4e154bc89c309651d030399cf5b7ec3" args="(globus_gass_transfer_request_t *request, globus_gass_transfer_requestattr_t *attr, globus_gass_transfer_listener_t listener, globus_gass_transfer_callback_t callback, void *user_arg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_transfer_register_accept </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_gass_transfer_requestattr_t * </td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></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">globus_gass_transfer_callback_t </td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>user_arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Accept new client connections. </p>
<p>This function causes the listener handle to accept a new connection on the listener and parse the file request. Once the file request has been parsed, the specified <em>callback</em> function will be called. The server implementation must then either authorize, deny, or refer this request.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">request</td><td>A pointer to a new request handle. This request handle will be initialized when the callback function is invoked. </td></tr>
<tr><td class="paramname">attr</td><td>Request attributes. </td></tr>
<tr><td class="paramname">listener</td><td>The listener handle to register for the new request. </td></tr>
<tr><td class="paramname">callback</td><td>Function to call when the protocol module has parsed the file request. </td></tr>
<tr><td class="paramname">user_arg</td><td>Argument to be passed to the callback function.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table class="retval">
<tr><td class="paramname">GLOBUS_SUCCESS</td><td>The listen callback has been registered with the protocol module. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_INVALID_USE</td><td>An invalid <em>listener</em> handle was passed to this function. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NOT_INITIALIZED</td><td>An uninitialized <em>listener</em> handle was passed to this function. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_INTERNAL_ERROR</td><td>The request could not be initialized due to some internal resource depletion. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_NOT_REGISTERED.</td><td>The <a class="el" href="group__globus__gass__transfer__server.html#gaed8889aac80108c0b29757cb87a58b4c" title="Listen for new client connections.">globus_gass_transfer_register_listen()</a> function has not yet been called. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_ALREADY_REGISTERED.</td><td>The listener is already processing a new request. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_DONE</td><td>The listener has been registered for closing.</td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__globus__gass__transfer__server.html#gaed8889aac80108c0b29757cb87a58b4c" title="Listen for new client connections.">globus_gass_transfer_register_listen()</a>; </dd></dl>
</div>
</div>
<a class="anchor" id="ga365267c9798a08ecab8a80e8f128d19f"></a><!-- doxytag: member="globus_gass_transfer_server.c::globus_gass_transfer_listener_get_user_pointer" ref="ga365267c9798a08ecab8a80e8f128d19f" args="(globus_gass_transfer_listener_t listener)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* globus_gass_transfer_listener_get_user_pointer </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>Get the user pointer associated with a listener. </p>
<p>This function will query the listener's user_pointer field and return it's value.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">listener</td><td>The listener handle.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>If the listener handle is invalid or the user_pointer's value has not been set, then GLOBUS_NULL will be returned. Otherwise, the value of the user pointer will be returned.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__globus__gass__transfer__server.html#ga381f95f7eafe7048f0057974d9509ecf" title="Set the user pointer associated with a listener.">globus_gass_transfer_listener_set_user_pointer()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga381f95f7eafe7048f0057974d9509ecf"></a><!-- doxytag: member="globus_gass_transfer_server.c::globus_gass_transfer_listener_set_user_pointer" ref="ga381f95f7eafe7048f0057974d9509ecf" args="(globus_gass_transfer_listener_t listener, void *user_pointer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_transfer_listener_set_user_pointer </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">void * </td>
<td class="paramname"><em>user_pointer</em> </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 listener. </p>
<p>This function will set the listener's user_pointer field. The pointer may be used to associate any pointer-sized data with a listener handle.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">listener</td><td>The listener handle. </td></tr>
<tr><td class="paramname">user_pointer</td><td>The value of the user pointer.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table class="retval">
<tr><td class="paramname">GLOBUS_SUCCESS</td><td>The user pointer was successfully set. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_INVALID_USE</td><td>The <em>listener</em> handle was invalid.</td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__globus__gass__transfer__server.html#ga365267c9798a08ecab8a80e8f128d19f" title="Get the user pointer associated with a listener.">globus_gass_transfer_listener_get_user_pointer()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gadaa337dc4df4f0a68326aa9cdd29d29c"></a><!-- doxytag: member="globus_gass_transfer_server.c::globus_gass_transfer_listener_get_base_url" ref="gadaa337dc4df4f0a68326aa9cdd29d29c" args="(globus_gass_transfer_listener_t listener)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* globus_gass_transfer_listener_get_base_url </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>Get the base URL of a listener. </p>
<p>This function queries a listener handle for the base URL which the server is listening on. For most protocols, this contains the protocol scheme, host, and port that the listener has registered itself on.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">listener</td><td>The listener handle to query.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>This function returns a pointer to a string containing the base URL. This string must not be freed or modified by the caller. It may not be referred to after the function globus_gass_transfer_listener_close() has been called. </dd></dl>
</div>
</div>
<a class="anchor" id="ga2604152dc7e5751c83c215bc076171c0"></a><!-- doxytag: member="globus_gass_transfer_server.c::globus_gass_transfer_refer" ref="ga2604152dc7e5751c83c215bc076171c0" args="(globus_gass_transfer_request_t request, char **urls, globus_size_t num_urls)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_transfer_refer </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>urls</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>Refer a request. </p>
<p>This function causes the request to be referred to another URL or list of URLs. It should be called in response to a request accept callback when the server wants to refer the client to another server or servers to process the request.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">request</td><td>A new request handle, passed to the server in an accept callback. </td></tr>
<tr><td class="paramname">urls</td><td>An array of strings, each being a URL pointing to sources of the same data as the original URL. </td></tr>
<tr><td class="paramname">num_urls</td><td>The length of the <em>urls</em> array.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table class="retval">
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_INVALID_USE</td><td>The request handle was not valid, not created by calling <a class="el" href="group__globus__gass__transfer__server.html#gab4e154bc89c309651d030399cf5b7ec3" title="Accept new client connections.">globus_gass_transfer_register_accept()</a>, or has already been denied or authorized. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NOT_IMPLEMENTED</td><td>The protocol module does not support referrals.</td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__globus__gass__transfer__server.html#gaa8ab9a7b1b036264c11ecde6c3c565de" title="Deny a request.">globus_gass_transfer_deny()</a>, <a class="el" href="group__globus__gass__transfer__server.html#ga068c0c63ed4e2635d273c2f61c823c0b" title="Authorize a request.">globus_gass_transfer_authorize()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga068c0c63ed4e2635d273c2f61c823c0b"></a><!-- doxytag: member="globus_gass_transfer_server.c::globus_gass_transfer_authorize" ref="ga068c0c63ed4e2635d273c2f61c823c0b" args="(globus_gass_transfer_request_t request, globus_size_t total_length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_transfer_authorize </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_size_t </td>
<td class="paramname"><em>total_length</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Authorize a request. </p>
<p>This function causes the request to be authorized for processing. It should be called in response to a request accept callback when the server wants to agree to process this request. After calling this function, the server implementation should call <a class="el" href="group__globus__gass__transfer__data.html#gaf9fafa443774f59abd5a6584bdeee646" title="Send a byte array associated with a request handle.">globus_gass_transfer_send_bytes()</a> or <a class="el" href="group__globus__gass__transfer__data.html#gacd7c5a82e0018c76dfce993035a5bf6a" title="Receive a byte array associated with a request handle.">globus_gass_transfer_receive_bytes()</a> to send or receive the data associated with the URL.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">request</td><td>A new request handle, passed to the server in an accept callback. </td></tr>
<tr><td class="paramname">total_length</td><td>For a "get" request, the total_length of the file to be retrieved if known. This value may be GLOBUS_GASS_LENGTH_UNKNOWN if the protocol supports transferring arbitrarily-sized files.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table class="retval">
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_INVALID_USE</td><td>The request handle was not valid, not created by calling <a class="el" href="group__globus__gass__transfer__server.html#gab4e154bc89c309651d030399cf5b7ec3" title="Accept new client connections.">globus_gass_transfer_register_accept()</a>, or has already been denied or authorized. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NOT_IMPLEMENTED</td><td>The protocol module does not support authorizing requests.</td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__globus__gass__transfer__server.html#ga2604152dc7e5751c83c215bc076171c0" title="Refer a request.">globus_gass_transfer_refer()</a>, <a class="el" href="group__globus__gass__transfer__server.html#gaa8ab9a7b1b036264c11ecde6c3c565de" title="Deny a request.">globus_gass_transfer_deny()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaa8ab9a7b1b036264c11ecde6c3c565de"></a><!-- doxytag: member="globus_gass_transfer_server.c::globus_gass_transfer_deny" ref="gaa8ab9a7b1b036264c11ecde6c3c565de" args="(globus_gass_transfer_request_t request, int reason, char *message)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_transfer_deny </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>Deny a request. </p>
<p>This function causes the request to be denied for further processing. It should be called in response to a request ccept callback when the server wants to refuse processing this request for the client. After calling this function, the server implementation need do nothing further with the request handle.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">request</td><td>A new request handle, passed to the server in an accept callback. </td></tr>
<tr><td class="paramname">reason</td><td>A protocol-specific reason code. </td></tr>
<tr><td class="paramname">message</td><td>An informational message to be sent to the client.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table class="retval">
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_INVALID_USE</td><td>The request handle was not valid, not created by calling <a class="el" href="group__globus__gass__transfer__server.html#gab4e154bc89c309651d030399cf5b7ec3" title="Accept new client connections.">globus_gass_transfer_register_accept()</a>, or has already been denied or authorized. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NOT_IMPLEMENTED</td><td>The protocol module does not support denying requests.</td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__globus__gass__transfer__server.html#ga2604152dc7e5751c83c215bc076171c0" title="Refer a request.">globus_gass_transfer_refer()</a>, <a class="el" href="group__globus__gass__transfer__server.html#ga068c0c63ed4e2635d273c2f61c823c0b" title="Authorize a request.">globus_gass_transfer_authorize()</a> </dd></dl>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<hr>
<p align="center">
<a href="http://www.globus.org/toolkit/about.html" target="_top">about globus</a> |
<a href="http://www.globus.org/toolkit/" target="_top">globus toolkit</a> |
<a href="https://dev.globus.org/wiki/Welcome/" target="_top">dev.globus</a>
<br>
<br>
Comments? <a href="mailto:webmaster@globus.org">webmaster@globus.org</a>
</body>
</html>
