<!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: Stochastic Fairness Queueing (SFQ)</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="headertitle">
<h1>Stochastic Fairness Queueing (SFQ)</h1> </div>
<div class="ingroups"><a class="el" href="group__qdisc__api.html">Queueing Discipline Modules</a></div></div>
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="member-group"></a>
Attribute Access</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sfq.html#ga034215d21bcb9f05b6b80d64ef12885f">rtnl_sfq_set_quantum</a> (struct rtnl_qdisc *qdisc, int quantum)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set quantum of SFQ qdisc. <a href="#ga034215d21bcb9f05b6b80d64ef12885f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sfq.html#ga27047a6e57071b3abb35e654e25091d1">rtnl_sfq_get_quantum</a> (struct rtnl_qdisc *qdisc)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get quantum of SFQ qdisc. <a href="#ga27047a6e57071b3abb35e654e25091d1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sfq.html#gafdf7cd6a80e2c8abd43e9f524be0f3ea">rtnl_sfq_set_limit</a> (struct rtnl_qdisc *qdisc, int limit)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set limit of SFQ qdisc. <a href="#gafdf7cd6a80e2c8abd43e9f524be0f3ea"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sfq.html#gacacbff614291ea8fc35ffddb2f68351f">rtnl_sfq_get_limit</a> (struct rtnl_qdisc *qdisc)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get limit of SFQ qdisc. <a href="#gacacbff614291ea8fc35ffddb2f68351f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sfq.html#ga8b86cde41ece1a5ce8c8df129411e382">rtnl_sfq_set_perturb</a> (struct rtnl_qdisc *qdisc, int perturb)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set perturbation interval of SFQ qdisc. <a href="#ga8b86cde41ece1a5ce8c8df129411e382"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sfq.html#ga876d1c7691139e98e73943275515dba0">rtnl_sfq_get_perturb</a> (struct rtnl_qdisc *qdisc)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get perturbation interval of SFQ qdisc. <a href="#ga876d1c7691139e98e73943275515dba0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sfq.html#ga673ca724807fae25093b168181226449">rtnl_sfq_get_divisor</a> (struct rtnl_qdisc *qdisc)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get divisor of SFQ qdisc. <a href="#ga673ca724807fae25093b168181226449"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<dl class="user"><dt><b>Parameter Description</b></dt><dd><ul>
<li><b>Quantum:</b> Number of bytes to send out per slot and round.</li>
<li><b>Perturbation:</b> Timer period between changing the hash function.</li>
<li><b>Limit:</b> Upper limit of queue in number of packets before SFQ starts dropping packets.</li>
<li><b>Divisor:</b> Hash table divisor, i.e. size of hash table. </li>
</ul>
</dd></dl>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga034215d21bcb9f05b6b80d64ef12885f"></a><!-- doxytag: member="sfq.c::rtnl_sfq_set_quantum" ref="ga034215d21bcb9f05b6b80d64ef12885f" args="(struct rtnl_qdisc *qdisc, int quantum)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtnl_sfq_set_quantum </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">int </td>
<td class="paramname"><em>quantum</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>SFQ qdisc to be modified. </td></tr>
<tr><td class="paramname">quantum</td><td>New quantum in bytes. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success or a negative error code. </dd></dl>
<p>Definition at line <a class="el" href="sfq_8c_source.html#l00154">154</a> of file <a class="el" href="sfq_8c_source.html">sfq.c</a>.</p>
<div class="fragment"><pre class="fragment">{
<span class="keyword">struct </span>rtnl_sfq *sfq;
sfq = sfq_alloc(qdisc);
<span class="keywordflow">if</span> (!sfq)
<span class="keywordflow">return</span> nl_errno(ENOMEM);
sfq->qs_quantum = quantum;
sfq->qs_mask |= SCH_SFQ_ATTR_QUANTUM;
<span class="keywordflow">return</span> 0;
}
</pre></div>
</div>
</div>
<a class="anchor" id="ga27047a6e57071b3abb35e654e25091d1"></a><!-- doxytag: member="sfq.c::rtnl_sfq_get_quantum" ref="ga27047a6e57071b3abb35e654e25091d1" args="(struct rtnl_qdisc *qdisc)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtnl_sfq_get_quantum </td>
<td>(</td>
<td class="paramtype">struct rtnl_qdisc * </td>
<td class="paramname"><em>qdisc</em></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>SFQ qdisc. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Quantum in bytes or a negative error code. </dd></dl>
<p>Definition at line <a class="el" href="sfq_8c_source.html#l00173">173</a> of file <a class="el" href="sfq_8c_source.html">sfq.c</a>.</p>
<div class="fragment"><pre class="fragment">{
<span class="keyword">struct </span>rtnl_sfq *sfq;
sfq = sfq_qdisc(qdisc);
<span class="keywordflow">if</span> (sfq && sfq->qs_mask & SCH_SFQ_ATTR_QUANTUM)
<span class="keywordflow">return</span> sfq->qs_quantum;
<span class="keywordflow">else</span>
<span class="keywordflow">return</span> nl_errno(ENOENT);
}
</pre></div>
</div>
</div>
<a class="anchor" id="gafdf7cd6a80e2c8abd43e9f524be0f3ea"></a><!-- doxytag: member="sfq.c::rtnl_sfq_set_limit" ref="gafdf7cd6a80e2c8abd43e9f524be0f3ea" args="(struct rtnl_qdisc *qdisc, int limit)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtnl_sfq_set_limit </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">int </td>
<td class="paramname"><em>limit</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>SFQ qdisc to be modified. </td></tr>
<tr><td class="paramname">limit</td><td>New limit in number of packets. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success or a negative error code. </dd></dl>
<p>Definition at line <a class="el" href="sfq_8c_source.html#l00190">190</a> of file <a class="el" href="sfq_8c_source.html">sfq.c</a>.</p>
<div class="fragment"><pre class="fragment">{
<span class="keyword">struct </span>rtnl_sfq *sfq;
sfq = sfq_alloc(qdisc);
<span class="keywordflow">if</span> (!sfq)
<span class="keywordflow">return</span> nl_errno(ENOMEM);
sfq->qs_limit = limit;
sfq->qs_mask |= SCH_SFQ_ATTR_LIMIT;
<span class="keywordflow">return</span> 0;
}
</pre></div>
</div>
</div>
<a class="anchor" id="gacacbff614291ea8fc35ffddb2f68351f"></a><!-- doxytag: member="sfq.c::rtnl_sfq_get_limit" ref="gacacbff614291ea8fc35ffddb2f68351f" args="(struct rtnl_qdisc *qdisc)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtnl_sfq_get_limit </td>
<td>(</td>
<td class="paramtype">struct rtnl_qdisc * </td>
<td class="paramname"><em>qdisc</em></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>SFQ qdisc. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Limit or a negative error code. </dd></dl>
<p>Definition at line <a class="el" href="sfq_8c_source.html#l00209">209</a> of file <a class="el" href="sfq_8c_source.html">sfq.c</a>.</p>
<div class="fragment"><pre class="fragment">{
<span class="keyword">struct </span>rtnl_sfq *sfq;
sfq = sfq_qdisc(qdisc);
<span class="keywordflow">if</span> (sfq && sfq->qs_mask & SCH_SFQ_ATTR_LIMIT)
<span class="keywordflow">return</span> sfq->qs_limit;
<span class="keywordflow">else</span>
<span class="keywordflow">return</span> nl_errno(ENOENT);
}
</pre></div>
</div>
</div>
<a class="anchor" id="ga8b86cde41ece1a5ce8c8df129411e382"></a><!-- doxytag: member="sfq.c::rtnl_sfq_set_perturb" ref="ga8b86cde41ece1a5ce8c8df129411e382" args="(struct rtnl_qdisc *qdisc, int perturb)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtnl_sfq_set_perturb </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">int </td>
<td class="paramname"><em>perturb</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>SFQ qdisc to be modified. </td></tr>
<tr><td class="paramname">perturb</td><td>New perturbation interval in seconds. </td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>A value of 0 disables perturbation altogether. </dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success or a negative error code. </dd></dl>
<p>Definition at line <a class="el" href="sfq_8c_source.html#l00227">227</a> of file <a class="el" href="sfq_8c_source.html">sfq.c</a>.</p>
<div class="fragment"><pre class="fragment">{
<span class="keyword">struct </span>rtnl_sfq *sfq;
sfq = sfq_alloc(qdisc);
<span class="keywordflow">if</span> (!sfq)
<span class="keywordflow">return</span> nl_errno(ENOMEM);
sfq->qs_perturb = perturb;
sfq->qs_mask |= SCH_SFQ_ATTR_PERTURB;
<span class="keywordflow">return</span> 0;
}
</pre></div>
</div>
</div>
<a class="anchor" id="ga876d1c7691139e98e73943275515dba0"></a><!-- doxytag: member="sfq.c::rtnl_sfq_get_perturb" ref="ga876d1c7691139e98e73943275515dba0" args="(struct rtnl_qdisc *qdisc)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtnl_sfq_get_perturb </td>
<td>(</td>
<td class="paramtype">struct rtnl_qdisc * </td>
<td class="paramname"><em>qdisc</em></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>SFQ qdisc. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Perturbation interval in seconds or a negative error code. </dd></dl>
<p>Definition at line <a class="el" href="sfq_8c_source.html#l00246">246</a> of file <a class="el" href="sfq_8c_source.html">sfq.c</a>.</p>
<div class="fragment"><pre class="fragment">{
<span class="keyword">struct </span>rtnl_sfq *sfq;
sfq = sfq_qdisc(qdisc);
<span class="keywordflow">if</span> (sfq && sfq->qs_mask & SCH_SFQ_ATTR_PERTURB)
<span class="keywordflow">return</span> sfq->qs_perturb;
<span class="keywordflow">else</span>
<span class="keywordflow">return</span> nl_errno(ENOENT);
}
</pre></div>
</div>
</div>
<a class="anchor" id="ga673ca724807fae25093b168181226449"></a><!-- doxytag: member="sfq.c::rtnl_sfq_get_divisor" ref="ga673ca724807fae25093b168181226449" args="(struct rtnl_qdisc *qdisc)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtnl_sfq_get_divisor </td>
<td>(</td>
<td class="paramtype">struct rtnl_qdisc * </td>
<td class="paramname"><em>qdisc</em></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>SFQ qdisc. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Divisor in number of entries or a negative error code. </dd></dl>
<p>Definition at line <a class="el" href="sfq_8c_source.html#l00262">262</a> of file <a class="el" href="sfq_8c_source.html">sfq.c</a>.</p>
<div class="fragment"><pre class="fragment">{
<span class="keyword">struct </span>rtnl_sfq *sfq;
sfq = sfq_qdisc(qdisc);
<span class="keywordflow">if</span> (sfq && sfq->qs_mask & SCH_SFQ_ATTR_DIVISOR)
<span class="keywordflow">return</span> sfq->qs_divisor;
<span class="keywordflow">else</span>
<span class="keywordflow">return</span> nl_errno(ENOENT);
}
</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>
