<!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"/>
<title>libnl: Controller</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libnl <span id="projectnumber">1.1</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<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>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>Controller</h1> </div>
<div class="ingroups"><a class="el" href="group__genl__mngt.html">Management</a></div></div>
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ctrl.html#ga765fbbec4a11e318a286f743da89ff47">genl_ctrl_resolve</a> (struct nl_handle *handle, const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resolve generic netlink family name to its identifier. <a href="#ga765fbbec4a11e318a286f743da89ff47"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="member-group"></a>
Cache Management</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae1b473c860b87771bb33200b3d2b1e68"></a><!-- doxytag: member="ctrl::genl_ctrl_alloc_cache" ref="gae1b473c860b87771bb33200b3d2b1e68" args="(struct nl_handle *handle)" -->
struct nl_cache * </td><td class="memItemRight" valign="bottom"><b>genl_ctrl_alloc_cache</b> (struct nl_handle *handle)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct genl_family * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ctrl.html#ga0b2f0bb288b9e0f4ad3159a5db881e27">genl_ctrl_search</a> (struct nl_cache *cache, int id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Look up generic netlink family by id in the provided cache. <a href="#ga0b2f0bb288b9e0f4ad3159a5db881e27"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="member-group"></a>
Resolver</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct genl_family * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ctrl.html#ga8546fd167091c03774f530bc56e8e544">genl_ctrl_search_by_name</a> (struct nl_cache *cache, const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Look up generic netlink family by family name in the provided cache. <a href="#ga8546fd167091c03774f530bc56e8e544"></a><br/></td></tr>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga0b2f0bb288b9e0f4ad3159a5db881e27"></a><!-- doxytag: member="ctrl.c::genl_ctrl_search" ref="ga0b2f0bb288b9e0f4ad3159a5db881e27" args="(struct nl_cache *cache, int id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct genl_family* genl_ctrl_search </td>
<td>(</td>
<td class="paramtype">struct nl_cache * </td>
<td class="paramname"><em>cache</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">cache</td><td>Generic netlink family cache. </td></tr>
<tr><td class="paramname">id</td><td>Family identifier.</td></tr>
</table>
</dd>
</dl>
<p>Searches through the cache looking for a registered family matching the specified identifier. The caller will own a reference on the returned object which needs to be given back after usage using genl_family_put().</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Generic netlink family object or NULL if no match was found. </dd></dl>
<p>Definition at line <a class="el" href="ctrl_8c_source.html#l00174">174</a> of file <a class="el" href="ctrl_8c_source.html">ctrl.c</a>.</p>
<p>References <a class="el" href="object_8c_source.html#l00162">nl_object_get()</a>.</p>
<div class="fragment"><pre class="fragment">{
<span class="keyword">struct </span>genl_family *fam;
<span class="keywordflow">if</span> (cache->c_ops != &genl_ctrl_ops)
BUG();
nl_list_for_each_entry(fam, &cache->c_items, ce_list) {
<span class="keywordflow">if</span> (fam->gf_id == <span class="keywordtype">id</span>) {
<a class="code" href="group__object.html#gabd5767ac47ec6f09d1ac643f44eb8bfd" title="Acquire a reference on a object.">nl_object_get</a>((<span class="keyword">struct</span> nl_object *) fam);
<span class="keywordflow">return</span> fam;
}
}
<span class="keywordflow">return</span> NULL;
}
</pre></div>
</div>
</div>
<a class="anchor" id="ga8546fd167091c03774f530bc56e8e544"></a><!-- doxytag: member="ctrl.c::genl_ctrl_search_by_name" ref="ga8546fd167091c03774f530bc56e8e544" args="(struct nl_cache *cache, const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct genl_family* genl_ctrl_search_by_name </td>
<td>(</td>
<td class="paramtype">struct nl_cache * </td>
<td class="paramname"><em>cache</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">cache</td><td>Generic netlink family cache. </td></tr>
<tr><td class="paramname">name</td><td>Family name.</td></tr>
</table>
</dd>
</dl>
<p>Searches through the cache looking for a registered family matching the specified name. The caller will own a reference on the returned object which needs to be given back after usage using genl_family_put().</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Generic netlink family object or NULL if no match was found. </dd></dl>
<p>Definition at line <a class="el" href="ctrl_8c_source.html#l00208">208</a> of file <a class="el" href="ctrl_8c_source.html">ctrl.c</a>.</p>
<p>References <a class="el" href="object_8c_source.html#l00162">nl_object_get()</a>.</p>
<p>Referenced by <a class="el" href="ctrl_8c_source.html#l00238">genl_ctrl_resolve()</a>.</p>
<div class="fragment"><pre class="fragment">{
<span class="keyword">struct </span>genl_family *fam;
<span class="keywordflow">if</span> (cache->c_ops != &genl_ctrl_ops)
BUG();
nl_list_for_each_entry(fam, &cache->c_items, ce_list) {
<span class="keywordflow">if</span> (!strcmp(name, fam->gf_name)) {
<a class="code" href="group__object.html#gabd5767ac47ec6f09d1ac643f44eb8bfd" title="Acquire a reference on a object.">nl_object_get</a>((<span class="keyword">struct</span> nl_object *) fam);
<span class="keywordflow">return</span> fam;
}
}
<span class="keywordflow">return</span> NULL;
}
</pre></div>
</div>
</div>
<a class="anchor" id="ga765fbbec4a11e318a286f743da89ff47"></a><!-- doxytag: member="ctrl.c::genl_ctrl_resolve" ref="ga765fbbec4a11e318a286f743da89ff47" args="(struct nl_handle *handle, const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int genl_ctrl_resolve </td>
<td>(</td>
<td class="paramtype">struct nl_handle * </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>Netlink Handle </td></tr>
<tr><td class="paramname">name</td><td>Name of generic netlink family</td></tr>
</table>
</dd>
</dl>
<p>Resolves the generic netlink family name to its identifer and returns it.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A positive identifier or a negative error code. </dd></dl>
<p>Definition at line <a class="el" href="ctrl_8c_source.html#l00238">238</a> of file <a class="el" href="ctrl_8c_source.html">ctrl.c</a>.</p>
<p>References <a class="el" href="ctrl_8c_source.html#l00208">genl_ctrl_search_by_name()</a>, and <a class="el" href="cache_8c_source.html#l00265">nl_cache_free()</a>.</p>
<div class="fragment"><pre class="fragment">{
<span class="keyword">struct </span>nl_cache *cache;
<span class="keyword">struct </span>genl_family *family;
<span class="keywordtype">int</span> err;
cache = genl_ctrl_alloc_cache(handle);
<span class="keywordflow">if</span> (cache == NULL)
<span class="keywordflow">return</span> nl_get_errno();
family = <a class="code" href="group__ctrl.html#ga8546fd167091c03774f530bc56e8e544" title="Look up generic netlink family by family name in the provided cache.">genl_ctrl_search_by_name</a>(cache, name);
<span class="keywordflow">if</span> (family == NULL) {
err = nl_error(ENOENT, <span class="stringliteral">"Generic Netlink Family not found"</span>);
<span class="keywordflow">goto</span> errout;
}
err = genl_family_get_id(family);
genl_family_put(family);
errout:
<a class="code" href="group__cache.html#ga530c896db26d72001d011114b1e6cfaa" title="Free a cache.">nl_cache_free</a>(cache);
<span class="keywordflow">return</span> err;
}
</pre></div>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon Mar 21 2011 for libnl by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
