QPACK: add examples #4093
QPACK: add examples #4093
Conversation
Feedback welcome Fixes: #1454
ianswett
added
-qpack
editorial
* Fixed typos * Added more context around what the examples are doing * Added a Stream Cancellation example * Added more detail for field line representations
There was a problem hiding this comment.
It looks like there is a small error (just with attribution, not the encoding), but this covers most of the important cases. It's a shame that the indices are so small, because I don't think that this provides enough information for someone to understand how references to the dynamic table work. All references in examples have an encoded index of 0.
draft-ietf-quic-qpack.md
Outdated
| 510b 2f69 6e64 6578 | Literal Field Line with Name Reference | ||
| 2e68 746d 6c | (:path=/index.html) |
There was a problem hiding this comment.
It might help if you include the numeric values included in each of these descriptions. In this case, it's (static table 1).
draft-ietf-quic-qpack.md
Outdated
| Stream: Encoder | ||
| 3f8b | Set Dynamic Table Capacity=170 | ||
| 01c0 0c77 7777 2e69 | Insert With Name Reference (static table) | ||
| 6574 662e 6f72 67 | (:authortiy=www.ietf.org) |
There was a problem hiding this comment.
| 6574 662e 6f72 67 | (:authortiy=www.ietf.org) | |
| 7466 2e6f 7267 | (:authority=www.ietf.org) |
draft-ietf-quic-qpack.md
Outdated
|
|
||
| ~~~ | ||
| Stream: Encoder | ||
| 3f8b | Set Dynamic Table Capacity=170 |
There was a problem hiding this comment.
I read this as extending to the next byte.
| 3f8b | Set Dynamic Table Capacity=170 | |
| 3f8b01 | Set Dynamic Table Capacity=170 |
draft-ietf-quic-qpack.md
Outdated
| ~~~ | ||
| Stream: Encoder | ||
| 3f8b | Set Dynamic Table Capacity=170 | ||
| 01c0 0c77 7777 2e69 | Insert With Name Reference (static table) |
There was a problem hiding this comment.
| 01c0 0c77 7777 2e69 | Insert With Name Reference (static table) | |
| c00c 7777 772e 6965 | Insert With Name Reference (static table 0) |
draft-ietf-quic-qpack.md
Outdated
| The encoder sets the dynamic table capacity, inserts a header with a dynamic | ||
| name reference, then sends a potentially blocking, encoded field section | ||
| referencing this new entry. The decoder acknowledges processing the encoded | ||
| field section. |
There was a problem hiding this comment.
| field section. | |
| field section, which transitively acknowledges the encoder instructions up to the Required Insert Count. |
Or something like that.
draft-ietf-quic-qpack.md
Outdated
| Stream: 4 | ||
| 0280 | Required Insert Count = 1, Base = 0 | ||
| 10 | Indexed Field Line With Post-Base Index | ||
| | Absolute Index=1 |
There was a problem hiding this comment.
This one is useful to break down (RIC + delta_base + 0 = 1). Shame that we have such small numbers involved here.
|
@martinthomson: I can add a few more dynamic table entries to the examples to get indexes > 0 -- do you think 1-2 is good, or do you think it needs to be another order of magnitude? |
|
At most 2. The great thing about the current example is that it is small and easy to fit in your head. If you can reference the existing entries, that might help, but you don't have quite enough to work with. Maybe you can use :path to keep things neat. |
* Fixed some typos * Added absolute index calculations * Added one more entry to the dynamic table to allow for non-zero index
www.ietf.org -> www.example.com /standards -> /sample/path
There was a problem hiding this comment.
This is excellent. Thanks for adding the one extra reference and the www.example.com.
I didn't check the examples carefully, but I checked a couple and those line up neatly.
Feedback welcome
Fixes: #1454