Lines Matching +full:use +full:- +full:case
3 * Copyright (c) 2017-2019 Foundries.io
5 * SPDX-License-Identifier: Apache-2.0
10 * @brief LwM2M high-level API
13 * LwM2M high-level interface is defined in this header.
18 * OMA-TS-LightweightM2M_Core-V1_1_1-20190617-A
20 * @defgroup lwm2m_api LwM2M high-level API
46 /* clang-format off */
61 /* clang-format on */
73 /* clang-format off */
88 /* clang-format on */
105 uint8_t level; /**< Path level (0-4). Ex. 4 = resource instance. */
157 /** De-registration failure */
169 /** De-register */
225 * use. The underlying type is ``struct lwm2m_message``, but since it's
265 /** Flag to indicate if context should use DTLS.
266 * Enabled via the use of coaps:// protocol prefix in connection
300 * callback in case of socket errors on receive.
321 * transmission states and use that information to control various power
355 * use this callback to get the buffer pointer and length instead
365 * (typically 0 for non-multi instance resources).
379 * make use of this callback to pass the data back to the client or LwM2M
382 * On a block-wise transfers the handler is called multiple times with the data blocks
393 * (typically 0 for non-multi instance resources).
397 * block of data. For non-block transfers this is always
400 * For non-block transfers this is 0.
401 * @param[in] offset Offset of the data block. For non-block transfers this is always 0.
414 * Various object instance and resource-based events in the LwM2M engine
509 * @return 0 for success or negative in case of error.
517 * An LwM2M client or the LwM2M Firmware Update object use the following codes
566 * LwM2M clients use this function to register a callback for receiving the
583 * LwM2M clients use this function to register a callback for receiving the
602 * LwM2M clients use this function to register a callback to perform actions
619 * LwM2M clients use this function to register a callback to perform actions
638 * LwM2M clients use this function to register a callback for receiving the
655 * LwM2M clients use this function to register a callback for receiving the
796 * LwM2M clients use this function to modify the pmin attribute
805 * @return 0 for success or negative in case of error.
813 * LwM2M clients use this function to modify the pmax attribute
822 * @return 0 for success or negative in case of error.
830 * LwM2M clients use this function to create non-default LwM2M objects:
836 * @return 0 for success or negative in case of error.
843 * LwM2M clients use this function to delete LwM2M objects.
847 * @return 0 for success or negative in case of error.
854 * Use this function before writing to multiple resources. This halts the
855 * lwm2m main thread until all the write-operations are finished.
873 * @return 0 for success or negative in case of error.
883 * @return 0 for success or negative in case of error.
893 * @return 0 for success or negative in case of error.
903 * @return 0 for success or negative in case of error.
913 * @return 0 for success or negative in case of error.
923 * @return 0 for success or negative in case of error.
933 * @return 0 for success or negative in case of error.
943 * @return 0 for success or negative in case of error.
953 * @return 0 for success or negative in case of error.
963 * @return 0 for success or negative in case of error.
973 * @return 0 for success or negative in case of error.
983 * @return 0 for success or negative in case of error.
993 * @return 0 for success or negative in case of error.
1015 * * STRING is char * and the null-terminator should be included in the size.
1016 * * OPAQUE is any binary data. When null-terminated string is written in OPAQUE
1025 /** Size of the value. For string resources, it should contain the null-terminator. */
1039 * @return 0 for success or negative in case of error.
1050 * @return 0 for success or negative in case of error.
1061 * @return 0 for success or negative in case of error.
1071 * @return 0 for success or negative in case of error.
1081 * @return 0 for success or negative in case of error.
1091 * @return 0 for success or negative in case of error.
1101 * @return 0 for success or negative in case of error.
1111 * @return 0 for success or negative in case of error.
1121 * @return 0 for success or negative in case of error.
1131 * @return 0 for success or negative in case of error.
1141 * @return 0 for success or negative in case of error.
1151 * @return 0 for success or negative in case of error.
1161 * @return 0 for success or negative in case of error.
1171 * @return 0 for success or negative in case of error.
1178 * LwM2M clients can use this to set the callback function for resource reads when data
1185 * When separate buffer for data should be used, use lwm2m_set_res_buf() instead
1191 * @return 0 for success or negative in case of error.
1196 * @brief Set resource (instance) pre-write callback
1203 * @param[in] cb Pre-write resource callback
1205 * @return 0 for success or negative in case of error.
1228 * @return 0 for success or negative in case of error.
1234 * @brief Set resource (instance) post-write callback
1239 * It allows an LwM2M client or object to post-process the value of a resource
1243 * @param[in] cb Post-write resource callback
1245 * @return 0 for success or negative in case of error.
1258 * @return 0 for success or negative in case of error.
1270 * @return 0 for success or negative in case of error.
1283 * @return 0 for success or negative in case of error.
1289 * @brief Resource read-only value bit
1294 * @brief Resource read-only flag
1301 #define LWM2M_HAS_RES_FLAG(res, f) ((res->data_flags & f) == f)
1306 * Use this function to set the data buffer and flags for the specified LwM2M
1313 * @param[in] data_flags Data buffer flags (such as read-only, etc)
1315 * @return 0 for success or negative in case of error.
1323 * Use this function to set the new size of data in the buffer if you write
1328 * @return 0 for success or negative in case of error.
1335 * Use this function to get the data buffer information for the specified LwM2M
1338 * If you directly write into the buffer, you must use lwm2m_set_res_data_len()
1347 * @param[out] data_flags Data buffer flags (such as read-only, etc)
1349 * @return 0 for success or negative in case of error.
1357 * LwM2M clients use this function to create multi-resource instances:
1363 * @return 0 for success or negative in case of error.
1370 * Use this function to remove an existing resource instance
1374 * @return 0 for success or negative in case of error.
1386 * @return 0 for success or negative in case of error.
1397 * valid LwM2M-path.
1407 * within lwm2m_rd_client. However, if the client does not use the RD
1412 * @return 0 for success or negative in case of error.
1420 * by lwm2m_rd_client_start(). However, if the client does not use the RD
1425 * @return 0 for success or negative in case of error.
1469 * @return 0 for success, -EINPROGRESS when client is already running
1470 * or negative error codes in case of failure.
1477 * @brief Stop the LwM2M RD (De-register) Client
1489 * @return 0 for success or negative in case of error.
1497 * Suspend LwM2M engine. Use case could be when network connection is down.
1501 * @return 0 for success or negative in case of error.
1513 * @return 0 for success or negative in case of error.
1530 * @param[in] buf The buffer to use for formatting the string
1563 * @return 0 for success or negative in case of error.
1580 * Application may enable caching of resource data by allocating buffer for LwM2M engine to use.
1587 * @return 0 for success or negative in case of error.
1597 LWM2M_SECURITY_PSK = 0, /**< Pre-Shared Key mode */
1622 * @return 0 for success or negative in case of error.