Project

General

Profile

Basic Repo Insertion Protocol » History » Version 5

Alex Afanasyev, 07/23/2014 04:40 PM

1 1 Alex Afanasyev
Basic Repo Insertion Protocol
2
=============================
3
4 2 Alex Afanasyev
Basic repo insertion protocol uses **[[Repo Command]]**.
5 1 Alex Afanasyev
6 5 Alex Afanasyev
Repo insertion command requests that the repo retrieve and store content. 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 respond with a data object containing OK status and start to send the interest to fetch the data to insert.
7 4 Alex Afanasyev
8
Segmented data insertion is also supported in the insertion protocol. Segmentation info is defined in RepoCommandParameter. If the content is segmented, the final segment id will be encoded in this block.
9
10
11 3 Alex Afanasyev
## Basic operations
12
13
### Insert data
14
15
Command verb: **insert**
16
17 1 Alex Afanasyev
The name semantics follows the format of the repo command. The <command verb> is defined as ``insert``.
18
For example, for ``<repo prefix>`` as ``/ucla/cs/repo``, the following is an example:
19
20
    /ucla/cs/repo/insert/<RepoCommandParameter>/<timestamp>/<random-value>/<SignatureInfo>/<SignatureValue>
21
22
### Insertion status check
23
24 3 Alex Afanasyev
Command verb: **insert check**
25
26 1 Alex Afanasyev
During the insertion progress, the requester could send insertion status check command to check the status of the insertion progress. This status check command is also signed interest. The semantics of insertion status check command is shown as follows:
27
28
<command verb> equals to ``insert check``. For example:
29
30
    /ucla/cs/repo/insert check/<RepoCommandParameter>/<timestamp>/<random-value>/<SignatureInfo>/<SignatureValue>
