Project

General

Profile

ForwarderStatus » History » Version 13

Ju Pan, 10/17/2018 08:36 PM

1 1 Junxiao Shi
# Forwarder Status
2 11 Davide Pesavento
3
{{>toc}}
4 9 Davide Pesavento
5 1 Junxiao Shi
**Forwarder Status** is a module of [[Management|NFD Management protocol]].
6 5 Junxiao Shi
It provides:
7 1 Junxiao Shi
8 5 Junxiao Shi
* a dataset of forwarder version information and global counters
9 1 Junxiao Shi
10 5 Junxiao Shi
Forwarder Status datasets are available under namespace `ndn:/localhost/nfd/status`.
11 1 Junxiao Shi
12 5 Junxiao Shi
## General Status Dataset
13 1 Junxiao Shi
14 5 Junxiao Shi
General Status is published as a [[StatusDataset|Status Dataset]] at `ndn:/localhost/nfd/status/general`.
15 1 Junxiao Shi
16 5 Junxiao Shi
    GeneralStatus ::= NfdVersion
17
                      StartTimestamp
18
                      CurrentTimestamp
19
                      NNameTreeEntries
20
                      NFibEntries
21
                      NPitEntries
22
                      NMeasurementsEntries
23
                      NCsEntries
24
                      NInInterests
25 8 Junxiao Shi
                      NInData
26 5 Junxiao Shi
                      NInNacks
27
                      NOutInterests
28 8 Junxiao Shi
                      NOutData
29 5 Junxiao Shi
                      NOutNacks
30 13 Ju Pan
                      NSatisfiedInterests
31
                      NUnsatisfiedInterests
32 5 Junxiao Shi
33
    NfdVersion ::= NFD-VERSION-TYPE TLV-LENGTH
34
                     UTF-8 string
35
36
    (other TLVs have nonNegativeInteger as value)
37
38 12 Davide Pesavento
* **NfdVersion**: NFD version; this is usually same as `nfd --version` output, but the forwarder MAY hide its version and return an empty string
39 5 Junxiao Shi
* **StartTimestamp**: timestamp (milliseconds since UNIX epoch) when forwarder starts
40
* **CurrentTimestamp**: timestamp (milliseconds since UNIX epoch) of current time
41
* **NNameTreeEntries**: number of NameTree entries
42
* **NFibEntries**: number of FIB entries
43
* **NPitEntries**: number of PIT entries
44
* **NMeasurementsEntries**: number of Measurements entries
45
* **NCsEntries**: number of CS entries
46
* **NInInterests**: number of incoming Interest packets processed since forwarder starts
47 8 Junxiao Shi
* **NInData**: number of incoming Data packets processed since forwarder starts
48 5 Junxiao Shi
* **NInNacks**: number of incoming Nack packets processed since forwarder starts
49
* **NOutInterests**: number of outgoing Interest packets processed since forwarder starts
50 8 Junxiao Shi
* **NOutData**: number of outgoing Data packets processed since forwarder starts
51 5 Junxiao Shi
* **NOutNacks**: number of outgoing Nack packets processed since forwarder starts
52 13 Ju Pan
* **NSatisfiedInterests**: number of satisfied Interests, incremented when a PIT entry that has been satisfied is being removed
53
* **NUnsatisfiedInterests**: number of unsatisfied Interests, incremented when a PIT entry that has not been satisfied is being removed
54 5 Junxiao Shi
55
56 1 Junxiao Shi
## TLV-TYPE assignments
57
58
Type                                        | Assigned value    | Assigned value (hex)
59
------------------------------------------- | ----------------- | --------------------
60
NfdVersion                                  | 128               | 0x80
61 3 Junxiao Shi
StartTimestamp                              | 129               | 0x81
62 4 Junxiao Shi
CurrentTimestamp                            | 130               | 0x82
63 1 Junxiao Shi
NNameTreeEntries                            | 131               | 0x83
64
NFibEntries                                 | 132               | 0x84
65
NPitEntries                                 | 133               | 0x85
66
NMeasurementsEntries                        | 134               | 0x86
67
NCsEntries                                  | 135               | 0x87
68
NInInterests                                | 144               | 0x90
69 8 Junxiao Shi
NInData                                     | 145               | 0x91
70 7 Junxiao Shi
NInNacks                                    | 151               | 0x97
71 1 Junxiao Shi
NOutInterests                               | 146               | 0x92
72 8 Junxiao Shi
NOutData                                    | 147               | 0x93
73 7 Junxiao Shi
NOutNacks                                   | 152               | 0x98
74 13 Ju Pan
NSatisfiedInterests                         | 153               | 0x99
75
NUnsatisfiedInterests                       | 154               | 0x9A