blob: 08471440aae0afb7f79a4ee45828cd41757b7933 [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**
8/localhost/nfd/strategy/asf[/v=4][/**probing-interval**\ ~\ *INTERVAL*][/**max-timeouts**\ ~\ *TIMEOUTS*]
9
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
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -040020.. option:: probing-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
27.. option:: max-timeouts
28
29 This optional parameter makes ASF switch to another appropriate face (if available)
30 after it has encountered the specified number of timeouts. The value is a positive
31 integer and defaults to 3, i.e., switch to another face after 3 timeouts. Smaller
32 values make ASF more sensitive to timeouts and will switch paths more frequently,
33 which should provide a faster reaction to link failures. Larger values may be better
34 suited when transient timeouts are common and for certain application uses.
35
36Examples
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -050037--------
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -040038
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -050039nfdc strategy set prefix /ndn strategy /localhost/nfd/strategy/asf
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -040040 Use the default values for all parameters.
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -050041
Eric Newberry7249fb42021-04-04 21:09:32 -070042nfdc strategy set prefix /ndn strategy /localhost/nfd/strategy/asf/v=4/probing-interval~30000
Ashlesh Gawande1ef93d02022-04-08 00:25:06 -040043 Set the probing interval to 30 seconds.
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -050044
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -040045nfdc strategy set prefix /ndn strategy /localhost/nfd/strategy/asf/v=4/max-timeouts~5
Ashlesh Gawande1ef93d02022-04-08 00:25:06 -040046 Set the maximum number of timeouts to 5.
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -050047
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -040048nfdc strategy set prefix /ndn strategy /localhost/nfd/strategy/asf/v=4/probing-interval~30000/max-timeouts~2
Ashlesh Gawande1ef93d02022-04-08 00:25:06 -040049 Set the probing interval to 30 seconds and the maximum number of timeouts to 2.
50
51nfdc strategy set prefix /ndn strategy /localhost/nfd/strategy/asf/v=4/retx-suppression-multiplier~2.5/probing-interval~45000
52 Set the retransmission suppression multiplier to 2.5 and the probing interval
53 to 45 seconds. See :manpage:`nfdc-strategy(1)` for more information on the
54 retransmission suppression parameters.
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -050055
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -040056See also
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -050057--------
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -040058
Eric Newberry7249fb42021-04-04 21:09:32 -070059nfdc(1), nfdc-strategy(1)