Project

General

Profile

Forwarder Status

Forwarder Status is a module of NFD Management protocol.
It provides:

  • a dataset of forwarder version information and global counters

Forwarder Status datasets are available under namespace ndn:/localhost/nfd/status.

General Status Dataset

General Status is published as a Status Dataset at ndn:/localhost/nfd/status/general.

GeneralStatus ::= NfdVersion
                  StartTimestamp
                  CurrentTimestamp
                  NNameTreeEntries
                  NFibEntries
                  NPitEntries
                  NMeasurementsEntries
                  NCsEntries
                  NInInterests
                  NInData
                  NInNacks
                  NOutInterests
                  NOutData
                  NOutNacks
                  NSatisfiedInterests
                  NUnsatisfiedInterests
                  NFragmentationErrors
                  NOutOverMtu
                  NInLpInvalid
                  NReassemblyTimeouts
                  NInNetInvalid
                  NAcknowledged
                  NRetransmitted
                  NRetxExhausted
                  NCongestionMarked

NfdVersion ::= NFD-VERSION-TYPE TLV-LENGTH
                 UTF-8 string

(other TLVs have nonNegativeInteger as value)
  • NfdVersion: NFD version; this is usually same as nfd --version output, but the forwarder MAY hide its version and return an empty string
  • StartTimestamp: timestamp (milliseconds since UNIX epoch) when forwarder starts
  • CurrentTimestamp: timestamp (milliseconds since UNIX epoch) of current time
  • NNameTreeEntries: number of NameTree entries
  • NFibEntries: number of FIB entries
  • NPitEntries: number of PIT entries
  • NMeasurementsEntries: number of Measurements entries
  • NCsEntries: number of CS entries
  • NInInterests: number of incoming Interest packets processed since forwarder starts
  • NInData: number of incoming Data packets processed since forwarder starts
  • NInNacks: number of incoming Nack packets processed since forwarder starts
  • NOutInterests: number of outgoing Interest packets processed since forwarder starts
  • NOutData: number of outgoing Data packets processed since forwarder starts
  • NOutNacks: number of outgoing Nack packets processed since forwarder starts
  • NSatisfiedInterests: number of satisfied Interests, incremented when a PIT entry that has been satisfied is being removed
  • NUnsatisfiedInterests: number of unsatisfied Interests, incremented when a PIT entry that has not been satisfied is being removed
  • NFragmentationErrors: number of failed fragmentations
  • NOutOverMtu: number of outgoing LpPackets dropped due to exceeding MTU limit. If this counter is non-zero, the operator should enable fragmentation
  • NInLpInvalid: number of invalid LpPackets dropped before reassembly
  • NReassemblyTimeouts: number of dropped partial network-layer packets due to reassembly timeout
  • NInNetInvalid: number of invalid reassembled network-layer packets dropped
  • NAcknowledged: number of network-layer packets that did not require retransmission of a fragment
  • NRetransmitted: number of network-layer packets that had at least one fragment retransmitted, but were eventually received in full
  • NRetxExhausted: number of network-layer packets dropped because a fragment reached the maximum number of retransmissions
  • NCongestionMarked: number of outgoing LpPackets that were marked with congestion marks

TLV-TYPE assignments

Type Assigned value Assigned value (hex)
NfdVersion 128 0x80
StartTimestamp 129 0x81
CurrentTimestamp 130 0x82
NNameTreeEntries 131 0x83
NFibEntries 132 0x84
NPitEntries 133 0x85
NMeasurementsEntries 134 0x86
NCsEntries 135 0x87
NInInterests 144 0x90
NInData 145 0x91
NInNacks 151 0x97
NOutInterests 146 0x92
NOutData 147 0x93
NOutNacks 152 0x98
NSatisfiedInterests 153 0x99
NUnsatisfiedInterests 154 0x9a
NFragmentationErrors 200 0xc8
NOutOverMtu 201 0xc9
NInLpInvalid 202 0xca
NReassemblyTimeouts 203 0xcb
NInNetInvalid 204 0xcc
NAcknowledged 205 0xcd
NRetransmitted 206 0xce
NRetxExhausted 207 0xcf
NCongestionMarked 208 0xd0