NanoCoAP: Add helper functions for NanoCBOR payloads #19997
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bergzand
added
Type: new feature
bergzand
requested review from
miri64,
haukepetersen,
PeterKietzmann and
cgundogan
as code owners
github-actions
bot
added
Area: network
bergzand
changed the title
bergzand
force-pushed
the
pr/nanocbor/coap_helper
branch
from
e3abe4d to
3d422d7
Compare
|
This now also supports non-block-wise packets. |
This adds 3 functions for adding entity-tags to coap packets. The first simply adds the option to the coap packet with the supplied etag value. The second functionallow for adding a dummy etag value which is to be replaced later by the last function. This allows for allocating space for the option up front when the etag value itself is generated based on the payload
This adds an internal function to find options in a CoAP packet without modifying the coap_pkt_t struct
This adds a module to easily generate CBOR payloads in block-wise requests and responses.
bergzand
force-pushed
the
pr/nanocbor/coap_helper
branch
from
f62eb9f to
a74eb64
Compare
Teufelchen1
reviewed
Nov 24, 2023
| @@ -339,7 +339,7 @@ static int _gcoap_forward_proxy_copy_options(coap_pkt_t *pkt, | |||
| static const uint8_t tmp[COAP_ETAG_LENGTH_MAX] = { 0 }; | |||
| /* add slack to maybe add an ETag on stale cache hit later, as is done in | |||
| * gcoap_req_send() (which we circumvented in _gcoap_forward_proxy_via_coap()) */ | |||
| if (coap_opt_add_opaque(pkt, COAP_OPT_ETAG, tmp, sizeof(tmp))) { | |||
| if (coap_opt_add_etag(pkt, COAP_OPT_ETAG, tmp, sizeof(tmp))) { | |||
There was a problem hiding this comment.
Mh?
Suggested change
| if (coap_opt_add_etag(pkt, COAP_OPT_ETAG, tmp, sizeof(tmp))) { | |
| if (coap_opt_add_etag(pkt, tmp, sizeof(tmp))) { |
| @@ -1117,6 +1117,35 @@ static void test_nanocoap__token_length_ext_269(void) | |||
| TEST_ASSERT_EQUAL_INT(14, hdr->ver_t_tkl & 0xf); | |||
| } | |||
|
|
|||
| static void test_nanocoap__replace_etag(void) | |||
There was a problem hiding this comment.
This function name does not explain your intend well enough. Remember to unit test behavior so ideally something along test_that_nanocoap_replaces_an_etag_within_a_prebuild_pkt_without_segfault 😈
| } | ||
| } | ||
|
|
||
| static ssize_t _etag_finish(coap_pkt_t *pdu, coap_nanocbor_slicer_helper_t *helper) |
There was a problem hiding this comment.
You are using a lot of 'private' functions in this PR with names I find hard to relate. I would appreciate if you could make them a bit more descriptive or add small comments?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Contribution description
This adds a module to easily generate CBOR payloads in block-wise requests and responses. It wraps NanoCoAP and gcoap around the NanoCBOR stream-like interface to generate sliced block-wise payloads automatically from nanocbor encoder serialization calls. The content is serialized for every individual block-wise request. This module supports both block1 and block2 payloads and will automatically generate and update the etag option in the packet.
This module assumes that the serialized content does not change between successive serializations. In case this happens it should be detected via the etag that can be included in the packet.
Testing procedure
I've extended the example gcoap_block_server with a CBOR encoded response leveraging this module.
Issues/PRs references
Needs #19980
and #19981