Project

General

Profile

Actions

Task #1612

closed

Developer Guide: RIB Management

Added by Junxiao Shi over 10 years ago. Updated over 10 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
Docs
Target version:
Start date:
Due date:
% Done:

100%

Estimated time:

Description

Write RIB Management section of NFD Developer's Guide.

NFD Developer's Guide explains the internals of the NFD, and the target readers are people who may want to extend and improve NFD.
The hope is that after reading this guide, other developers would have good ideas of how NFD was designed and implemented, which will help them to plan any changes.

This section contains:

  • the design and structure of the module
  • the interaction between other modules
  • explanation of major components of this module and their interactions
  • figures to help understand the text

Write documentation in LaTeX format and submit to git@git.irl.cs.ucla.edu:papers/nfd-docs.git.
See this email for more details.

Actions #1

Updated by Junxiao Shi over 10 years ago

Obaid, Vince, Lan should decide the assignee of this Task.
If the Task is to be completed collaboratively, a primary assignee should be decided and entered on this Task.

Actions #2

Updated by Lan Wang over 10 years ago

  • Assignee set to Vince Lehman
Actions #3

Updated by Vince Lehman over 10 years ago

  • % Done changed from 0 to 80
Actions #4

Updated by Junxiao Shi over 10 years ago

  • Status changed from New to In Progress
Actions #5

Updated by Syed Amin over 10 years ago

  • Status changed from In Progress to Code review
  • Assignee changed from Vince Lehman to Syed Amin
  • % Done changed from 80 to 90
Actions #6

Updated by Alex Afanasyev over 10 years ago

  • Status changed from Code review to Resolved
Actions #7

Updated by Junxiao Shi over 10 years ago

  • % Done changed from 90 to 100
Actions #8

Updated by Alex Afanasyev over 10 years ago

  • Status changed from Resolved to In Progress
  • % Done changed from 100 to 70

The section needs to document the current implementation choice for CHILD_INHERIT flags and make a reference that behavior may (will) change in the future versions.

Also. We should also describe how CAPTURE flag is handled (e.g., that it is set for the namespace if at least one RibEntry for the namespace sets it).

Actions #9

Updated by Vince Lehman over 10 years ago

  • Assignee changed from Syed Amin to Vince Lehman
Actions #10

Updated by Vince Lehman over 10 years ago

  • Status changed from In Progress to Feedback
  • % Done changed from 70 to 100
Actions #11

Updated by Junxiao Shi over 10 years ago

Alex Afanasyev wrote:

Also. We should also describe how CAPTURE flag is handled (e.g., that it is set for the namespace if at least one RibEntry for the namespace sets it).

Documentation (and preferably the code) should use consistent terms with RibMgmt protocol.

  • Route refers to a tuple of
  • RIB entry refers to a collection of Routes at the same Name
Actions #12

Updated by Vince Lehman over 10 years ago

Junxiao Shi wrote:

Documentation (and preferably the code) should use consistent terms with RibMgmt protocol.

  • Route refers to a tuple of
  • RIB entry refers to a collection of Routes at the same Name

So for example, should I change something like:

Alex Afanasyev wrote:
(e.g., that it is set for the namespace if at least one RibEntry for the namespace sets it).

to (e.g., that it is set for the RibEntry if at least one route for the RibEntry sets it) ?

Actions #13

Updated by Alex Afanasyev over 10 years ago

May be. If you do so, you should also define both Route and RIB entry in the doc.

Actions #14

Updated by Alex Afanasyev over 10 years ago

Vince, can you spell out in the doc (what it is right now/what it should be) what exactly is the behavior when neither capture nor child inherit specified. As of right now I'm not even sure what I'm suppose to see.

Actions #15

Updated by Alex Afanasyev over 10 years ago

  • Status changed from Feedback to Closed
Actions

Also available in: Atom PDF