Repo Protocol Specification » History » Revision 13
Revision 12 (Shuo Chen, 02/19/2014 09:51 AM) → Revision 13/136 (Shuo Chen, 02/19/2014 10:06 AM)
Repo Protocol Specification
===========================
Repo is persistent storage of data objects model in NDN. 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 [Command Interests](http://redmine.named-data.net/projects/nfd/wiki/Command_Interests) with signed commponents an 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 three sections of reading, insertion and deletion of data objects.
## Repo Reading Specification
The repo could be viewed as the data container of the data objects. It will register some specific prefixes of data objects it holds into NFD (NDN Forwarding Deamon) 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 |-------------------------->|
| |
| |
| |
## Repo Insertion Specification
Insertion specification is for some client and application to insert data objects into certain NDN repo. A command interest as insertion command will be sent to the repo. This command interest is a signed interest and will be validated with access control policy defined by the repo. When the interested is validated and name of the data is not existed in the repo. The repository will reponse with a data object containing OK status and start to send the interest to fetch the data to insert.
### Insertion command interest semantics
The name semantics is defined to have following components:
* ``<box of repo>`` refers to specific name of repo
* ``insert`` refers to insert data objects
* ``<data name>`` refers to specific name of data that will be inserted
The folloing components are components of singed interest for access control:
* ``<timestamp>``
* ``<random-value>``
* ``<SignatureInfo>``
* ``<SignatureValue>``
<box of repo> and <data name> can be divided by serveral continious ``/`` according to specific defination.
For example, for ``<box of repo>`` as ``/ucla/cs/repo`` and ``<data name>`` as ``/vedio/Forrest Gump``, the data object is defined as following:
/ucla/cs/repo/insert/vedio/Forrest Gump/<timestamp>/<random-value>/<SignatureInfo>/<SignatureValue>
Protocol process:
1. Requester sends insert command to repo.
2. Repo checks this insert command.
2.1 Repo validates the this command interest. If invalidated, a data object contained invalidated status code will be responded.
2.2 Repo checks the name of the interest. If a data with the name same with the name or prefix of the data in command interest exists in repo, this command interest is rejected. A data object contains the status code will be responded.
2.3 Repo checks whether the data is segmented.
Protocol diagram:
Requester Repo Data producer
| | |
| | |
+---+ Insert command +---+ |
| | --------------------> | | |
+---+ | | |
| | | |
+---+ Confirm start | | |
| | <==================== | | |
+---+ Reject command +---+ |
| (with status code) | |
| +---+ Interest for Data +---+
| | | --------------------------> | |
| +---+ | |
| | | |
| +---+ Data segment | |
| | | <========================== | |
| +---+ +---+
| | |
| ~ ~
| ~ ~
| | |
| +---+ Interest for Data +---+
| | | --------------------------> | |
| +---+ | |
| | | |
| +---+ Data segment | |
| | | <========================== | |
| +---+ +---+
| | |
| | |
| ~ ~
| ~ ~
| | |
| | |
| | |
+---+ Status interest +---+ |
| | --------------------> | | |
+---+ | | |
| | | |
+---+ Status response | | |
| | <==================== | | |
+---+ +---+ |
| | |
| | |