Diff: simple-mbed-cloud-client/mbed-cloud-client/mbed-client/source/include/m2mtlvdeserializer.h

Revision:

0:8f0bb79ddd48

diff -r 000000000000 -r 8f0bb79ddd48 simple-mbed-cloud-client/mbed-cloud-client/mbed-client/source/include/m2mtlvdeserializer.h
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/simple-mbed-cloud-client/mbed-cloud-client/mbed-client/source/include/m2mtlvdeserializer.h	Tue May 04 08:55:12 2021 +0000
@@ -0,0 +1,185 @@
+/*
+ * Copyright (c) 2015 ARM Limited. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ * Licensed under the Apache License, Version 2.0 (the License); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an AS IS BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#include "mbed-client/m2mvector.h"
+#include "mbed-client/m2mobject.h"
+#include "mbed-client/m2mobjectinstance.h"
+#include "mbed-client/m2mresource.h"
+
+/**
+ * @brief M2MTLVDeserializer
+ * TLV Deserialiser get the object instances and resources as binary data and
+ * builds the <code>lwm2m</code> representation from it. See OMA-LWM2M
+ * specification, chapter 6.1 for the resource model and chapter 6.3.3 for
+ * the OMA-TLV specification.
+ */
+class M2MTLVDeserializer {
+
+public :
+
+    typedef enum {
+        None,
+        NotFound,
+        NotAllowed,
+        NotValid,
+        OutOfMemory
+    } Error;
+
+    typedef enum {
+        Put,
+        Post
+    } Operation;
+
+
+    /**
+     * This method checks whether the given binary encodes an object instance
+     * or something else. It returns <code>true</code> if bits 7-6 of the first
+     * byte is "00".
+     * @param tlv Binary to be checked as LWM2M object instance
+     * @return <code>true</code> or <code>false</code>.
+     */
+    static bool is_object_instance(const uint8_t *tlv);
+
+    /**
+     * This method checks whether the given binary encodes a resource or
+     * something else. It returns <code>true</code> if bits 7-6 of the first
+     * byte is "11".
+     * @param tlv Binary to be checked as LWM2M resource.
+     * @return <code>true</code> or <code>false</code>.
+     */
+    static bool is_resource(const uint8_t *tlv);
+
+    /**
+     * This method checks whether the given binary encodes a multiple resource
+     * or something else. It returns <code>true</code> if bits 7-6 of the first
+     * byte is "10".
+     * @param tlv Binary to be checked as LWM2M multiple resource.
+     * @return <code>true</code> or <code>false</code>.
+     */
+    static bool is_multiple_resource(const uint8_t *tlv);
+
+    /**
+     * This method checks whether the given binary encodes a resource instance
+     * or something else. It returns <code>true</code> if bits 7-6 of the first
+     * byte is "01".
+     * @param tlv Binary to be checked as LWM2M resource instance.
+     * @return <code>true</code> or <code>false</code>.
+     */
+    static bool is_resource_instance(const uint8_t *tlv);
+
+    /**
+     * Deserialises the given binary that must encode object instances. Binary
+     * array can be checked before invoking this method with
+     */
+    static M2MTLVDeserializer::Error deserialise_object_instances(const uint8_t* tlv,
+                                                           uint32_t tlv_size,
+                                                           M2MObject &object,
+                                                           M2MTLVDeserializer::Operation operation);
+
+    /**
+     * Deserialises the given binary that must encode resources. Binary array
+     * can be checked before invoking this method.
+     */
+    static M2MTLVDeserializer::Error deserialize_resources(const uint8_t *tlv,
+                                                    uint32_t tlv_size,
+                                                    M2MObjectInstance &object_instance,
+                                                    M2MTLVDeserializer::Operation operation);
+
+    /**
+     * Deserialises the given binary that must encode resource instances. Binary array
+     * can be checked before invoking this method.
+     */
+    static M2MTLVDeserializer::Error deserialize_resource_instances(const uint8_t *tlv,
+                                                             uint32_t tlv_size,
+                                                             M2MResource &resource,
+                                                             M2MTLVDeserializer::Operation operation);
+    /**
+     * This method return object instance id or resource id.
+     * @param tlv Binary to be checked
+     * @return Object instance id or resource id.
+     */
+    static uint16_t instance_id(const uint8_t *tlv);
+
+private:
+
+    static M2MTLVDeserializer::Error deserialize_object_instances(const uint8_t *tlv,
+                                                           uint32_t tlv_size,
+                                                           uint32_t offset,
+                                                           M2MObject &object,
+                                                           M2MTLVDeserializer::Operation operation,
+                                                           bool update_value);
+
+    static M2MTLVDeserializer::Error deserialize_resources(const uint8_t *tlv,
+                                                    uint32_t tlv_size,
+                                                    uint32_t offset,
+                                                    M2MObjectInstance &object_instance,
+                                                    M2MTLVDeserializer::Operation operation,
+                                                    bool update_value);
+
+    static M2MTLVDeserializer::Error deserialize_resource_instances(const uint8_t *tlv,
+                                                             uint32_t tlv_size,
+                                                             uint32_t offset,
+                                                             M2MResource &resource,
+                                                             M2MObjectInstance &object_instance,
+                                                             M2MTLVDeserializer::Operation operation,
+                                                             bool update_value);
+
+    static M2MTLVDeserializer::Error deserialize_resource_instances(const uint8_t *tlv,
+                                                             uint32_t tlv_size,
+                                                             uint32_t offset,
+                                                             M2MResource &resource,
+                                                             M2MTLVDeserializer::Operation operation,
+                                                             bool update_value);
+
+    static bool is_object_instance(const uint8_t *tlv, uint32_t offset);
+
+    static bool is_resource(const uint8_t *tlv, uint32_t offset);
+
+    static bool is_multiple_resource(const uint8_t *tlv, uint32_t offset);
+
+    static bool is_resource_instance(const uint8_t *tlv, uint32_t offset);
+
+    static bool set_resource_instance_value(M2MResourceBase *res, const uint8_t *tlv, const uint32_t size);
+
+    static void remove_resources(const uint8_t *tlv,
+                                 uint32_t tlv_size,
+                                 M2MObjectInstance &object_instance,
+                                 uint32_t offset_size);
+
+    static void remove_resource_instances(const uint8_t *tlv,
+                                 uint32_t tlv_size,
+                                 M2MResource &resource,
+                                 uint32_t offset_size);
+};
+
+class TypeIdLength {
+
+public:
+    TypeIdLength(const uint8_t *tlv, uint32_t offset);
+
+    void deserialize();
+
+    void deserialiseID(uint32_t idLength);
+
+    void deserialiseLength(uint32_t lengthType);
+
+    const uint8_t     *_tlv;
+    uint32_t    _offset;
+    uint32_t    _type;
+    uint16_t    _id;
+    uint32_t    _length;
+
+    friend class Test_M2MTLVDeserializer;
+};