kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-31 09:21:19 +01:00
Code Releases Activity

Merge pull request #16712 from miri64/gcoap+nanocoap/enh/buffer-path

Browse Source 
nanocoap & gcoap: allow path to be non-`\0`-terminated.
This commit is contained in:
benpicco 2021-08-05 17:25:41 +02:00 committed by GitHub
commit 81df6d6fcb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 58 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
sys/include/net/gcoap.h
View File

@ -844,15 +844,43 @@ void gcoap_register_listener(gcoap_listener_t *listener);
* @param[in] len Length of the buffer
* @param[in] code Request code, one of COAP_METHOD_XXX or COAP_CODE_EMPTY
* to ping
* @param[in] path Resource path, may be NULL
* @param[in] path Resource path, may be NULL. @p path_len will be ignored
* in that case.
* @param[in] path_len Length of @p path.
*
* @pre @p path must start with `/` if not NULL
*
* @return 0 on success
* @return < 0 on error
*/
int gcoap_req_init(coap_pkt_t *pdu, uint8_t *buf, size_t len,
unsigned code, const char *path);
int gcoap_req_init_path_buffer(coap_pkt_t *pdu, uint8_t *buf, size_t len,
unsigned code, const char *path,
size_t path_len);
/**
* @brief Initializes a CoAP request PDU on a buffer.
*
* If @p code is COAP_CODE_EMPTY, prepares a complete "CoAP ping" 4 byte empty
* message request, ready to send.
*
* @param[out] pdu Request metadata
* @param[out] buf Buffer containing the PDU
* @param[in] len Length of the buffer
* @param[in] code Request code, one of COAP_METHOD_XXX or COAP_CODE_EMPTY
* to ping
* @param[in] path `\0`-terminated resource path, may be NULL
*
* @pre @p path must start with `/` if not NULL
*
* @return 0 on success
* @return < 0 on error
*/
static inline int gcoap_req_init(coap_pkt_t *pdu, uint8_t *buf, size_t len,
unsigned code, const char *path)
{
return gcoap_req_init_path_buffer(pdu, buf, len, code, path,
(path) ? strlen(path) : 0U);
}
/**
* @brief Writes a complete CoAP request PDU when there is not a payload

24
sys/include/net/nanocoap.h
View File

@ -1131,7 +1131,7 @@ static inline ssize_t coap_opt_add_string(coap_pkt_t *pkt, uint16_t optnum,
* @note Use this only for null-terminated strings.
*
* @param[in,out] pkt Packet being built
* @param[in] path Resource (sub)path
* @param[in] path `\0`-terminated resource (sub)path
*
* @pre ((pkt != NULL) && (path != NULL))
*
@ -1144,6 +1144,28 @@ static inline ssize_t coap_opt_add_uri_path(coap_pkt_t *pkt, const char *path)
return coap_opt_add_string(pkt, COAP_OPT_URI_PATH, path, '/');
}
/**
* @brief Adds one or multiple Uri-Path options in the form '/path' into pkt
*
* @note Use this only for null-terminated strings.
*
* @param[in,out] pkt Packet being built
* @param[in] path Resource (sub)path
* @param[in] path_len Length of @p path
*
* @pre ((pkt != NULL) && (path != NULL))
*
* @return number of bytes written to pkt buffer
* @return <0 on error
* @return -ENOSPC if no available options or pkt full
*/
static inline ssize_t coap_opt_add_uri_path_buffer(coap_pkt_t *pkt,
const char *path,
size_t path_len)
{
return coap_opt_add_chars(pkt, COAP_OPT_URI_PATH, path, path_len, '/');
}
/**
* @brief Finalizes options as required and prepares for payload
*

8
sys/net/application_layer/gcoap/gcoap.c
View File

@ -1023,8 +1023,8 @@ void gcoap_register_listener(gcoap_listener_t *listener)
}
}
int gcoap_req_init(coap_pkt_t *pdu, uint8_t *buf, size_t len,
unsigned code, const char *path)
int gcoap_req_init_path_buffer(coap_pkt_t *pdu, uint8_t *buf, size_t len,
unsigned code, const char *path, size_t path_len)
{
assert((path == NULL) || (path[0] == '/'));
@ -1055,8 +1055,8 @@ int gcoap_req_init(coap_pkt_t *pdu, uint8_t *buf, size_t len,
}
coap_pkt_init(pdu, buf, len, res);
if (path != NULL) {
res = coap_opt_add_uri_path(pdu, path);
if ((path != NULL) && (path_len > 0)) {
res = coap_opt_add_uri_path_buffer(pdu, path, path_len);
}
return (res > 0) ? 0 : res;
}