Gitiles
Code Review Sign In
gerrit.named-data.net / NFD / 543b1524ec0de506fc94b145de19b3dcdd0d950a / . / docs / manpages / nfdc-cs.rst
blob: c231a7c76512e9aa7499c8c0e147b9c715372b2e [file] [log] [blame]
Junxiao Shi3160a3f2018-01-09 21:25:15 +0000[diff] [blame]1nfdc-cs
Junxiao Shicdf78452018-03-02 23:14:15 +0000[diff] [blame]2=======
Junxiao Shi3160a3f2018-01-09 21:25:15 +0000[diff] [blame]3
Davide Pesavento543b1522024-06-25 17:00:32 -0400[diff] [blame^]4Synopsis
Junxiao Shi3160a3f2018-01-09 21:25:15 +0000[diff] [blame]5--------
Junxiao Shi3160a3f2018-01-09 21:25:15 +0000[diff] [blame]6
Davide Pesavento543b1522024-06-25 17:00:32 -0400[diff] [blame^]7| **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 +0000[diff] [blame]12-----------
Davide Pesavento543b1522024-06-25 17:00:32 -0400[diff] [blame^]13
Junxiao Shi3160a3f2018-01-09 21:25:15 +0000[diff] [blame]14The **nfdc cs info** command shows CS statistics information.
15
Junxiao Shicdf78452018-03-02 23:14:15 +0000[diff] [blame]16The **nfdc cs config** command updates CS configuration.
17
Junxiao Shia4d7fe02018-07-20 06:51:41 -0600[diff] [blame]18The **nfdc cs erase** command erases cached Data under a name prefix.
19
Davide Pesavento543b1522024-06-25 17:00:32 -0400[diff] [blame^]20Options
Junxiao Shicdf78452018-03-02 23:14:15 +0000[diff] [blame]21-------
Davide Pesavento543b1522024-06-25 17:00:32 -0400[diff] [blame^]22
23.. option:: <CAPACITY>
24
Junxiao Shicdf78452018-03-02 23:14:15 +0000[diff] [blame]25 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 -0400[diff] [blame^]28.. option:: admit on|off
29
Junxiao Shicdf78452018-03-02 23:14:15 +0000[diff] [blame]30 Whether the CS can admit new Data.
31
Davide Pesavento543b1522024-06-25 17:00:32 -0400[diff] [blame^]32.. option:: serve on|off
33
Junxiao Shicdf78452018-03-02 23:14:15 +0000[diff] [blame]34 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 -0400[diff] [blame^]37.. option:: <PREFIX>
38
Junxiao Shia4d7fe02018-07-20 06:51:41 -0600[diff] [blame]39 Name prefix of cached Data packets.
40
Davide Pesavento543b1522024-06-25 17:00:32 -0400[diff] [blame^]41.. option:: <COUNT>
42
Junxiao Shia4d7fe02018-07-20 06:51:41 -0600[diff] [blame]43 Maximum number of cached Data packets to erase.
44 The default is "no limit".
45
Davide Pesavento543b1522024-06-25 17:00:32 -0400[diff] [blame^]46See Also
Junxiao Shi3160a3f2018-01-09 21:25:15 +0000[diff] [blame]47--------
Davide Pesavento543b1522024-06-25 17:00:32 -0400[diff] [blame^]48
49:manpage:`nfdc(1)`