blob: ff7079abb742c9b83210317b1bfa6ed3e2d51793 [file] [log] [blame]
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -05001nfd-asf-strategy
2================
3
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -04004Synopsis
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -05005--------
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -05006
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -04007**nfdc strategy set** **prefix** *NAME* **strategy**
Davide Pesavento543b1522024-06-25 17:00:32 -04008/localhost/nfd/strategy/asf[/v=5][/**probing-interval**\ ~\ *INTERVAL*][/**max-timeouts**\ ~\ *TIMEOUTS*]
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -04009
10Description
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -050011-----------
12
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -040013**ASF** is an Adaptive Smoothed RTT-based Forwarding Strategy that chooses the
14best next hop based on SRTT measurements, and also periodically probes other
15next hops to learn their RTTs.
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -050016
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -040017Options
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -050018-------
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -050019
Davide Pesavento543b1522024-06-25 17:00:32 -040020.. option:: probing-interval <INTERVAL>
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -050021
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -040022 This optional parameter tells ASF how often to send a probe to determine
23 alternative paths. The value is specified in milliseconds (non-negative
24 integer). Smaller values will result in higher overhead but faster reaction.
25 The default value is 1 minute and the minimum value is 1 second.
26
awlaneee97f532024-09-19 15:48:21 -050027.. option:: measurements-lifetime <LIFETIME>
28
29 This optional parameter tells ASF how long to retain NamespaceInfo and FaceInfo
30 measurements if they are not actively updated. If not specified, this value defaults
31 to 5 minutes. This value is specified in (non-negative integer) milliseconds and must
32 be greater than the probing interval, as otherwise there is negligible benefit gained
33 from the additional traffic generated by ASF.
34
Davide Pesavento543b1522024-06-25 17:00:32 -040035.. option:: max-timeouts <TIMEOUTS>
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -040036
37 This optional parameter makes ASF switch to another appropriate face (if available)
38 after it has encountered the specified number of timeouts. The value is a positive
39 integer and defaults to 3, i.e., switch to another face after 3 timeouts. Smaller
40 values make ASF more sensitive to timeouts and will switch paths more frequently,
41 which should provide a faster reaction to link failures. Larger values may be better
42 suited when transient timeouts are common and for certain application uses.
43
44Examples
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -050045--------
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -040046
Davide Pesavento543b1522024-06-25 17:00:32 -040047``nfdc strategy set prefix /ndn strategy /localhost/nfd/strategy/asf``
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -040048 Use the default values for all parameters.
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -050049
Davide Pesavento543b1522024-06-25 17:00:32 -040050``nfdc strategy set prefix /ndn strategy /localhost/nfd/strategy/asf/v=5/probing-interval~30000``
Ashlesh Gawande1ef93d02022-04-08 00:25:06 -040051 Set the probing interval to 30 seconds.
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -050052
Davide Pesavento543b1522024-06-25 17:00:32 -040053``nfdc strategy set prefix /ndn strategy /localhost/nfd/strategy/asf/v=5/max-timeouts~5``
Ashlesh Gawande1ef93d02022-04-08 00:25:06 -040054 Set the maximum number of timeouts to 5.
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -050055
awlaneee97f532024-09-19 15:48:21 -050056``nfdc strategy set prefix /ndn strategy /localhost/nfd/strategy/asf/v=5/measurements-lifetime~120000``
57 Set the maximum measurement lifetime to 2 minutes.
58
59``nfdc strategy set prefix /ndn strategy /localhost/nfd/strategy/asf/v=5/probing-interval~30000/max-timeouts~2/measurements-lifetime~120000``
60 Set the probing interval to 30 seconds, the maximum number of timeouts to 2, and the maximum measurement lifetime to 2 minutes.
Ashlesh Gawande1ef93d02022-04-08 00:25:06 -040061
Davide Pesavento543b1522024-06-25 17:00:32 -040062``nfdc strategy set prefix /ndn strategy /localhost/nfd/strategy/asf/v=5/retx-suppression-multiplier~2.5/probing-interval~45000``
Ashlesh Gawande1ef93d02022-04-08 00:25:06 -040063 Set the retransmission suppression multiplier to 2.5 and the probing interval
64 to 45 seconds. See :manpage:`nfdc-strategy(1)` for more information on the
65 retransmission suppression parameters.
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -050066
Davide Pesavento543b1522024-06-25 17:00:32 -040067See Also
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -050068--------
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -040069
Davide Pesavento543b1522024-06-25 17:00:32 -040070:manpage:`nfdc-strategy(1)`