fw: add strategy parameters to configure exponential retx suppression
Supported by ASF, BestRoute, and Multicast strategies
Refs: #4924
Change-Id: I215d9212d90b93fa622cc65278703dc5198d0c9d
diff --git a/docs/manpages/nfd-asf-strategy.rst b/docs/manpages/nfd-asf-strategy.rst
index d168b2a..0847144 100644
--- a/docs/manpages/nfd-asf-strategy.rst
+++ b/docs/manpages/nfd-asf-strategy.rst
@@ -40,13 +40,18 @@
Use the default values for all parameters.
nfdc strategy set prefix /ndn strategy /localhost/nfd/strategy/asf/v=4/probing-interval~30000
- Set probing interval to 30 seconds.
+ Set the probing interval to 30 seconds.
nfdc strategy set prefix /ndn strategy /localhost/nfd/strategy/asf/v=4/max-timeouts~5
- Set max timeouts to 5.
+ Set the maximum number of timeouts to 5.
nfdc strategy set prefix /ndn strategy /localhost/nfd/strategy/asf/v=4/probing-interval~30000/max-timeouts~2
- Set probing interval to 30 seconds and max timeouts to 2.
+ Set the probing interval to 30 seconds and the maximum number of timeouts to 2.
+
+nfdc strategy set prefix /ndn strategy /localhost/nfd/strategy/asf/v=4/retx-suppression-multiplier~2.5/probing-interval~45000
+ Set the retransmission suppression multiplier to 2.5 and the probing interval
+ to 45 seconds. See :manpage:`nfdc-strategy(1)` for more information on the
+ retransmission suppression parameters.
See also
--------
diff --git a/docs/manpages/nfdc-strategy.rst b/docs/manpages/nfdc-strategy.rst
index f4a4041..93b0d45 100644
--- a/docs/manpages/nfdc-strategy.rst
+++ b/docs/manpages/nfdc-strategy.rst
@@ -42,6 +42,29 @@
A name that identifies the forwarding strategy.
Consult NFD Developer's Guide for a complete list of all implemented strategies.
+ For the ASF, BestRoute, and Multicast strategies, the following options may be supplied
+ to configure exponential retransmission suppression by appending them after the strategy
+ name and version number.
+
+ **retx-suppression-initial**
+ Starting duration of the suppression interval within which any retransmitted
+ Interests are considered for suppression. The default value is 10 ms.
+
+ Format: ``retx-suppression-initial~<milliseconds>``
+
+ **retx-suppression-max**
+ Maximum duration of the suppression interval. Must not be smaller than
+ **retx-suppression-initial**. The default value is 250 ms.
+
+ Format: ``retx-suppression-max~<milliseconds>``
+
+ **retx-suppression-multiplier**
+ The suppression interval is increased by this multiplier. The default value is 2.
+
+ Format: ``retx-suppression-multiplier~<float>``
+
+ See :manpage:`nfd-asf-strategy(7)` for details on additional parameters for ASF strategy.
+
EXIT CODES
----------
0: Success
@@ -66,6 +89,10 @@
nfdc strategy set prefix /ndn strategy /localhost/nfd/strategy/multicast/v=4
Set the strategy for the "/ndn" prefix to multicast, version 4.
+nfdc strategy set prefix /ndn strategy /localhost/nfd/strategy/multicast/v=4/retx-suppression-initial~20/retx-suppression-max~500
+ Set the strategy for the "/ndn" prefix to multicast, version 4, with retransmission
+ suppression initial interval set to 20 ms and maximum interval set to 500 ms.
+
nfdc strategy unset prefix /ndn
Clear the strategy choice for the "/ndn" prefix.