autodoc.git / traditional_manual / chapter_9.html

version» Context lines:

autodoc.git/traditional_manual/chapter_9.html:2355:      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Get the Max Transfer Unit for the object (if any).</p>   </dd>   <dt class='head--doc'>Returns</dt>   <dd class='body--doc'><table class='box'><tr><td><code><code class='key'>-1</code></code></td><td><p>Returns <code class='expr'>-1</code> if the object is not a socket or    if the mtu is unknown.</p>   </td></tr>   <tr><td><code><code class='key'>(1..)</code></code></td><td><p>Returns a positive value with the mtu on success.</p>   </td></tr> - </table></dd></dl> + </table> + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'><p>The returned value is adjusted to take account for the +  IP and UDP headers, so that it should be usable without +  further adjustment unless further IP options are in use.</p> + </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>read</b></span>   </dt>   <dd><p><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>int</code>|<code class='datatype'>string</code>) <b><span class='method'>read</span>(</b><b>)</b></code><br>   <code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>int</code>|<code class='datatype'>string</code>) <b><span class='method'>read</span>(</b><code class='datatype'>int</code> <code class='argument'>flag</code><b>)</b></code></p></dd>