Repo Command » History » Version 13
weijia yuan, 10/01/2018 12:47 AM
1 | 1 | Alex Afanasyev | Repo Command |
---|---|---|---|
2 | ============ |
||
3 | |||
4 | For insertion, deletion and other operations of repo, these commands are encoded in the form of [[ndn-cxx:SignedInterest|Signed Interests]]: |
||
5 | |||
6 | /<repo-prefix>/<command-verb>/................./......................................... |
||
7 | \______ _______/ \__________________ ___________________/ |
||
8 | \/ \/ |
||
9 | RepoCommandParameter Signed Interest additional components |
||
10 | |||
11 | The semantics of repo command interest is as follows: |
||
12 | |||
13 | The name semantics is defined to have following components: |
||
14 | |||
15 | * ``<repo prefix>`` refers to specific prefix repo is listening |
||
16 | * ``<command verb>`` refers to the name of command |
||
17 | * ``<RepoCommandParameter>`` refers to parameters of repo command |
||
18 | |||
19 | The following components are components of singed interest for access control: |
||
20 | |||
21 | * ``<timestamp>`` |
||
22 | * ``<random-value>`` |
||
23 | * ``<SignatureInfo>`` |
||
24 | * ``<SignatureValue>`` |
||
25 | |||
26 | For prefix of repo /ucla/cs/repo/, the command will be defined as this: |
||
27 | |||
28 | /ucla/cs/repo/<command verb>/<RepoCommandParameter>/<timestamp>/<random-value>/<SignatureInfo>/<SignatureValue> |
||
29 | |||
30 | ### RepoCommandParameter |
||
31 | |||
32 | RepoCommandParameter ::= REPOCOMMANDPARAMETER-TYPE TLV-LENGTH |
||
33 | Name? |
||
34 | StartBlockId? |
||
35 | EndBlockId? |
||
36 | ProcessId? |
||
37 | 5 | Weiqi Shi | MaxInterestNum? |
38 | WatchTimeout? |
||
39 | WatchStatus? |
||
40 | 1 | Alex Afanasyev | InterestLifetime? |
41 | 10 | weijia yuan | ForwardingHint? |
42 | 1 | Alex Afanasyev | |
43 | 4 | Weiqi Shi | |
44 | 1 | Alex Afanasyev | Name ::= NAME-TYPE TLV-LENGTH NameComponent* |
45 | NameComponent ::= NAME-COMPONENT-TYPE TLV-LENGTH BYTE+ |
||
46 | |||
47 | StartBlockId ::= STARTBLOCKID-TYPE TLV-LENGTH |
||
48 | nonNegativeInteger |
||
49 | |||
50 | EndBlockId ::= ENDBLOCKID-TYPE TLV-LENGTH |
||
51 | nonNegativeInteger |
||
52 | |||
53 | ProcessId ::= PROCESSID-TYPE TLV-LENGTH |
||
54 | nonNegativeInteger |
||
55 | 3 | Weiqi Shi | |
56 | MaxInterestNum ::= MAX-INTEREST-NUM-TYPE TLV-LENGTH |
||
57 | nonNegativeInteger |
||
58 | |||
59 | WatchTimeout ::= WATCH-TIMEOUT-TYPE TLV-LENGTH |
||
60 | nonNegativeInteger |
||
61 | |||
62 | WatchStatus ::= WATCH-STATUS-TYPE TLV-LENGTH |
||
63 | nonNegativeInteger |
||
64 | |||
65 | InterestLifetime ::= INTEREST-LIFETIME-TYPE TLV-LENGTH |
||
66 | 1 | Alex Afanasyev | nonNegativeInteger |
67 | 10 | weijia yuan | |
68 | 12 | weijia yuan | ForwardingHint ::= FORWARDING-HINT-TYPE TLV-LENGTH |
69 | 11 | weijia yuan | Delegation+ |
70 | 1 | Alex Afanasyev | |
71 | |||
72 | #### StartBlockId, EndBlockId |
||
73 | |||
74 | StartBlockId and EndBlockId are used to process segmented data. StartBlockId indicate the first segment number and EndBlockId indicate the last segment number. Repo will process segment data whose segment id between StartBlockId and EndBlockId. If StartBlockId is missing, the first segment id the repo process is 0; If EndBlockId is missing, this scenario is described in specific process in Repo Insertion Command section and Repo Deletion Command section. |
||
75 | |||
76 | #### Conflict of Selectors and StartBlockId, EndBlockId |
||
77 | |||
78 | Repo cannot process command with both selectors and StartBlockId, EndBlockId in RepoCommandParameter. If the RepoCommandParameter carries both, repo will ignore this command interest and return with error code of 405. |
||
79 | |||
80 | #### ProcessId |
||
81 | |||
82 | 4 | Weiqi Shi | ProcessId is used by insertion and deletion check command to indicate specific insertion and deletion process. The ProcessId is fetched by repo command response of insertion and deletion command. |
83 | |||
84 | #### InterestLifetime |
||
85 | 1 | Alex Afanasyev | |
86 | 5 | Weiqi Shi | InterestLifetime is the maximum latency between interest sent and data received. If no data received after the InterestLifetime, the interest will time out. InterestLifetime is optional and a default value will be set if it is not specified. |
87 | 4 | Weiqi Shi | |
88 | #### MaxInterestNum |
||
89 | |||
90 | MaxInterestNum is used by watched prefix insertion protocol to set the upper limit of the total number of interests to be sent. |
||
91 | |||
92 | #### WatchTimeout |
||
93 | |||
94 | WatchTimeout is used by watched prefix insertion protocol to set the time duration of the whole watching process. |
||
95 | |||
96 | #### WatchStatus |
||
97 | |||
98 | WatchStatus is used by watched prefix insertion protocol to indicate the status of watching process. If the WatchStatus is true, then the watching prefix is running, otherwise, it is not. |
||
99 | 1 | Alex Afanasyev | |
100 | 13 | weijia yuan | #### ForwardingHint |
101 | |||
102 | The ForwardingHint element contains a list of name delegations, as defined in Link Object section. Each delegation implies that the requested Data packet can be retrieved by forwarding the Interest along the delegation path. Specifics of the forwarding logic for Interests with ForwardingHint will be defined in a separated document. |
||
103 | |||
104 | |||
105 | 1 | Alex Afanasyev | ## Repo Command Response |
106 | |||
107 | Repo command response is the response data packet of repo command interest. The response contains statuscode to indicate the status of command process and other information. A TLV-encoded block called ``RepoCommandResponse`` is encoded in content of the data packet. |
||
108 | |||
109 | RepoCommandResponse ::= INSERTSTATUS-TYPE TLV-LENGTH |
||
110 | ProcessId? |
||
111 | StatusCode |
||
112 | StartBlockId? |
||
113 | EndBlockId? |
||
114 | InsertNum? |
||
115 | DeleteNum? |
||
116 | |||
117 | ProcessId ::= PROCESSID-TYPE TLV-LENGTH |
||
118 | nonNegativeInteger |
||
119 | |||
120 | StatusCode ::= STATUSCODE-TYPE TLV-LENGTH |
||
121 | nonNegativeInteger |
||
122 | |||
123 | StartBlockId ::= STARTBLOCKID-TYPE TLV-LENGTH |
||
124 | nonNegativeInteger |
||
125 | |||
126 | EndBlockId ::= ENDBLOCKID-TYPE TLV-LENGTH |
||
127 | nonNegativeInteger |
||
128 | |||
129 | InsertNum ::= INSERTNUM-TYPE TLV-LENGTH |
||
130 | nonNegativeInteger |
||
131 | |||
132 | DeleteNum ::= DELETENUM-TYPE TLV-LENGTH |
||
133 | nonNegativeInteger |
||
134 | |||
135 | ### Name |
||
136 | Name indicates the Name in repocommandparameter of repo command |
||
137 | |||
138 | |||
139 | ### ProcessId |
||
140 | ProcessId is a random number generated by repo to indicate the number of the command process. Client could use this ProcessId to check the status of specific command. |
||
141 | |||
142 | ### StatusCode |
||
143 | |||
144 | StatusCode indicates the status of repo command process. The statuscodes of insert and deletion command are described in following insertion and deletion specification. |
||
145 | |||
146 | ### StartBlockId, EndBlockId |
||
147 | |||
148 | StartBlockId and EndBlockId are the same as those of RepoCommandParameter. If either of those in RepoCommandParameter is missing, repo will set them as the Id known for now. For example, if StartBlockId is missing in RepoCommandParameter, StartBlockId in response will be set 0. If EndBlockId is missing in RepoCommandParameter, EndBlockId will be set null untill Repo get FinalBlockId in data packet. If FinalBlockId in returned data packet is less than EndBlockId, the EndBlockId will be set FinalBlockId. |
||
149 | |||
150 | ### InsertNum, DeleteNum |
||
151 | 6 | Muktadir Chowdhury | InsertNum is used in reponse of insertion status check to indicate how many data packets have been successfully inserted into the repo. DeleteNum is used in response of deletion command and deletion check command. DeleteNum indicates how many data packets have been successfully deleted from repo. |
152 | 1 | Alex Afanasyev | |
153 | ## Repo TLV Type Encoding Number |
||
154 | |||
155 | Type | Number |
||
156 | ----------------------| ------- |
||
157 | RepoCommandParameter | 201 |
||
158 | StartBlockId | 204 |
||
159 | EndBlockId | 205 |
||
160 | ProcessId | 206 |
||
161 | RepoCommandResponse | 207 |
||
162 | StatusCode | 208 |
||
163 | InsertNum | 209 |
||
164 | DeleteNum | 210 |
||
165 | 5 | Weiqi Shi | MaxInterestNum | 211 |
166 | WatchTimeout | 212 |
||
167 | WatchStatus | 213 |
||
168 | InterestLifetime | 214 |
||
169 | 1 | Alex Afanasyev | |
170 | ## Repo Trust Model |
||
171 | |||
172 | The trust model of repo depends on people who deploy the repo service, such as PKI. Repo can specify their own verification policies, and data consumers can specify their own trust anchors. The NDN [FAQ](http://named-data.net/project/faq/#How_does_NDN8217s_8220trust_management8221_work) shows how NDN trust managment works. |