<title>Single Options</title>
<para><emphasis role="strong">Caution</emphasis>: The current
- implementation (olsrd-0.5.7-pre as of Dec-2008) discards several single
- options controlling the Link Quality Extensions valid with earlier
- versions. It is planned to re-implement the RFC-mode by using a special
- LinkQualityAlgorithm plugin. Discarded options:
+ implementation discards several single options controlling the Link
+ Quality Extensions valid with earlier versions. If you want the
+ RFC-compatible mode, load the <filename>olsrd_lq_rfc.so.1</filename>
+ plugin (see <xref endterm="olsrd_conf_5_plugins-title"
+ linkend="olsrd_conf_5_plugins" />). If you want to use another LQ
+ measurement than the compiled in
+ <filename>olsrd_lq_etx_ff.so.1</filename>, consider one of the other LQ
+ plugins (also see <xref endterm="olsrd_conf_5_plugins-title"
+ linkend="olsrd_conf_5_plugins" />). Discarded options:
<option>UseHysteresis</option>, <option>HystScaling</option>,
<option>HystThrHigh</option>, <option>HystThrLow</option>,
- <option>LinkQualityLevel</option>, and
- <option>LinkQualityWinsize</option>.</para>
+ <option>LinkQualityLevel</option>, <option>LinkQualityWinsize</option>,
+ <option>LinkQualityAlgorithm</option> and
+ <option>LinkQualityAging</option>.</para>
<para>Single options consists of a keyword and a value. Note, that a
comment can follow such a option on the same line. Valid single options
</listitem>
</varlistentry>
- <varlistentry>
- <term><option>LinkQualityAging</option>
- <replaceable>0.01</replaceable>-<replaceable>1.0</replaceable></term>
-
- <listitem>
- <para>This setting controls the LQ/ETX change speed for the
- <emphasis>etx_fpm</emphasis> and <emphasis>etx_float</emphasis>
- link quality plugins. A higher value will result in faster LQ/ETX
- changes. Defaults to <replaceable>0.1</replaceable>.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>LinkQualityAlgorithm</option>
- <replaceable>etx_fpm</replaceable>|<replaceable>etx_float</replaceable>|<replaceable>etx_ff</replaceable></term>
-
- <listitem>
- <para>Selects one of the internal LQ/ETX detection algorithms.
- Both <replaceable>etx_fpm</replaceable> (uses integers) and
- <replaceable>etx_float</replaceable> (uses floating point math)
- calculate the link quality based on HELLO and LQ_HELLO message
- loss. Note, that HELLO messages trigger a send-buffer-flush, so
- basically HELLOs are sent in small packets. Because the packet
- loss for small packets is much lower than for large packets, these
- algorithms may not discover optimal routes. If set to
- <replaceable>etx_ff</replaceable>, LQ/ETX detection is based on
- OLSR packet loss as it is the default with previous
- <productname>olsrd</productname> versions. Note, that
- <productname>olsrd</productname> needs to send large signaling
- packet for this to work properly, which is only true if you have a
- larger mesh (>50 nodes). Defaults to
- <replaceable>etx_fpm</replaceable>.</para>
- </listitem>
- </varlistentry>
-
<varlistentry>
<term><option>LinkQualityDijkstraLimit</option>
<replaceable>0</replaceable>|<replaceable>255</replaceable>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><option>LoadPlugin olsrd_lq_etx_ff.so.0.1 {
+ <replaceable>...</replaceable> }</option></term>
+
+ <listitem>
+ <para>This plugin realized the LQ/ETX detection algorithm based on
+ OLSR packet loss. This algorithm is compatible to the LQ
+ calculation used by previous versions of
+ <productname>olsrd</productname>, so this algorithm is also the
+ compiled-in default. Note, that <productname>olsrd</productname>
+ needs to send large signaling packet for this to work optimal,
+ which is only true if you have a larger mesh (>50 nodes). The
+ plugin accepts no parameters.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>LoadPlugin olsrd_lq_etx_float.so.0.1 {
+ <replaceable>...</replaceable> }</option></term>
+
+ <listitem>
+ <para>This plugin calculates the link quality based on HELLO and
+ LQ_HELLO message loss. While calculating, it uses floating point
+ math. Note, that HELLO messages trigger a send-buffer-flush, so
+ basically HELLOs are sent in small packets. Because the packet
+ loss for small packets is much lower than for large packets, these
+ algorithms may not discover optimal routes. The plugin accepts the
+ following parameters.</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><option>PlParam</option> LinkQualityAging
+ <replaceable>0.01</replaceable>-<replaceable>1.0</replaceable></term>
+
+ <listitem>
+ <para>This setting controls the LQ/ETX change speed for the
+ plugin. A higher value will result in faster LQ/ETX changes.
+ Defaults to <replaceable>0.1</replaceable>.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>LoadPlugin olsrd_lq_etx_fpm.so.0.1 {
+ <replaceable>...</replaceable> }</option></term>
+
+ <listitem>
+ <para>This plugin calculates the link quality based on HELLO and
+ LQ_HELLO message loss. While calculating, it uses integer-based
+ fixed point math (FPM). Note, that HELLO messages trigger a
+ send-buffer-flush, so basically HELLOs are sent in small packets.
+ Because the packet loss for small packets is much lower than for
+ large packets, these algorithms may not discover optimal routes.
+ The plugin accepts the following parameters.</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><option>PlParam</option> LinkQualityAging
+ <replaceable>0.01</replaceable>-<replaceable>1.0</replaceable></term>
+
+ <listitem>
+ <para>This setting controls the LQ/ETX change speed for the
+ plugin. A higher value will result in faster LQ/ETX changes.
+ Defaults to <replaceable>0.1</replaceable>.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>LoadPlugin olsrd_lq_etx_rfc.so.0.1 {
+ <replaceable>...</replaceable> }</option></term>
+
+ <listitem>
+ <para>This plugin realizes the hop-optimized metric required by
+ RFC 3626. You can load this plugin if you require standard-conform
+ operation.</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><option>PlParam</option> UseHysteresis
+ <replaceable>yes</replaceable>|<replaceable>no</replaceable></term>
+
+ <listitem>
+ <para>If set to <replaceable>yes,</replaceable> hysteresis
+ will be used as explained in section 14 of RFC 3626. The
+ setting determines if hysteresis is used. Defaults to
+ <replaceable>no</replaceable>. </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>PlParam</option> HystScaling
+ <replaceable>0.01</replaceable>-<replaceable>0.99</replaceable></term>
+
+ <listitem>
+ <para>Sets the scaling value used by the hysteresis
+ algorithm. This must be a positive floating point value
+ smaller than <replaceable>1.0</replaceable>. Consult RFC
+ 3626 for details. Defaults to
+ <replaceable>0.5</replaceable>. </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>PlParam</option> HystThrHigh
+ <replaceable>0.0</replaceable>-<replaceable>1.0</replaceable></term>
+
+ <listitem>
+ <para>This option sets the upper threshold for accepting a
+ link in hysteresis calculation. The value must be higher
+ than the one set as the lower threshold. Defaults to
+ <replaceable>0.8</replaceable>. </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>PlParam</option> HystThrLow
+ <replaceable>0.0</replaceable>-<replaceable>1.0</replaceable></term>
+
+ <listitem>
+ <para> This option sets the lower threshold for setting a
+ link to asymmetric using hysteresis. The value must be lower
+ than the one set as the upper threshold. Defaults to
+ <replaceable>0.3</replaceable>. </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term><option>LoadPlugin olsrd_mini.so.0.1 {
<replaceable>...</replaceable> }</option></term>
Repositories / olsrd.git / commitdiff