Sophie

Sophie

distrib > Fedora > 13 > x86_64 > media > updates > by-pkgid > 344b29f38d447785efddb356d82aacfe > files > 25

globus-callout-doc-0.7-8.fc13.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.3 -->
  <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>
    </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__callout__config.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<h1>Callout Configuration</h1>  </div>
</div>
<div class="contents">

<p>Functions for registering callouts.  
<a href="#_details">More...</a></p>
<h2><a name="member-group"></a>
Configure Callouts</h2>
<ul>
<li>globus_result_t <a class="el" href="group__globus__callout__config.html#ga585e14b91769f7ed658dc24a3a4acace">globus_callout_read_config</a> (<a class="el" href="group__globus__callout__handle.html#ga7afe1905f0a00916859e9ff5dc1125ff">globus_callout_handle_t</a> handle, char *filename)
<li>globus_result_t <a class="el" href="group__globus__callout__config.html#gaf220d0e696918c2434746664f5d305b3">globus_callout_register</a> (<a class="el" href="group__globus__callout__handle.html#ga7afe1905f0a00916859e9ff5dc1125ff">globus_callout_handle_t</a> handle, char *type, char *library, char *symbol)
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Functions for registering callouts. </p>
<p>This section defines operations for registering callouts. Callouts may be registered either through a configuration file or through calls to globus_callout_register. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga585e14b91769f7ed658dc24a3a4acace"></a><!-- doxytag: member="globus_callout.c::globus_callout_read_config" ref="ga585e14b91769f7ed658dc24a3a4acace" args="(globus_callout_handle_t handle, char *filename)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">globus_result_t globus_callout_read_config </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__globus__callout__handle.html#ga7afe1905f0a00916859e9ff5dc1125ff">globus_callout_handle_t</a>&#160;</td>
          <td class="paramname"><em>handle</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>filename</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Read callout configuration from file. </p>
<p>This function read a configuration file with the following format:</p>
<ul>
<li>Anything after a '#' is assumed to be a comment</li>
<li>Blanks lines are ignored</li>
<li>Lines specifying callouts have the format abstract type library symbol where "abstract type" denotes the type of callout, e.g. globus_gram_jobmanager_authz, "library" denotes the library the callout can be found in and "symbol" denotes the function name of the callout. The library argument can be specified in two forms, libfoo or libfoo_&lt;flavor&gt;. When using the former version the current flavor will automatically be added to the library name.</li>
</ul>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">handle</td><td>The handle that is to be configured </td></tr>
    <tr><td class="paramname">filename</td><td>The file to read configuration from </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>GLOBUS_SUCCESS A Globus error object on failure: GLOBUS_CALLOUT_ERROR_OPENING_CONF_FILE GLOBUS_CALLOUT_ERROR_PARSING_CONF_FILE GLOBUS_CALLOUT_ERROR_WITH_HASHTABLE GLOBUS_CALLOUT_ERROR_OUT_OF_MEMORY </dd></dl>

</div>
</div>
<a class="anchor" id="gaf220d0e696918c2434746664f5d305b3"></a><!-- doxytag: member="globus_callout.c::globus_callout_register" ref="gaf220d0e696918c2434746664f5d305b3" args="(globus_callout_handle_t handle, char *type, char *library, char *symbol)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">globus_result_t globus_callout_register </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__globus__callout__handle.html#ga7afe1905f0a00916859e9ff5dc1125ff">globus_callout_handle_t</a>&#160;</td>
          <td class="paramname"><em>handle</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>library</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>symbol</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Register callout configurationThis function registers a callout type in the given handle. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">handle</td><td>The handle that is to be configured </td></tr>
    <tr><td class="paramname">type</td><td>The abstract type of the callout </td></tr>
    <tr><td class="paramname">library</td><td>The location of the library containing the callout </td></tr>
    <tr><td class="paramname">symbol</td><td>The symbol (ie function name) for the callout </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>GLOBUS_SUCCESS A Globus error object on failure: GLOBUS_CALLOUT_ERROR_WITH_HASHTABLE GLOBUS_CALLOUT_ERROR_OUT_OF_MEMORY </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>