Gitiles
Code Review Sign In
gerrit.named-data.net / NFD / af3ff5a8c6e343600b6a0f4a2cd284997a542621 / . / docs / manpages / nfd-asf-strategy.rst
blob: d168b2a51695463c82baaa7d968ca3aa81478338 [file] [log] [blame]
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -0500[diff] [blame]1nfd-asf-strategy
2================
3
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -0400[diff] [blame^]4Synopsis
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -0500[diff] [blame]5--------
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -0500[diff] [blame]6
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -0400[diff] [blame^]7**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 -0500[diff] [blame]11-----------
12
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -0400[diff] [blame^]13**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 -0500[diff] [blame]16
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -0400[diff] [blame^]17Options
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -0500[diff] [blame]18-------
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -0500[diff] [blame]19
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -0400[diff] [blame^]20.. option:: probing-interval
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -0500[diff] [blame]21
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -0400[diff] [blame^]22 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 -0500[diff] [blame]37--------
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -0400[diff] [blame^]38
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -0500[diff] [blame]39nfdc strategy set prefix /ndn strategy /localhost/nfd/strategy/asf
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -0400[diff] [blame^]40 Use the default values for all parameters.
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -0500[diff] [blame]41
Eric Newberry7249fb42021-04-04 21:09:32 -0700[diff] [blame]42nfdc strategy set prefix /ndn strategy /localhost/nfd/strategy/asf/v=4/probing-interval~30000
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -0400[diff] [blame^]43 Set probing interval to 30 seconds.
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -0500[diff] [blame]44
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -0400[diff] [blame^]45nfdc strategy set prefix /ndn strategy /localhost/nfd/strategy/asf/v=4/max-timeouts~5
46 Set max timeouts to 5.
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -0500[diff] [blame]47
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -0400[diff] [blame^]48nfdc strategy set prefix /ndn strategy /localhost/nfd/strategy/asf/v=4/probing-interval~30000/max-timeouts~2
49 Set probing interval to 30 seconds and max timeouts to 2.
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -0500[diff] [blame]50
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -0400[diff] [blame^]51See also
Ashlesh Gawande92e4ea52017-07-19 11:38:12 -0500[diff] [blame]52--------
Saurab Dulalaf3ff5a2021-09-19 19:45:07 -0400[diff] [blame^]53
Eric Newberry7249fb42021-04-04 21:09:32 -0700[diff] [blame]54nfdc(1), nfdc-strategy(1)