Project

General

Profile

Repo Command » History » Version 5

weijia yuan, 02/01/2018 04:54 PM

1 2 weijia yuan
Repo Command
2 1 weijia yuan
=============================
3 3 weijia yuan
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 5 weijia yuan
   RepoCommandParameter ::= REPOCOMMANDPARAMETER-TYPE TLV-LENGTH
33 3 weijia yuan
                               Name?
34
                               StartBlockId?
35
                               EndBlockId?
36
                               ProcessId?
37
                               MaxInterestNum?
38
                               WatchTimeout?
39
                               WatchStatus?
40
                               InterestLifetime?
41
42
43
44
    Name                  ::= NAME-TYPE TLV-LENGTH NameComponent*
45
    NameComponent         ::= NAME-COMPONENT-TYPE TLV-LENGTH BYTE+
46
47
   
48
    StartBlockId          ::= STARTBLOCKID-TYPE TLV-LENGTH
49
                               nonNegativeInteger
50
    
51
    EndBlockId            ::= ENDBLOCKID-TYPE TLV-LENGTH
52
                               nonNegativeInteger
53
54
    ProcessId             ::= PROCESSID-TYPE TLV-LENGTH
55
                               nonNegativeInteger
56
57
    MaxInterestNum        ::= MAX-INTEREST-NUM-TYPE TLV-LENGTH
58
                               nonNegativeInteger
59
60
    WatchTimeout          ::= WATCH-TIMEOUT-TYPE TLV-LENGTH
61
                               nonNegativeInteger
62
63
    WatchStatus           ::= WATCH-STATUS-TYPE TLV-LENGTH
64
                               nonNegativeInteger
65
66
    InterestLifetime      ::= INTEREST-LIFETIME-TYPE TLV-LENGTH
67
                               nonNegativeInteger
68
69
#### StartBlockId, EndBlockId
70
71
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.
72
73
#### Conflict of Selectors and StartBlockId, EndBlockId
74
75
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.
76
77
#### ProcessId
78
79
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.
80
81
#### InterestLifetime
82
83
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.
84
85
#### MaxInterestNum
86
87
MaxInterestNum is used by watched prefix insertion protocol to set the upper limit of the total number of interests to be sent.
88
89
#### WatchTimeout
90
91
WatchTimeout is used by watched prefix insertion protocol to set the time duration of the whole watching process.
92
93
#### WatchStatus
94
95
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.
96
97
## Repo Command Response
98
99
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.
100
101
    RepoCommandResponse   ::= INSERTSTATUS-TYPE TLV-LENGTH
102
                               ProcessId?
103
                               StatusCode
104
                               StartBlockId?
105
                               EndBlockId?
106
                               InsertNum?
107
                               DeleteNum?
108
109
    ProcessId            ::= PROCESSID-TYPE TLV-LENGTH
110
                                nonNegativeInteger 
111
    
112
    StatusCode            ::= STATUSCODE-TYPE TLV-LENGTH
113
                                nonNegativeInteger    
114
115
    StartBlockId          ::= STARTBLOCKID-TYPE TLV-LENGTH
116
                                nonNegativeInteger
117
    
118
    EndBlockId            ::= ENDBLOCKID-TYPE TLV-LENGTH
119
                                nonNegativeInteger
120
121
    InsertNum             ::= INSERTNUM-TYPE TLV-LENGTH
122
                                nonNegativeInteger
123
124
    DeleteNum             ::= DELETENUM-TYPE TLV-LENGTH
125
                                nonNegativeInteger
126
127
### Name
128
Name indicates the Name in repocommandparameter of repo command
129
130
131
### ProcessId
132
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.
133
134
### StatusCode
135
136
StatusCode indicates the status of repo command process. The statuscodes of insert and deletion command are described in following insertion and deletion specification.
137
138
### StartBlockId, EndBlockId
139
140
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.
141
142
### InsertNum, DeleteNum
143
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.
144
145
## Repo TLV Type Encoding Number
146
147
Type                  | Number
148
----------------------| -------
149
RepoCommandParameter  | 201
150
StartBlockId          | 204
151
EndBlockId            | 205
152
ProcessId             | 206
153
RepoCommandResponse   | 207
154
StatusCode            | 208
155
InsertNum             | 209
156
DeleteNum             | 210
157
MaxInterestNum        | 211
158
WatchTimeout          | 212
159
WatchStatus           | 213
160
InterestLifetime      | 214
161
162
## Repo Trust Model
163
164
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.