/usr/share/doc/libglobus-net-manager-dev/html/group__globus__net__manager.html is in libglobus-net-manager-doc 0.16-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 | <!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.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>globus_net_manager: Net Manager</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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">globus_net_manager
 <span id="projectnumber">0.16</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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="#groups">Modules</a> |
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Net Manager</div> </div>
</div><!--header-->
<div class="contents">
<p>Net Manager API.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Net Manager:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group__globus__net__manager.png" border="0" alt="" usemap="#group____globus____net____manager"/>
<map name="group____globus____net____manager" id="group____globus____net____manager">
<area shape="rect" id="node1" href="group__globus__net__manager__context.html" title="Net Manager Context Management Functions. " alt="" coords="212,5,284,32"/>
<area shape="rect" id="node3" href="group__globus__net__manager__attr.html" title="Net Manager Attribute Management Functions. " alt="" coords="205,56,291,83"/>
<area shape="rect" id="node4" href="group__globus__net__manager__signatures.html" title="Net Manager Function SignaturesFunction signatures for the Net Manager interface. Net Manager Impleme..." alt="" coords="174,107,322,133"/>
<area shape="rect" id="node5" href="group__globus__net__manager__python.html" title="Net Manager Python Module. " alt="" coords="190,157,306,184"/>
<area shape="rect" id="node6" href="group__globus__xio__net__manager__driver.html" title="Net Manager XIO Driver. " alt="" coords="159,209,337,250"/>
</map>
</td></tr></table></center>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__globus__net__manager__attr"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__net__manager__attr.html">Attributes</a></td></tr>
<tr class="memdesc:group__globus__net__manager__attr"><td class="mdescLeft"> </td><td class="mdescRight">Net Manager Attribute Management Functions. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__globus__net__manager__context"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__net__manager__context.html">Context</a></td></tr>
<tr class="memdesc:group__globus__net__manager__context"><td class="mdescLeft"> </td><td class="mdescRight">Net Manager Context Management Functions. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__globus__net__manager__signatures"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__net__manager__signatures.html">Function Signatures</a></td></tr>
<tr class="memdesc:group__globus__net__manager__signatures"><td class="mdescLeft"> </td><td class="mdescRight">Net Manager Function SignaturesFunction signatures for the Net Manager interface. <a class="el" href="globus_net_manager_tutorial.html">Net Manager Implementation Tutorial</a>. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__globus__net__manager__python"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__net__manager__python.html">Python Module</a></td></tr>
<tr class="memdesc:group__globus__net__manager__python"><td class="mdescLeft"> </td><td class="mdescRight">Net Manager Python Module. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__globus__xio__net__manager__driver"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__xio__net__manager__driver.html">Globus XIO Net Manager Driver</a></td></tr>
<tr class="memdesc:group__globus__xio__net__manager__driver"><td class="mdescLeft"> </td><td class="mdescRight">Net Manager XIO Driver. <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="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga4c471480390ed9844ebb688d70f63a0f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__net__manager.html#ga4c471480390ed9844ebb688d70f63a0f">GLOBUS_NET_MANAGER_MODULE</a></td></tr>
<tr class="memdesc:ga4c471480390ed9844ebb688d70f63a0f"><td class="mdescLeft"> </td><td class="mdescRight">Module descriptor. <a href="#ga4c471480390ed9844ebb688d70f63a0f">More...</a><br /></td></tr>
<tr class="separator:ga4c471480390ed9844ebb688d70f63a0f"><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:ga4ab58b9b04f13ceaae51c492e4134fa3"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__net__manager.html#ga4ab58b9b04f13ceaae51c492e4134fa3">globus_net_manager_register</a> (<a class="el" href="group__globus__net__manager__types.html#ga134d47fcac532417854ec9e65433f251">globus_net_manager_t</a> *manager, globus_module_descriptor_t *module)</td></tr>
<tr class="memdesc:ga4ab58b9b04f13ceaae51c492e4134fa3"><td class="mdescLeft"> </td><td class="mdescRight">Register a network manager. <a href="#ga4ab58b9b04f13ceaae51c492e4134fa3">More...</a><br /></td></tr>
<tr class="separator:ga4ab58b9b04f13ceaae51c492e4134fa3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga104686c95eb6ee3aa5a3d73fe4007c52"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__net__manager.html#ga104686c95eb6ee3aa5a3d73fe4007c52">globus_net_manager_unregister</a> (<a class="el" href="group__globus__net__manager__types.html#ga134d47fcac532417854ec9e65433f251">globus_net_manager_t</a> *manager)</td></tr>
<tr class="memdesc:ga104686c95eb6ee3aa5a3d73fe4007c52"><td class="mdescLeft"> </td><td class="mdescRight">Unregister a network manager. <a href="#ga104686c95eb6ee3aa5a3d73fe4007c52">More...</a><br /></td></tr>
<tr class="separator:ga104686c95eb6ee3aa5a3d73fe4007c52"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Net Manager API. </p>
<p>This API defines the plug-in points for network manager functionality, as well as functions for registering a particular network manager implementation so that it can be invoked during network events.</p>
<p>To implement a network manager, define a struct <a class="el" href="structglobus__net__manager__s.html" title="Net Manager Definition. ">globus_net_manager_s</a> with the functions you want called, and register it by calling <a class="el" href="group__globus__net__manager.html#ga4ab58b9b04f13ceaae51c492e4134fa3" title="Register a network manager. ">globus_net_manager_register()</a>. More details are included in <a class="el" href="globus_net_manager_tutorial.html">Net Manager Implementation Tutorial</a> </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga4c471480390ed9844ebb688d70f63a0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4c471480390ed9844ebb688d70f63a0f">§ </a></span>GLOBUS_NET_MANAGER_MODULE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GLOBUS_NET_MANAGER_MODULE</td>
</tr>
</table>
</div><div class="memdoc">
<p>Module descriptor. </p>
<p>The Globus Net Manager uses Globus Toolkit module activation and deactivation. Before any Net Manager functions can be called, the module must be activated, like this: </p><div class="fragment"><div class="line">globus_module_activate(<a class="code" href="group__globus__net__manager.html#ga4c471480390ed9844ebb688d70f63a0f">GLOBUS_NET_MANAGER_MODULE</a>);</div></div><!-- fragment --><p>This function returns GLOBUS_SUCCESS if the library is successfully initialized. Otherwise, an error code is returned, and Net Manager functions should not be subsequently called.</p>
<p>Activations are reference counted, so it is safe to activate the module multiple times or in different modules.</p>
<p>To deactivate Net Manager, call</p>
<div class="fragment"><div class="line">globus_module_deactivate(<a class="code" href="group__globus__net__manager.html#ga4c471480390ed9844ebb688d70f63a0f">GLOBUS_NET_MANAGER_MODULE</a>);</div></div><!-- fragment --><p>This function should be done once for each time the Net Manager was activated. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga4ab58b9b04f13ceaae51c492e4134fa3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4ab58b9b04f13ceaae51c492e4134fa3">§ </a></span>globus_net_manager_register()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_net_manager_register </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__net__manager__types.html#ga134d47fcac532417854ec9e65433f251">globus_net_manager_t</a> * </td>
<td class="paramname"><em>manager</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_module_descriptor_t * </td>
<td class="paramname"><em>module</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Register a network manager. </p>
<p>The <a class="el" href="group__globus__net__manager.html#ga4ab58b9b04f13ceaae51c492e4134fa3" title="Register a network manager. ">globus_net_manager_register()</a> function adds this network manager to those which will be called by the network manager interface when network events occur. This is typically called by the network manager when its module is activated. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">manager</td><td>Manager information to register. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">module</td><td>Module descriptor to register. Use GlobusExtensionMyModule(module name) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga104686c95eb6ee3aa5a3d73fe4007c52"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga104686c95eb6ee3aa5a3d73fe4007c52">§ </a></span>globus_net_manager_unregister()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_net_manager_unregister </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__net__manager__types.html#ga134d47fcac532417854ec9e65433f251">globus_net_manager_t</a> * </td>
<td class="paramname"><em>manager</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unregister a network manager. </p>
<p>The <a class="el" href="group__globus__net__manager.html#ga104686c95eb6ee3aa5a3d73fe4007c52" title="Unregister a network manager. ">globus_net_manager_unregister()</a> function removes this network manager from those which will be called by the network manager interface when network events occur. This is typically called by the network manager when its module is deactivated. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">manager</td><td>Manager information to unregister. </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.12
</small></address>
</body>
</html>
|