Project

General

Profile

Repo Command » History » Version 7

Haitao Zhang, 02/14/2018 01:58 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 7 Haitao Zhang
                                                    Name?
34
                                                    StartBlockId?
35
                                                    EndBlockId?
36
                                                    ProcessId?
37
                                                    MaxInterestNum?
38
                                                    WatchTimeout?
39
                                                    WatchStatus?
40
                                                    InterestLifetime?
41 3 weijia yuan
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
#### ProcessId
74
75
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.
76
77
#### InterestLifetime
78
79
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.
80
81
#### MaxInterestNum
82
83
MaxInterestNum is used by watched prefix insertion protocol to set the upper limit of the total number of interests to be sent.
84
85
#### WatchTimeout
86
87
WatchTimeout is used by watched prefix insertion protocol to set the time duration of the whole watching process.
88
89
#### WatchStatus
90
91
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.
92
93
## Repo Command Response
94
95
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.
96
97
    RepoCommandResponse   ::= INSERTSTATUS-TYPE TLV-LENGTH
98
                               ProcessId?
99
                               StatusCode
100
                               StartBlockId?
101
                               EndBlockId?
102
                               InsertNum?
103
                               DeleteNum?
104
105
    ProcessId            ::= PROCESSID-TYPE TLV-LENGTH
106
                                nonNegativeInteger 
107
    
108
    StatusCode            ::= STATUSCODE-TYPE TLV-LENGTH
109
                                nonNegativeInteger    
110
111
    StartBlockId          ::= STARTBLOCKID-TYPE TLV-LENGTH
112
                                nonNegativeInteger
113
    
114
    EndBlockId            ::= ENDBLOCKID-TYPE TLV-LENGTH
115
                                nonNegativeInteger
116
117
    InsertNum             ::= INSERTNUM-TYPE TLV-LENGTH
118
                                nonNegativeInteger
119
120
    DeleteNum             ::= DELETENUM-TYPE TLV-LENGTH
121
                                nonNegativeInteger
122
123
### Name
124
Name indicates the Name in repocommandparameter of repo command
125
126
127
### ProcessId
128
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.
129
130
### StatusCode
131
132
StatusCode indicates the status of repo command process. The statuscodes of insert and deletion command are described in following insertion and deletion specification.
133
134
### StartBlockId, EndBlockId
135
136
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.
137
138
### InsertNum, DeleteNum
139
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.
140
141
## Repo TLV Type Encoding Number
142
143
Type                  | Number
144
----------------------| -------
145
RepoCommandParameter  | 201
146
StartBlockId          | 204
147
EndBlockId            | 205
148
ProcessId             | 206
149
RepoCommandResponse   | 207
150
StatusCode            | 208
151
InsertNum             | 209
152
DeleteNum             | 210
153
MaxInterestNum        | 211
154
WatchTimeout          | 212
155
WatchStatus           | 213
156
InterestLifetime      | 214
157
158
## Repo Trust Model
159
160
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.