riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #11741 from jcarrano/deprecate-ubjson

Browse Source 
sys/ubjson: deprecate module.
This commit is contained in:
Leandro Lanzieri 2019-06-28 19:41:21 +02:00 committed by GitHub
commit 326ec30074
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
sys/include/ubjson.h
View File

@ -20,12 +20,16 @@
* @defgroup sys_ubjson Universal Binary JSON library * @defgroup sys_ubjson Universal Binary JSON library
* @ingroup sys_serialization * @ingroup sys_serialization
* @brief Provides a library to read and write UBJSON serialized data * @brief Provides a library to read and write UBJSON serialized data
*
* @deprecated This module is deprecated and will be removed in release 2020.01.
* @{ * @{
* *
* @file * @file
* @brief Headers for the UBJSON module * @brief Headers for the UBJSON module
* *
* @author René Kijewski <rene.kijewski@fu-berlin.de> * @author René Kijewski <rene.kijewski@fu-berlin.de>
*
* @deprecated This module is deprecated and will be removed in release 2020.01.
*/ */
#ifndef UBJSON_H #ifndef UBJSON_H
@ -187,14 +191,15 @@ typedef enum {
UBJSON_SIZE_ERROR, /**< the length of a field exceeded SSIZE_MAX */ UBJSON_SIZE_ERROR, /**< the length of a field exceeded SSIZE_MAX */
} ubjson_read_callback_result_t; } ubjson_read_callback_result_t;
struct ubjson_cookie; struct __attribute__ ((deprecated("The UBJSON module will be removed in release 2020.01"))) ubjson_cookie;
/** /**
* @brief A cookie passed between the read and write functions. * @brief A cookie passed between the read and write functions.
* @details You probably want to wrap the cookie in some other data structure, * @details You probably want to wrap the cookie in some other data structure,
* which you retrieve with container_of() in the callback. * which you retrieve with container_of() in the callback.
*/ */
typedef struct ubjson_cookie ubjson_cookie_t; typedef struct ubjson_cookie ubjson_cookie_t
__attribute__ ((deprecated("The UBJSON module will be removed in release 2020.01")));
/** /**
* @brief Method called by ubjson_read() to get more data. * @brief Method called by ubjson_read() to get more data.
@ -288,6 +293,10 @@ ubjson_read_callback_result_t ubjson_read_next(ubjson_cookie_t *__restrict cooki
* *
* You probably want to wrap the cookie in some other data structure, * You probably want to wrap the cookie in some other data structure,
* which you retrieve with container_of() in the callback. * which you retrieve with container_of() in the callback.
*
* @deprecated This function and its containing module are deprecated and
* will be removed in release 2020.01.
*
* @param[in] cookie The cookie that is passed to the callback function. * @param[in] cookie The cookie that is passed to the callback function.
* @param[in] read The function that is called to receive more data. * @param[in] read The function that is called to receive more data.
* @param[in] callback The callback function. * @param[in] callback The callback function.
@ -433,6 +442,10 @@ ubjson_read_callback_result_t ubjson_read_object(ubjson_cookie_t *__restrict coo
* The programmer needs to ensure that the API is used correctly. * The programmer needs to ensure that the API is used correctly.
* The library won't complain if you write multiple values that are not * The library won't complain if you write multiple values that are not
* inside an array or object. The result will just not be properly serialized. * inside an array or object. The result will just not be properly serialized.
*
* @deprecated This function and its containing module are deprecated and
* will be removed in release 2020.01
*
* @param[out] cookie The cookie that will be passed to ubjson_write_null() and friends. * @param[out] cookie The cookie that will be passed to ubjson_write_null() and friends.
* @param[in] write_fun The function that will be called to write data. * @param[in] write_fun The function that will be called to write data.
*/ */

2
tests/unittests/tests-ubjson/Makefile.include
View File

@ -1,2 +1,4 @@
USEMODULE += ubjson USEMODULE += ubjson
USEMODULE += pipe USEMODULE += pipe
CFLAGS += -Wno-error=deprecated-declarations