Skip to content

Commit 0115904

Browse files
committed
formatting
1 parent 44cdf96 commit 0115904

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

Protocol.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ For transports that do not provide framing, such as TCP, the Frame Length MUST b
4040
* __Frame Length__: (31 = max 2,147,483,647 bytes) Length of Frame. Including header. Only used for TCP.
4141
* __Version__: (8) Current version is 0.
4242
* __Flags__:
43-
* __I__gnore: Ignore frame if not understood
43+
* (__I__)gnore: Ignore frame if not understood
4444
* __Frame Type__: (16) Type of Frame.
4545
* __Stream ID__: (64) Stream Identifier for this frame.
4646

@@ -79,9 +79,6 @@ Setup headers must always use Stream ID 0 as they pertain to the connection.
7979

8080
Frame Contents
8181

82-
1. __Setup Data__: includes payload describing connection capabilities of the endpoint sending the
83-
Setup header.
84-
8582
```
8683
0 1 2 3
8784
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
@@ -96,12 +93,13 @@ Setup header.
9693
Setup Data
9794
```
9895

96+
* __Setup Data__: includes payload describing connection capabilities of the endpoint sending the
97+
Setup header.
98+
9999
### Request Response Frame
100100

101101
Frame Contents
102102

103-
1. __Request Data__: identification of the service being requested along with parameters for the request.
104-
105103
```
106104
0 1 2 3
107105
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
@@ -116,12 +114,12 @@ Frame Contents
116114
Request Data
117115
```
118116

117+
* __Request Data__: identification of the service being requested along with parameters for the request.
118+
119119
### Request Fire-n-Forget Frame
120120

121121
Frame Contents
122122

123-
1. __Request Data__: identification of the service being requested along with parameters for the request.
124-
125123
```
126124
0 1 2 3
127125
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
@@ -136,13 +134,12 @@ Frame Contents
136134
Request Data
137135
```
138136

137+
* __Request Data__: identification of the service being requested along with parameters for the request.
138+
139139
### Request Stream Frame
140140

141141
Frame Contents
142142

143-
1. __Initial Request N__: initial Request N value. 64-bit integer.
144-
1. __Request Data__: identification of the service being requested along with parameters for the request.
145-
146143
```
147144
0 1 2 3
148145
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
@@ -160,13 +157,13 @@ Frame Contents
160157
Request Data
161158
```
162159

160+
* __Initial Request N__: initial Request N value. 64-bit integer.
161+
* __Request Data__: identification of the service being requested along with parameters for the request.
162+
163163
### Request Subscription Frame
164164

165165
Frame Contents
166166

167-
1. __Initial Request N__: initial Request N value. 64-bit integer.
168-
1. __Request Data__: identification of the service being requested along with parameters for the request.
169-
170167
```
171168
0 1 2 3
172169
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
@@ -184,12 +181,13 @@ Frame Contents
184181
Request Data
185182
```
186183

184+
* __Initial Request N__: initial Request N value. 64-bit integer.
185+
* __Request Data__: identification of the service being requested along with parameters for the request.
186+
187187
### Request N Frame
188188

189189
Frame Contents
190190

191-
1. __Request N__: 64-bit integer value of items to request.
192-
193191
```
194192
0 1 2 3
195193
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
@@ -206,6 +204,8 @@ Frame Contents
206204
+---------------------------------------------------------------+
207205
```
208206

207+
* __Request N__: 64-bit integer value of items to request.
208+
209209
### Cancel Frame
210210

211211
Frame Contents
@@ -241,11 +241,11 @@ Frame Contents
241241
Response Data
242242
```
243243

244-
1. Flag Fragment Information:
245-
1. __Begin Bit__: bit to indicate beginning of a fragmented response.
246-
1. __End Bit__: bit to indicate end of a fragmented response.
247-
1. __Complete Bit__: bit to indicate COMPLETE.
248-
1. __Response Data__: payload for onNext.
244+
* __Flags__:
245+
* (__B__)egin: bit to indicate beginning of a fragmented response.
246+
* (__E__)nd: bit to indicate end of a fragmented response.
247+
* (__C__)omplete: bit to indicate COMPLETE.
248+
* __Response Data__: payload for onNext.
249249

250250
A Response is generally referred to as a NEXT.
251251

0 commit comments

Comments
 (0)