<!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.8.3.1 -->
<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><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__globus__gass__transfer__listenerattr.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Listener attributes</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaa07336fe642b03fbe9a1aa7ade9ac159"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__listenerattr.html#gaa07336fe642b03fbe9a1aa7ade9ac159">globus_gass_transfer_listenerattr_init</a> (globus_gass_transfer_listenerattr_t *attr, char *url_scheme)</td></tr>
<tr class="separator:gaa07336fe642b03fbe9a1aa7ade9ac159"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Listener Backlog</h2></td></tr>
<tr class="memitem:ga4aca10b7756d3233a76277eab3e0cf42"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__listenerattr.html#ga4aca10b7756d3233a76277eab3e0cf42">globus_gass_transfer_listenerattr_set_backlog</a> (globus_gass_transfer_listenerattr_t *attr, int backlog)</td></tr>
<tr class="separator:ga4aca10b7756d3233a76277eab3e0cf42"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae38d0d02316beef7c1bbc3080e6e9192"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__listenerattr.html#gae38d0d02316beef7c1bbc3080e6e9192">globus_gass_transfer_listenerattr_get_backlog</a> (globus_gass_transfer_listenerattr_t *attr, int *backlog)</td></tr>
<tr class="separator:gae38d0d02316beef7c1bbc3080e6e9192"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Listener Port</h2></td></tr>
<tr class="memitem:ga14be85aace2db3fb900d04a312170168"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__listenerattr.html#ga14be85aace2db3fb900d04a312170168">globus_gass_transfer_listenerattr_set_port</a> (globus_gass_transfer_listenerattr_t *attr, unsigned short port)</td></tr>
<tr class="separator:ga14be85aace2db3fb900d04a312170168"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf5f2b57de3e94a93140c47dbc0fff885"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gass__transfer__listenerattr.html#gaf5f2b57de3e94a93140c47dbc0fff885">globus_gass_transfer_listenerattr_get_port</a> (globus_gass_transfer_listenerattr_t *attr, unsigned short *port)</td></tr>
<tr class="separator:gaf5f2b57de3e94a93140c47dbc0fff885"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gaa07336fe642b03fbe9a1aa7ade9ac159"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_transfer_listenerattr_init </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>url_scheme</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize a listener attribute. </p>
<p>This function initializes the <em>attr</em> to contain a new protocol-specific listener attribute.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>The attribute set to be initialized. </td></tr>
<tr><td class="paramname">url_scheme</td><td>The scheme which which the attribute will be used for.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">GLOBUS_SUCCESS</td><td>The attribute was successfully initialized. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER</td><td>Either <em>attr</em> or <em>url_scheme</em> was GLOBUS_NULL. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NOT_IMPLEMENTED</td><td>No protocol module currently registered with GASS Transfer Library handles URLs with the specified <em>url_scheme</em>. </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="structglobus__gass__transfer__proto__descriptor__t.html#a5f5d98eb70200a3c03b0d079eea80648">globus_gass_transfer_proto_descriptor_t::new_listenerattr</a>.</p>
</div>
</div>
<a class="anchor" id="ga4aca10b7756d3233a76277eab3e0cf42"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_transfer_listenerattr_set_backlog </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">int </td>
<td class="paramname"><em>backlog</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set/Get the backlog attribute for a GASS transfer attribute set. </p>
<p>This attribute allows the user to control then number of pending connections which may exist for this listener.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>The attribute set to query or modify. </td></tr>
<tr><td class="paramname">backlog</td><td>The number of outstanding connections to allow.</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 attribute was successfully updated. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER</td><td>The <em>attr</em> was GLOBUS_NULL. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga14be85aace2db3fb900d04a312170168"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_transfer_listenerattr_set_port </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">unsigned short </td>
<td class="paramname"><em>port</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set/Get the port attribute for a GASS transfer attribute set. </p>
<p>This attribute allows the user to set the port to be used by a GASS Transfer listener.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>The attribute set to query or modify. </td></tr>
<tr><td class="paramname">port</td><td>The TCP or UDP port number to use.</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 attribute was successfully updated. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER</td><td>The <em>attr</em> was GLOBUS_NULL. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gae38d0d02316beef7c1bbc3080e6e9192"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_transfer_listenerattr_get_backlog </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">int * </td>
<td class="paramname"><em>backlog</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set/Get the backlog attribute for a GASS transfer attribute set. </p>
<p>This attribute allows the user to control then number of pending connections which may exist for this listener.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>The attribute set to query or modify. </td></tr>
<tr><td class="paramname">backlog</td><td>The number of outstanding connections to allow.</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 attribute was successfully updated. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER</td><td>The <em>attr</em> was GLOBUS_NULL. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaf5f2b57de3e94a93140c47dbc0fff885"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int globus_gass_transfer_listenerattr_get_port </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">unsigned short * </td>
<td class="paramname"><em>port</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set/Get the port attribute for a GASS transfer attribute set. </p>
<p>This attribute allows the user to set the port to be used by a GASS Transfer listener.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>The attribute set to query or modify. </td></tr>
<tr><td class="paramname">port</td><td>The TCP or UDP port number to use.</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 attribute was successfully updated. </td></tr>
<tr><td class="paramname">GLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER</td><td>The <em>attr</em> was GLOBUS_NULL. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<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>
