Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > f1b8c4ee1e4f6c51ccb1e91613ba4ca5 > files > 30

globus-gass-transfer-doc-7.2-1.fc15.noarch.rpm

<!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&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('group__globus__gass__transfer__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>
<div class="contents">
<h2><a name="func-members"></a>
Functions</h2>
<ul>
<li>int <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)
</ul>
<h2><a name="member-group"></a>
Listener Backlog</h2>
<ul>
<li>int <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)
<li>int <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)
</ul>
<h2><a name="member-group"></a>
Listener Port</h2>
<ul>
<li>int <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)
<li>int <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)
</ul>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gaa07336fe642b03fbe9a1aa7ade9ac159"></a><!-- doxytag: member="globus_gass_transfer_attribute.c::globus_gass_transfer_listenerattr_init" ref="gaa07336fe642b03fbe9a1aa7ade9ac159" args="(globus_gass_transfer_listenerattr_t *attr, char *url_scheme)" -->
<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 *&#160;</td>
          <td class="paramname"><em>attr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>url_scheme</em>&#160;</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><dt><b>Parameters:</b></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><dt><b>Return values:</b></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>

</div>
</div>
<a class="anchor" id="ga4aca10b7756d3233a76277eab3e0cf42"></a><!-- doxytag: member="globus_gass_transfer_attribute.c::globus_gass_transfer_listenerattr_set_backlog" ref="ga4aca10b7756d3233a76277eab3e0cf42" args="(globus_gass_transfer_listenerattr_t *attr, int backlog)" -->
<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 *&#160;</td>
          <td class="paramname"><em>attr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>backlog</em>&#160;</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><dt><b>Parameters:</b></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><dt><b>Return values:</b></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><!-- doxytag: member="globus_gass_transfer_attribute.c::globus_gass_transfer_listenerattr_set_port" ref="ga14be85aace2db3fb900d04a312170168" args="(globus_gass_transfer_listenerattr_t *attr, unsigned short port)" -->
<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 *&#160;</td>
          <td class="paramname"><em>attr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned short&#160;</td>
          <td class="paramname"><em>port</em>&#160;</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><dt><b>Parameters:</b></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><dt><b>Return values:</b></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><!-- doxytag: member="globus_gass_transfer_attribute.c::globus_gass_transfer_listenerattr_get_backlog" ref="gae38d0d02316beef7c1bbc3080e6e9192" args="(globus_gass_transfer_listenerattr_t *attr, int *backlog)" -->
<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 *&#160;</td>
          <td class="paramname"><em>attr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int *&#160;</td>
          <td class="paramname"><em>backlog</em>&#160;</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><dt><b>Parameters:</b></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><dt><b>Return values:</b></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><!-- doxytag: member="globus_gass_transfer_attribute.c::globus_gass_transfer_listenerattr_get_port" ref="gaf5f2b57de3e94a93140c47dbc0fff885" args="(globus_gass_transfer_listenerattr_t *attr, unsigned short *port)" -->
<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 *&#160;</td>
          <td class="paramname"><em>attr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned short *&#160;</td>
          <td class="paramname"><em>port</em>&#160;</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><dt><b>Parameters:</b></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><dt><b>Return values:</b></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>
</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>