blob: c231a7c76512e9aa7499c8c0e147b9c715372b2e [file] [log] [blame]
Junxiao Shi3160a3f2018-01-09 21:25:15 +00001nfdc-cs
Junxiao Shicdf78452018-03-02 23:14:15 +00002=======
Junxiao Shi3160a3f2018-01-09 21:25:15 +00003
Davide Pesavento543b1522024-06-25 17:00:32 -04004Synopsis
Junxiao Shi3160a3f2018-01-09 21:25:15 +00005--------
Junxiao Shi3160a3f2018-01-09 21:25:15 +00006
Davide Pesavento543b1522024-06-25 17:00:32 -04007| **nfdc cs** [**info**]
8| **nfdc cs** **config** [**capacity** *CAPACITY*] [**admit** **on**\|\ **off**] [**serve** **on**\|\ **off**]
9| **nfdc cs** **erase** *PREFIX* [**count** *COUNT*]
10
11Description
Junxiao Shi3160a3f2018-01-09 21:25:15 +000012-----------
Davide Pesavento543b1522024-06-25 17:00:32 -040013
Junxiao Shi3160a3f2018-01-09 21:25:15 +000014The **nfdc cs info** command shows CS statistics information.
15
Junxiao Shicdf78452018-03-02 23:14:15 +000016The **nfdc cs config** command updates CS configuration.
17
Junxiao Shia4d7fe02018-07-20 06:51:41 -060018The **nfdc cs erase** command erases cached Data under a name prefix.
19
Davide Pesavento543b1522024-06-25 17:00:32 -040020Options
Junxiao Shicdf78452018-03-02 23:14:15 +000021-------
Davide Pesavento543b1522024-06-25 17:00:32 -040022
23.. option:: <CAPACITY>
24
Junxiao Shicdf78452018-03-02 23:14:15 +000025 Maximum number of Data packets the CS can store.
26 Lowering the capacity causes the CS to evict excess Data packets.
27
Davide Pesavento543b1522024-06-25 17:00:32 -040028.. option:: admit on|off
29
Junxiao Shicdf78452018-03-02 23:14:15 +000030 Whether the CS can admit new Data.
31
Davide Pesavento543b1522024-06-25 17:00:32 -040032.. option:: serve on|off
33
Junxiao Shicdf78452018-03-02 23:14:15 +000034 Whether the CS can satisfy incoming Interests using cached Data.
35 Turning this off causes all CS lookups to miss.
36
Davide Pesavento543b1522024-06-25 17:00:32 -040037.. option:: <PREFIX>
38
Junxiao Shia4d7fe02018-07-20 06:51:41 -060039 Name prefix of cached Data packets.
40
Davide Pesavento543b1522024-06-25 17:00:32 -040041.. option:: <COUNT>
42
Junxiao Shia4d7fe02018-07-20 06:51:41 -060043 Maximum number of cached Data packets to erase.
44 The default is "no limit".
45
Davide Pesavento543b1522024-06-25 17:00:32 -040046See Also
Junxiao Shi3160a3f2018-01-09 21:25:15 +000047--------
Davide Pesavento543b1522024-06-25 17:00:32 -040048
49:manpage:`nfdc(1)`