repo-ng

Repo Protocol Specification

===========================

A Repo supports the network by preserving content and responding to Interests requesting content that it holds. A Repo can exist in any node, and is recommended if applications in that node need to preserve data. The NDN repo protocol is a specification of repo operations including reading, insertion and deletion of data objects in repo.

Repo semantics is based on Signed Interests with signed components at the end of the name and basic common semantics of NDN.

When some operation of repo including insertion and deletion of data objects is requested, a command interest is sent. The command interest is the interest as command of insertion and deletion and signed as form of command interest for access control. The repo will response the command with the data object.

The repo protocol can be categorized in two sections of Data packet retrieval and Data packet management. Repo-ng implements a set of repo management protocols to insert and delete data in different ways.

## Repo Management Protocols

- **[[Repo Command]]** defines the request and response formats of commands that can insert or delete data from repo, and how these commands should be signed and authenticated.

- **[[Basic Repo Insertion Protocol]]** defines format of insertion of a single or collection of Data packets.  In addition to the basic protocol, repo-ng implements several other insertion protocols:

    + **[[Insertion Protocol]]** (to be added)

    + **[[Tcp Bulk Insert Repo Insertion Protocol]]** defines a simple TCP-based protocol to insert Data packets in bulk (e.g., from a producer on the same host)

- **[[Repo Deletion Protocol]]** defines format of deletion of a single or collection of Data packets under certain prefix 

## Data packet retrieval from repo

Repo registers prefixes of data objects it holds into NDN forwarding daemon and the repo will respond the data with such prefixes.

A standard interest is used to fetch content from the repo. The repo will respond when the name of the interest matches the prefix it registered in NFD. If the content in repo matches the interests, it will respond with the data object. When the interest is not matched, it will not respond.

The protocol is listed as bellow

If there is a matching data object:

    Requester                     Repo

        |                           |

        |                           |

        |         Interest          |

     t1 |-------------------------->|

        |                           |

        |        Data Object        |

     t2 |<==========================|

        |                           |

        |                           |

        |                           |

If there is no matching data object:

    Requester                     Repo

        |                           |

        |                           |

        |         Interest          |

     t1 |-------------------------->|

        |                           |

        |                           |

        |                           |

### About Freshness

Producer needs to take care of freshness when it puts things into repo, i.e. explicitly delete obsolete content. The `MustBeFresh` selector will be ignored by repo when fetching content from repo or handling repo command by repo.