mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2025-12-16 01:53:51 +01:00
78 lines
2.2 KiB
C
78 lines
2.2 KiB
C
/*
|
|
* Copyright (C) 2022 ML!PA Consulting GmbH
|
|
*
|
|
* This file is subject to the terms and conditions of the GNU Lesser
|
|
* General Public License v2.1. See the file LICENSE in the top level
|
|
* directory for more details.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
/**
|
|
* @ingroup net_nanosock
|
|
* @brief NanoCoAP Link Format helper functions
|
|
*
|
|
* @{
|
|
*
|
|
* @file
|
|
* @brief NanoCoAP Link Format ([RFC 6690](https://www.rfc-editor.org/rfc/rfc6690.html))
|
|
* helper functions
|
|
*
|
|
* @author Benjamin Valentin <benjamin.valentin@ml-pa.com>
|
|
*/
|
|
|
|
#include "net/nanocoap_sock.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Callback function called for each resource on the directory
|
|
*
|
|
* @param[in] entry Resource entry from the server
|
|
* @param[in] ctx Optional function context
|
|
*
|
|
* @returns 0 on success
|
|
* @returns <0 on error
|
|
*/
|
|
typedef int (*coap_link_format_handler_t)(char *entry, void *ctx);
|
|
|
|
/**
|
|
* @brief Downloads the resource behind @p path via blockwise GET
|
|
*
|
|
* @param[in] sock Connection to the server
|
|
* @param[in] path path of the resource
|
|
* @param[in] cb Callback to execute for each resource entry
|
|
* @param[in] arg Optional callback argument
|
|
* @param[out] dirent_buf Response buffer
|
|
* @param[in] dirent_buf_len Length of the response buffer
|
|
*
|
|
* @returns 0 on success
|
|
* @returns <0 on error
|
|
*/
|
|
int nanocoap_link_format_get(nanocoap_sock_t *sock, const char *path,
|
|
coap_link_format_handler_t cb, void *arg,
|
|
char *dirent_buf, size_t dirent_buf_len);
|
|
|
|
/**
|
|
* @brief Downloads the resource behind @p url via blockwise GET
|
|
*
|
|
* @param[in] url URL to the resource
|
|
* @param[in] cb Callback to execute for each resource entry
|
|
* @param[in] arg Optional callback argument
|
|
* @param[out] dirent_buf Response buffer
|
|
* @param[in] dirent_buf_len Length of the response buffer
|
|
*
|
|
* @returns 0 on success
|
|
* @returns <0 on error
|
|
*/
|
|
int nanocoap_link_format_get_url(const char *url,
|
|
coap_link_format_handler_t cb, void *arg,
|
|
char *dirent_buf, size_t dirent_buf_len);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
/** @} */
|