<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>unbound: util/rtt.h File Reference</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.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_4b581c88b01efb1cf178857b56f0f2fb.html">util</a>
</div>
</div>
<div class="contents">
<h1>rtt.h File Reference</h1>This file contains a data type and functions to help estimate good round trip times for UDP resend timeout values.
<a href="#_details">More...</a>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structrtt__info.html">rtt_info</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">RTT information. <a href="structrtt__info.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d1df92bb34b40412c1ba1a8c1bf15d2d"></a><!-- doxytag: member="rtt.h::RTT_MIN_TIMEOUT" ref="d1df92bb34b40412c1ba1a8c1bf15d2d" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="rtt_8h.html#d1df92bb34b40412c1ba1a8c1bf15d2d">RTT_MIN_TIMEOUT</a> 50</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">min retransmit timeout value, in milliseconds <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="706d5564d4bdac63e60b7dbbc53cb70b"></a><!-- doxytag: member="rtt.h::RTT_MAX_TIMEOUT" ref="706d5564d4bdac63e60b7dbbc53cb70b" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="rtt_8h.html#706d5564d4bdac63e60b7dbbc53cb70b">RTT_MAX_TIMEOUT</a> 120000</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">max retransmit timeout value, in milliseconds <br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="rtt_8h.html#b2cbc3a3edca4782b858b4f093c7624f">rtt_init</a> (struct <a class="el" href="structrtt__info.html">rtt_info</a> *rtt)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize RTT estimators. <a href="#b2cbc3a3edca4782b858b4f093c7624f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="rtt_8h.html#bd3dc38bb8c9a83736f7a7acf5b21b6a">rtt_timeout</a> (const struct <a class="el" href="structrtt__info.html">rtt_info</a> *rtt)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get timeout to use for sending a UDP packet. <a href="#bd3dc38bb8c9a83736f7a7acf5b21b6a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="rtt_8h.html#44fed64ff01ecc0f4895bd370d7a878d">rtt_unclamped</a> (const struct <a class="el" href="structrtt__info.html">rtt_info</a> *rtt)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get unclamped timeout to use for server selection. <a href="#44fed64ff01ecc0f4895bd370d7a878d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="rtt_8h.html#e75ca69421a2584e04f42b59dc8db508">rtt_update</a> (struct <a class="el" href="structrtt__info.html">rtt_info</a> *rtt, int ms)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Update the statistics with a new roundtrip estimate observation. <a href="#e75ca69421a2584e04f42b59dc8db508"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="rtt_8h.html#29846e40497aac369c9836bfd64024b9">rtt_lost</a> (struct <a class="el" href="structrtt__info.html">rtt_info</a> *rtt, int orig)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Update the statistics with a new timout expired observation. <a href="#29846e40497aac369c9836bfd64024b9"></a><br></td></tr>
</table>
<hr><h2>Detailed Description</h2>
This file contains a data type and functions to help estimate good round trip times for UDP resend timeout values.
<p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="b2cbc3a3edca4782b858b4f093c7624f"></a><!-- doxytag: member="rtt.h::rtt_init" ref="b2cbc3a3edca4782b858b4f093c7624f" args="(struct rtt_info *rtt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void rtt_init </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structrtt__info.html">rtt_info</a> * </td>
<td class="paramname"> <em>rtt</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initialize RTT estimators.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>rtt,:</em> </td><td>The structure. Caller is responsible for allocation of it. </td></tr>
</table>
</dl>
<p>References <a class="el" href="rtt_8c_source.html#l00048">calc_rto()</a>, <a class="el" href="rtt_8h_source.html#l00055">rtt_info::rto</a>, <a class="el" href="rtt_8h_source.html#l00053">rtt_info::rttvar</a>, and <a class="el" href="rtt_8h_source.html#l00051">rtt_info::srtt</a>.</p>
<p>Referenced by <a class="el" href="infra_8c_source.html#l00227">infra_host()</a>, <a class="el" href="infra_8c_source.html#l00198">new_host_entry()</a>, and <a class="el" href="unitmain_8c_source.html#l00307">rtt_test()</a>.</p>
</div>
</div><p>
<a class="anchor" name="bd3dc38bb8c9a83736f7a7acf5b21b6a"></a><!-- doxytag: member="rtt.h::rtt_timeout" ref="bd3dc38bb8c9a83736f7a7acf5b21b6a" args="(const struct rtt_info *rtt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtt_timeout </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structrtt__info.html">rtt_info</a> * </td>
<td class="paramname"> <em>rtt</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get timeout to use for sending a UDP packet.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>rtt,:</em> </td><td>round trip statistics structure. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>: timeout to use in milliseconds. Relative time value. </dd></dl>
<p>References <a class="el" href="rtt_8h_source.html#l00055">rtt_info::rto</a>.</p>
<p>Referenced by <a class="el" href="infra_8c_source.html#l00227">infra_host()</a>, and <a class="el" href="unitmain_8c_source.html#l00307">rtt_test()</a>.</p>
</div>
</div><p>
<a class="anchor" name="44fed64ff01ecc0f4895bd370d7a878d"></a><!-- doxytag: member="rtt.h::rtt_unclamped" ref="44fed64ff01ecc0f4895bd370d7a878d" args="(const struct rtt_info *rtt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtt_unclamped </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structrtt__info.html">rtt_info</a> * </td>
<td class="paramname"> <em>rtt</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get unclamped timeout to use for server selection.
<p>
Recent timeouts are reflected in the returned value. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>rtt,:</em> </td><td>round trip statistics structure. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>: value to use in milliseconds. </dd></dl>
<p>References <a class="el" href="rtt_8c_source.html#l00048">calc_rto()</a>, <a class="el" href="rtt_8h_source.html#l00055">rtt_info::rto</a>, <a class="el" href="rtt_8h_source.html#l00053">rtt_info::rttvar</a>, and <a class="el" href="rtt_8h_source.html#l00051">rtt_info::srtt</a>.</p>
<p>Referenced by <a class="el" href="infra_8c_source.html#l00513">infra_get_lame_rtt()</a>.</p>
</div>
</div><p>
<a class="anchor" name="e75ca69421a2584e04f42b59dc8db508"></a><!-- doxytag: member="rtt.h::rtt_update" ref="e75ca69421a2584e04f42b59dc8db508" args="(struct rtt_info *rtt, int ms)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void rtt_update </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structrtt__info.html">rtt_info</a> * </td>
<td class="paramname"> <em>rtt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>ms</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Update the statistics with a new roundtrip estimate observation.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>rtt,:</em> </td><td>round trip statistics structure. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ms,:</em> </td><td>estimate of roundtrip time in milliseconds. </td></tr>
</table>
</dl>
<p>References <a class="el" href="rtt_8c_source.html#l00048">calc_rto()</a>, <a class="el" href="rtt_8h_source.html#l00055">rtt_info::rto</a>, <a class="el" href="rtt_8h_source.html#l00053">rtt_info::rttvar</a>, and <a class="el" href="rtt_8h_source.html#l00051">rtt_info::srtt</a>.</p>
<p>Referenced by <a class="el" href="infra_8c_source.html#l00457">infra_rtt_update()</a>, and <a class="el" href="unitmain_8c_source.html#l00307">rtt_test()</a>.</p>
</div>
</div><p>
<a class="anchor" name="29846e40497aac369c9836bfd64024b9"></a><!-- doxytag: member="rtt.h::rtt_lost" ref="29846e40497aac369c9836bfd64024b9" args="(struct rtt_info *rtt, int orig)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void rtt_lost </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structrtt__info.html">rtt_info</a> * </td>
<td class="paramname"> <em>rtt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>orig</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Update the statistics with a new timout expired observation.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>rtt,:</em> </td><td>round trip statistics structure. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>orig,:</em> </td><td>original rtt time given for the query that timed out. Used to calculate the maximum responsible backed off time that can reasonably be applied. </td></tr>
</table>
</dl>
<p>References <a class="el" href="rtt_8h_source.html#l00055">rtt_info::rto</a>, and <a class="el" href="rtt_8h_source.html#l00061">RTT_MAX_TIMEOUT</a>.</p>
<p>Referenced by <a class="el" href="infra_8c_source.html#l00457">infra_rtt_update()</a>, and <a class="el" href="unitmain_8c_source.html#l00307">rtt_test()</a>.</p>
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Oct 13 06:46:32 2009 for unbound by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
550bbe86d83a7870fdddc73c68e5d2b2
>
files
>
246