31
32 3 Alex Afanasyev
## Formats
33
34 1 Alex Afanasyev
### RepoCommandParameter
35
36
RepoCommandParameter of insertion and insertion check command follows that in Repo Command section. Name, Selectors, StartBlockId, EndBlockId are used in insertion. Name and ProcessId are used in insertion check command.
37
38
In insertion command, Name represents the name or prefix of data for repo to fetch. If selectors are set, repo will use these selectors to fetch the data. If StartBlockId or EndBlockId is set, the repo will retrieve segmented data with segment number between StartBlockId and EndBlockId. If Repo Insert Command carries both Selectors and StartBlockId, EndBlockId, repo would ignore it and response with statuscode of 405.
39
40
In insertion check command, Name represents name or prefix of data for repo to fetch. ProcessId is set by the RepoCommandResponse to indicate specified process.
41
42 5 Alex Afanasyev
### Insertion status response
43 1 Alex Afanasyev
44
This insert status data object could be the response data object of both insert command and insert check command. It will follow the format of repo command response.
45
46 5 Alex Afanasyev
StatusCode indicates the status of insertion. InsertNum represents how many data has been interested into the repo. StartBlockId and EndBlockId is the start and end segment id of data inserted. InsertNum is the how many data segments have been inserted. ProcessId indicates an ID of process, a random number generated by repo.
47 1 Alex Afanasyev
48 5 Alex Afanasyev
For insert command, status code will be set according to definition below, StartBlockId and EndBlockId will be set according to the insert command. If StartBlockId in RepoCommandParameter is missing, it will be set 0 in response. If EndBlockId is missing, it will not be set.
49 1 Alex Afanasyev
50
For insert check command, status code will be set according to definition below, StartBlockId and EndBlockId will be set according to the StartBlockId and EndBlockId that repo is using, insertnum will be set according to insertion progress. ProcessId is set according to the ID of process checked. If EndBlockId has not been decided, this EndBlockId will not be set in response.
51
52
StatusCode Definition:
53
54
``StatusCode`` | Description
55
-------------- | ----------------------------------------------
56
``100``        | The command is OK. can start to fetch the data
57
``200``        | All the data has been inserted
58
``300``        | This insertion is in progress
59
``401``        | This insertion command or insertion check command is invalidated
60
``402``        | Selectors and BlockId both present
61
``403``        | Malformed Command
62
``404``        | No such this insertion is in progress
63
``405``        | EndBlockId Missing Timeout
64
65
### EndBlockId Missing Timeout
66
67 5 Alex Afanasyev
If StartBlockId presents but EndBlockId is missing, and returned data packets do not contain FinalBlockId, the repo will continuously fetch the data. An EndBlockId missing timeout is set to prevent this occasion. The repo will start a timer when StartBlockId presents but EndBlockId is missing. When timeout happens, repo will stop fetching data to store and end insert process. If an insert check command arrives during this insert process, the time of timer is set to 0. If data packet containing FinalBlockId arrives, this timeout timer will be dismissed.
68 1 Alex Afanasyev
69 3 Alex Afanasyev
## Protocol Process
70 1 Alex Afanasyev
71
1. start to authorize the command; if authorization does not fail immediately, go to step 3
72
73
2. send a negative response indicating authorization failure, and abort these steps, insert process ends (StatusCode: 401)
74
75
3. if  both StartBlockId and EndBlockId are missing, go to step 7
76
77
4. if either StartBlockId or EndBlockId is present, and one of supported selectors is present. send negative reponse back and abort steps, insert process ends (StatusCode: 402)
78
79
5. if both StartBlockId and EndBlockId are present, and StartBlockId is less than or equal to EndBlockId, go to step 7
80
81
6. send a negative response indicating malformed command, and abort these steps, insert process ends (StatusCode: 403)
82
83
7. wait for authorization completion
84
85
8. if authorization fails, go to step 2 (StatusCode: 401)
86
87
9. send a positive response indicating insert is in progress (StatusCode: 200)
88
89
10. if either StartBlockId or EndBlockId is present, go to step 16
90
91
11. start to retrieve Name with selectors in insert command
92
93
12. wait for retrieval completion
94
95
13. if retrieval fails, go to step 27
96
97
14. store retrieved Data packet
98
99
15. abort these steps, insert process ends
100
101
16. if StartBlockId is missing, set StartBlockId 0. If EndBlockId is missing, EndBlockId will be missing unless get FinalBlockId in comming data packets, start EndBlockId Misiing Timeout timer.
102
103
17. append StartBlockId to Name
104
105
18. start to retrieve Name
106
107
19. wait for retrieval completion
108
109
20. if retrieval fails, go to step 26
110
111
21. store retrieved Data packet
112
113
22. if retrieved Data packet contains FinalBlockId, and FinalBlockId is less than EndBlockId or EndBlockId is missing, let EndBlockId be FinalBlockId
114
115
23. if the last component of Name is greater than or equal to EndBlockId, abort these steps, insert process ends
116
117
24. increment the last component of Name
118
119
25. go to step 17
120
121
26. retrieve data with this data another 2 times. If these 2 retrieval both failes, abort these steps. if success, go to step 21
122
123
27. retrieve data with this data another 2 times. If these 2 retrieval both failes, abort these steps. if success, go to step 14
124
125
If EndBlockId Missing Timeout timer starts, repo will monitor this timer during step 17~26. If this timeout occurs, abort insert command process immediately.
126
127
Implementation MAY pipeline the Interests.
128
129
### Repo insert check command progress
130
131
Implementation MAY publish a notification of status regarding insert progress. The process of status check is as follows:
132
133
1. start to authorize the insert status command, if fails go to 2, if success, go to 3
134
135
2. send a negative response indicating authorization failure, and abort these steps (StatusCode: 401)
136
137
3. start to check the progress of the insert with the data name in the command. If no such progress is found, go to 4. or go to 5.
138
139 5 Alex Afanasyev
4. response status with status code, abort check process. (StatusCode: 404)
140 1 Alex Afanasyev
141 5 Alex Afanasyev
5. check the status of insertion. return the status of insertion progress. If a EndBlockId Missing Timeout timer is running, set this timer to 0. About check process. (StatusCode: 300)
142 1 Alex Afanasyev
143
### Protocol diagram:
144
145
    Requester                     Repo                          Data producer
146
        |                           |                                 |
147
        |                           |                                 |
148
      +---+  Insert command       +---+                               |
149
      |   | --------------------> |   |                               |
150
      +---+                       |   |                               |
151
        |                         |   |                               |
152
      +---+   Confirm start       |   |                               |
153
      |   | <==================== |   |                               |
154
      +---+   Reject command      +---+                               |
155
        |     (with status code)    |                                 |
156
        |                         +---+     Interest for Data       +---+
157
        |                         |   | --------------------------> |   |
158
        |                         +---+                             |   |
159
        |                           |                               |   |
160
        |                         +---+       Data segment          |   |
161
        |                         |   | <========================== |   |
162
        |                         +---+                             +---+
163
        |                           |                                 |
164
        |                           ~                                 ~
165
        |                           ~                                 ~
166
        |                           |                                 |
167
        |                         +---+     Interest for Data       +---+
168
        |                         |   | --------------------------> |   |
169
        |                         +---+                             |   |
170
        |                           |                               |   |
171
        |                         +---+       Data segment          |   |
172
        |                         |   | <========================== |   |
173
        |                         +---+                             +---+
174
        |                           |                                 |
175
        |                           |                                 |
176
        |                           ~                                 ~
177
        |                           ~                                 ~
178
        |                           |                                 |
179
        |                           |                                 |
180
        |                           |                                 |
181
      +---+   Status interest     +---+                               |
182
      |   | --------------------> |   |                               |
183
      +---+                       |   |                               |
184
        |                         |   |                               |
185
      +---+    Status response    |   |                               |
186
      |   | <==================== |   |                               |
187
      +---+                       +---+                               |
188
        |                           |                                 |
189
        |                           |                                 |