Gitiles
Code Review Sign In
gerrit.named-data.net / NFD / 5cc706c8cbbd36fc818e0e132860f0d77218b43d / . / docs / manpages / nfdc-strategy.rst
blob: 20e33f1d24077085a6954b1be35454e3fec31cad [file] [log] [blame]
Junxiao Shi6c135622016-11-21 14:30:33 +0000[diff] [blame]1nfdc-strategy
2=============
3
4SYNOPSIS
5--------
6| nfdc strategy [list]
Junxiao Shi5d3e4812017-04-05 16:52:59 +0000[diff] [blame]7| nfdc strategy show [prefix] <PREFIX>
Junxiao Shib283f522017-04-06 20:46:15 +0000[diff] [blame]8| nfdc strategy set [prefix] <PREFIX> [strategy] <STRATEGY>
9| nfdc strategy unset [prefix] <PREFIX>
Junxiao Shi6c135622016-11-21 14:30:33 +0000[diff] [blame]10
11DESCRIPTION
12-----------
13In NFD, packet forwarding behavior is determined by forwarding pipelines and forwarding strategies.
14The forwarding pipelines define general steps of packet processing.
15Forwarding strategies provide the intelligence to make decision on whether, when, and where
16to forward Interests.
17
18NFD contains multiple forwarding strategy implementations.
19The strategy choice table determines which strategy is used in forwarding an Interest.
20
Junxiao Shi5d3e4812017-04-05 16:52:59 +0000[diff] [blame]21The **nfdc strategy list** command shows a list of strategy choices.
22
23The **nfdc strategy show** command shows the effective strategy choice for a specific name.
Junxiao Shi6c135622016-11-21 14:30:33 +0000[diff] [blame]24
Junxiao Shib283f522017-04-06 20:46:15 +0000[diff] [blame]25The **nfdc strategy set** command sets the strategy for a name prefix.
26The strategy for ``/'' prefix is the default strategy.
Junxiao Shi6c135622016-11-21 14:30:33 +0000[diff] [blame]27
Junxiao Shib283f522017-04-06 20:46:15 +0000[diff] [blame]28The **nfdc strategy unset** command clears the strategy choice at a name prefix,
Junxiao Shi6c135622016-11-21 14:30:33 +0000[diff] [blame]29so that a strategy choice at a shorter prefix or the default strategy will be used.
Junxiao Shib283f522017-04-06 20:46:15 +0000[diff] [blame]30It undoes a prior **nfdc strategy set** command on the same name prefix.
31It is prohibited to unset the strategy choice for ``/'' prefix because there must always be a
32default strategy.
Junxiao Shi6c135622016-11-21 14:30:33 +0000[diff] [blame]33
34OPTIONS
35-------
Junxiao Shif0dfb332017-02-02 05:32:25 +0000[diff] [blame]36<PREFIX>
Junxiao Shi6c135622016-11-21 14:30:33 +0000[diff] [blame]37 The name prefix of a strategy choice.
38 The strategy choice is effective for all Interests under the name prefix,
Junxiao Shib283f522017-04-06 20:46:15 +0000[diff] [blame]39 unless overridden by another strategy choice at a longer prefix.
Junxiao Shi6c135622016-11-21 14:30:33 +0000[diff] [blame]40
Junxiao Shif0dfb332017-02-02 05:32:25 +0000[diff] [blame]41<STRATEGY>
Junxiao Shi6c135622016-11-21 14:30:33 +0000[diff] [blame]42 A name that identifies the forwarding strategy.
43 Consult NFD Developer's Guide for a complete list of all implemented strategies.
44
Junxiao Shi5d3e4812017-04-05 16:52:59 +0000[diff] [blame]45EXIT CODES
46----------
Junxiao Shi5d3e4812017-04-05 16:52:59 +0000[diff] [blame]470: Success
48
491: An unspecified error occurred
50
512: Malformed command line
52
Junxiao Shib283f522017-04-06 20:46:15 +0000[diff] [blame]537: Strategy not found (**nfdc strategy set** only)
54
Junxiao Shi0e13e1e2018-01-22 08:29:12 +0000[diff] [blame]55EXAMPLES
56--------
57nfdc strategy list
58 List all configured strategy choices.
59
60nfdc strategy show prefix /localhost/ping/1
61 Identify which strategy will handle Interests named "/localhost/ping/1".
62
63nfdc strategy set prefix / strategy /localhost/nfd/strategy/best-route
64 Set the default strategy to best-route, latest version.
65
66nfdc strategy set prefix /ndn strategy /localhost/nfd/strategy/multicast/%FD%01
67 Set the strategy of the "/ndn" prefix to multicast, version 1.
68
69nfdc strategy unset prefix /ndn
70 Clear the strategy choice for the "/ndn" prefix.
71
Junxiao Shi6c135622016-11-21 14:30:33 +0000[diff] [blame]72SEE ALSO
73--------
74nfd(1), nfdc(1)