<!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: Queueing Discipline Object</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="#var-members">Variables</a> </div> <div class="headertitle"> <h1>Queueing Discipline Object</h1> </div> <div class="ingroups"><a class="el" href="group__qdisc.html">Queueing Disciplines</a></div></div> <div class="contents"> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="var-members"></a> Variables</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structnl__object__ops.html">nl_object_ops</a> </td><td class="memItemRight" valign="bottom"><b>qdisc_obj_ops</b></td></tr> <tr><td colspan="2"><h2><a name="member-group"></a> Allocation/Freeing</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9548f3a10b16f2578be978d1f4ca5b4e"></a><!-- doxytag: member="qdisc_obj::rtnl_qdisc_alloc" ref="ga9548f3a10b16f2578be978d1f4ca5b4e" args="(void)" --> struct rtnl_qdisc * </td><td class="memItemRight" valign="bottom"><b>rtnl_qdisc_alloc</b> (void)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab83674b41a6cdf0da92a979cf1c41423"></a><!-- doxytag: member="qdisc_obj::rtnl_qdisc_put" ref="gab83674b41a6cdf0da92a979cf1c41423" args="(struct rtnl_qdisc *qdisc)" --> void </td><td class="memItemRight" valign="bottom"><b>rtnl_qdisc_put</b> (struct rtnl_qdisc *qdisc)</td></tr> <tr><td colspan="2"><h2><a name="member-group"></a> Iterators</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__qdisc__obj.html#gaebc332de0ca7b5e29d8abca8c0e7d423">rtnl_qdisc_foreach_child</a> (struct rtnl_qdisc *qdisc, struct nl_cache *cache, void(*cb)(struct nl_object *, void *), void *arg)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Call a callback for each child class of a qdisc. <a href="#gaebc332de0ca7b5e29d8abca8c0e7d423"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__qdisc__obj.html#ga9ded3466096903496a5f050d50681f27">rtnl_qdisc_foreach_cls</a> (struct rtnl_qdisc *qdisc, struct nl_cache *cache, void(*cb)(struct nl_object *, void *), void *arg)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Call a callback for each filter attached to the qdisc. <a href="#ga9ded3466096903496a5f050d50681f27"></a><br/></td></tr> <tr><td colspan="2"><h2><a name="member-group"></a> Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7278e9fe15d9596b8af9868043fd9ae1"></a><!-- doxytag: member="qdisc_obj::rtnl_qdisc_set_ifindex" ref="ga7278e9fe15d9596b8af9868043fd9ae1" args="(struct rtnl_qdisc *qdisc, int ifindex)" --> void </td><td class="memItemRight" valign="bottom"><b>rtnl_qdisc_set_ifindex</b> (struct rtnl_qdisc *qdisc, int ifindex)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2007fd2935abf5221d70ecf6184e69f6"></a><!-- doxytag: member="qdisc_obj::rtnl_qdisc_get_ifindex" ref="ga2007fd2935abf5221d70ecf6184e69f6" args="(struct rtnl_qdisc *qdisc)" --> int </td><td class="memItemRight" valign="bottom"><b>rtnl_qdisc_get_ifindex</b> (struct rtnl_qdisc *qdisc)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7761a28cf0f7da2f2db24ac7e661d9d4"></a><!-- doxytag: member="qdisc_obj::rtnl_qdisc_set_handle" ref="ga7761a28cf0f7da2f2db24ac7e661d9d4" args="(struct rtnl_qdisc *qdisc, uint32_t handle)" --> void </td><td class="memItemRight" valign="bottom"><b>rtnl_qdisc_set_handle</b> (struct rtnl_qdisc *qdisc, uint32_t handle)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2271020bfd2ccb5f00e58fb2a9780793"></a><!-- doxytag: member="qdisc_obj::rtnl_qdisc_get_handle" ref="ga2271020bfd2ccb5f00e58fb2a9780793" args="(struct rtnl_qdisc *qdisc)" --> uint32_t </td><td class="memItemRight" valign="bottom"><b>rtnl_qdisc_get_handle</b> (struct rtnl_qdisc *qdisc)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5f6f535ed203c36cb65baf0dc8d57892"></a><!-- doxytag: member="qdisc_obj::rtnl_qdisc_set_parent" ref="ga5f6f535ed203c36cb65baf0dc8d57892" args="(struct rtnl_qdisc *qdisc, uint32_t parent)" --> void </td><td class="memItemRight" valign="bottom"><b>rtnl_qdisc_set_parent</b> (struct rtnl_qdisc *qdisc, uint32_t parent)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae4bb20c89170bd8df592362b758bc280"></a><!-- doxytag: member="qdisc_obj::rtnl_qdisc_get_parent" ref="gae4bb20c89170bd8df592362b758bc280" args="(struct rtnl_qdisc *qdisc)" --> uint32_t </td><td class="memItemRight" valign="bottom"><b>rtnl_qdisc_get_parent</b> (struct rtnl_qdisc *qdisc)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa12ba5f0716b794c9fb4159e8056d067"></a><!-- doxytag: member="qdisc_obj::rtnl_qdisc_set_kind" ref="gaa12ba5f0716b794c9fb4159e8056d067" args="(struct rtnl_qdisc *qdisc, const char *name)" --> void </td><td class="memItemRight" valign="bottom"><b>rtnl_qdisc_set_kind</b> (struct rtnl_qdisc *qdisc, const char *name)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga42befba9a6caa36dda656bff04052660"></a><!-- doxytag: member="qdisc_obj::rtnl_qdisc_get_kind" ref="ga42befba9a6caa36dda656bff04052660" args="(struct rtnl_qdisc *qdisc)" --> char * </td><td class="memItemRight" valign="bottom"><b>rtnl_qdisc_get_kind</b> (struct rtnl_qdisc *qdisc)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf7d516e9aa7e8b058c66f9b3b577dffe"></a><!-- doxytag: member="qdisc_obj::rtnl_qdisc_get_stat" ref="gaf7d516e9aa7e8b058c66f9b3b577dffe" args="(struct rtnl_qdisc *qdisc, enum rtnl_tc_stats_id id)" --> uint64_t </td><td class="memItemRight" valign="bottom"><b>rtnl_qdisc_get_stat</b> (struct rtnl_qdisc *qdisc, enum <a class="el" href="group__tc.html#ga7f00b06ddcf7c64d3f159214d0d976c0">rtnl_tc_stats_id</a> id)</td></tr> <tr><td colspan="2"><h2><a name="member-group"></a> Qdisc Specific Options</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct nl_msg * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__qdisc__obj.html#ga285bdf02201ae62be6d77837de1ad1e4">rtnl_qdisc_get_opts</a> (struct rtnl_qdisc *qdisc)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return qdisc specific options for use in TCA_OPTIONS. <a href="#ga285bdf02201ae62be6d77837de1ad1e4"></a><br/></td></tr> </table> <hr/><h2>Function Documentation</h2> <a class="anchor" id="gaebc332de0ca7b5e29d8abca8c0e7d423"></a><!-- doxytag: member="qdisc_obj.c::rtnl_qdisc_foreach_child" ref="gaebc332de0ca7b5e29d8abca8c0e7d423" args="(struct rtnl_qdisc *qdisc, struct nl_cache *cache, void(*cb)(struct nl_object *, void *), void *arg)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void rtnl_qdisc_foreach_child </td> <td>(</td> <td class="paramtype">struct rtnl_qdisc * </td> <td class="paramname"><em>qdisc</em>, </td> </tr> <tr> <td class="paramkey"></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">void(*)(struct nl_object *, void *) </td> <td class="paramname"><em>cb</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">void * </td> <td class="paramname"><em>arg</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">qdisc</td><td>the parent qdisc </td></tr> <tr><td class="paramname">cache</td><td>a class cache including all classes of the interface the specified qdisc is attached to </td></tr> <tr><td class="paramname">cb</td><td>callback function </td></tr> <tr><td class="paramname">arg</td><td>argument to be passed to callback function </td></tr> </table> </dd> </dl> <p>Definition at line <a class="el" href="qdisc__obj_8c_source.html#l00139">139</a> of file <a class="el" href="qdisc__obj_8c_source.html">qdisc_obj.c</a>.</p> <p>References <a class="el" href="cache_8c_source.html#l00790">nl_cache_foreach_filter()</a>.</p> <div class="fragment"><pre class="fragment">{ <span class="keyword">struct </span>rtnl_class *filter; filter = rtnl_class_alloc(); <span class="keywordflow">if</span> (!filter) <span class="keywordflow">return</span>; rtnl_class_set_parent(filter, qdisc->q_handle); rtnl_class_set_ifindex(filter, qdisc->q_ifindex); rtnl_class_set_kind(filter, qdisc->q_kind); <a class="code" href="group__cache.html#ga5f0cc9367329f85137b2191c2889d41c" title="Call a callback on each element of the cache (filtered).">nl_cache_foreach_filter</a>(cache, (<span class="keyword">struct</span> nl_object *) filter, cb, arg); rtnl_class_put(filter); } </pre></div> </div> </div> <a class="anchor" id="ga9ded3466096903496a5f050d50681f27"></a><!-- doxytag: member="qdisc_obj.c::rtnl_qdisc_foreach_cls" ref="ga9ded3466096903496a5f050d50681f27" args="(struct rtnl_qdisc *qdisc, struct nl_cache *cache, void(*cb)(struct nl_object *, void *), void *arg)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void rtnl_qdisc_foreach_cls </td> <td>(</td> <td class="paramtype">struct rtnl_qdisc * </td> <td class="paramname"><em>qdisc</em>, </td> </tr> <tr> <td class="paramkey"></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">void(*)(struct nl_object *, void *) </td> <td class="paramname"><em>cb</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">void * </td> <td class="paramname"><em>arg</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">qdisc</td><td>the parent qdisc </td></tr> <tr><td class="paramname">cache</td><td>a filter cache including at least all the filters attached to the specified qdisc </td></tr> <tr><td class="paramname">cb</td><td>callback function </td></tr> <tr><td class="paramname">arg</td><td>argument to be passed to callback function </td></tr> </table> </dd> </dl> <p>Definition at line <a class="el" href="qdisc__obj_8c_source.html#l00165">165</a> of file <a class="el" href="qdisc__obj_8c_source.html">qdisc_obj.c</a>.</p> <p>References <a class="el" href="cache_8c_source.html#l00790">nl_cache_foreach_filter()</a>.</p> <div class="fragment"><pre class="fragment">{ <span class="keyword">struct </span>rtnl_cls *filter; filter = rtnl_cls_alloc(); <span class="keywordflow">if</span> (!filter) <span class="keywordflow">return</span>; rtnl_cls_set_ifindex(filter, qdisc->q_ifindex); rtnl_cls_set_parent(filter, qdisc->q_parent); <a class="code" href="group__cache.html#ga5f0cc9367329f85137b2191c2889d41c" title="Call a callback on each element of the cache (filtered).">nl_cache_foreach_filter</a>(cache, (<span class="keyword">struct</span> nl_object *) filter, cb, arg); rtnl_cls_put(filter); } </pre></div> </div> </div> <a class="anchor" id="ga285bdf02201ae62be6d77837de1ad1e4"></a><!-- doxytag: member="qdisc_obj.c::rtnl_qdisc_get_opts" ref="ga285bdf02201ae62be6d77837de1ad1e4" args="(struct rtnl_qdisc *qdisc)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">struct nl_msg* rtnl_qdisc_get_opts </td> <td>(</td> <td class="paramtype">struct rtnl_qdisc * </td> <td class="paramname"><em>qdisc</em></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">qdisc</td><td>qdisc carrying the optiosn</td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>new headerless netlink message carrying the options as payload </dd></dl> <p>Definition at line <a class="el" href="qdisc__obj_8c_source.html#l00248">248</a> of file <a class="el" href="qdisc__obj_8c_source.html">qdisc_obj.c</a>.</p> <p>References <a class="el" href="qdisc-modules_8h_source.html#l00041">rtnl_qdisc_ops::qo_get_opts</a>.</p> <div class="fragment"><pre class="fragment">{ <span class="keyword">struct </span><a class="code" href="structrtnl__qdisc__ops.html" title="Qdisc Operations.">rtnl_qdisc_ops</a> *ops; ops = rtnl_qdisc_lookup_ops(qdisc); <span class="keywordflow">if</span> (ops && ops-><a class="code" href="structrtnl__qdisc__ops.html#a2b2fb4f82322e8e98729de80992da852" title="Must return the contents supposed to be in TCA_OPTIONS.">qo_get_opts</a>) <span class="keywordflow">return</span> ops-><a class="code" href="structrtnl__qdisc__ops.html#a2b2fb4f82322e8e98729de80992da852" title="Must return the contents supposed to be in TCA_OPTIONS.">qo_get_opts</a>(qdisc); <span class="keywordflow">return</span> NULL; } </pre></div> </div> </div> <hr/><h2>Variable Documentation</h2> <a class="anchor" id="ga9e17b79656857965b7583a9480f2b32b"></a><!-- doxytag: member="qdisc_obj.c::qdisc_obj_ops" ref="ga9e17b79656857965b7583a9480f2b32b" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">struct <a class="el" href="structnl__object__ops.html">nl_object_ops</a> qdisc_obj_ops</td> </tr> </table> </div> <div class="memdoc"> <b>Initial value:</b><div class="fragment"><pre class="fragment"> { .oo_name = <span class="stringliteral">"route/qdisc"</span>, .oo_size = <span class="keyword">sizeof</span>(<span class="keyword">struct </span>rtnl_qdisc), .oo_free_data = qdisc_free_data, .oo_clone = qdisc_clone, .oo_dump[<a class="code" href="group__utils.html#ggacfb5566c73f0965c5241d7d49bc717e9a5597887c080d5ecae358b6065a4048fd" title="Dump object in a brief one-liner.">NL_DUMP_BRIEF</a>] = qdisc_dump_brief, .oo_dump[<a class="code" href="group__utils.html#ggacfb5566c73f0965c5241d7d49bc717e9a1445106c7af529b2c99ee289fbcd3179" title="Dump all attributes but no statistics.">NL_DUMP_FULL</a>] = qdisc_dump_full, .oo_dump[<a class="code" href="group__utils.html#ggacfb5566c73f0965c5241d7d49bc717e9a8ebedc55094df6175b84fb1230047a65" title="Dump all attributes including statistics.">NL_DUMP_STATS</a>] = qdisc_dump_stats, .oo_compare = tca_compare, .oo_id_attrs = (TCA_ATTR_IFINDEX | TCA_ATTR_HANDLE), } </pre></div> <p>Definition at line <a class="el" href="qdisc__obj_8c_source.html#l00261">261</a> of file <a class="el" href="qdisc__obj_8c_source.html">qdisc_obj.c</a>.</p> </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>