Ram Gandikota / Mbed OS ABCD

A metronome using the FRDM K64F board

mbed-client/source/include/m2mtlvserializer.h@0:a7a43371b306, 2017-05-14 (annotated)

Committer:
ram54288
Date:
Sun May 14 18:40:18 2017 +0000
Revision:
0:a7a43371b306
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ram54288 0:a7a43371b306 1 /*
ram54288 0:a7a43371b306 2 * Copyright (c) 2015 ARM Limited. All rights reserved.
ram54288 0:a7a43371b306 3 * SPDX-License-Identifier: Apache-2.0
ram54288 0:a7a43371b306 4 * Licensed under the Apache License, Version 2.0 (the License); you may
ram54288 0:a7a43371b306 5 * not use this file except in compliance with the License.
ram54288 0:a7a43371b306 6 * You may obtain a copy of the License at
ram54288 0:a7a43371b306 7 *
ram54288 0:a7a43371b306 8 * http://www.apache.org/licenses/LICENSE-2.0
ram54288 0:a7a43371b306 9 *
ram54288 0:a7a43371b306 10 * Unless required by applicable law or agreed to in writing, software
ram54288 0:a7a43371b306 11 * distributed under the License is distributed on an AS IS BASIS, WITHOUT
ram54288 0:a7a43371b306 12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ram54288 0:a7a43371b306 13 * See the License for the specific language governing permissions and
ram54288 0:a7a43371b306 14 * limitations under the License.
ram54288 0:a7a43371b306 15 */
ram54288 0:a7a43371b306 16 #include "mbed-client/m2mvector.h"
ram54288 0:a7a43371b306 17 #include "mbed-client/m2mobject.h"
ram54288 0:a7a43371b306 18 #include "mbed-client/m2mobjectinstance.h"
ram54288 0:a7a43371b306 19 #include "mbed-client/m2mresource.h"
ram54288 0:a7a43371b306 20
ram54288 0:a7a43371b306 21 /**
ram54288 0:a7a43371b306 22 * @brief M2MTLVSerializer
ram54288 0:a7a43371b306 23 * TLV Serialiser constructs the binary representation of object instances,
ram54288 0:a7a43371b306 24 * resources and resource instances (see OMA-LWM2M specification, chapter 6.1
ram54288 0:a7a43371b306 25 * for resource model) as OMA-TLV according described in chapter 6.3.3.
ram54288 0:a7a43371b306 26 *
ram54288 0:a7a43371b306 27 */
ram54288 0:a7a43371b306 28 class M2MTLVSerializer {
ram54288 0:a7a43371b306 29
ram54288 0:a7a43371b306 30 public:
ram54288 0:a7a43371b306 31
ram54288 0:a7a43371b306 32 /**
ram54288 0:a7a43371b306 33 * Constructor.
ram54288 0:a7a43371b306 34 */
ram54288 0:a7a43371b306 35 M2MTLVSerializer();
ram54288 0:a7a43371b306 36
ram54288 0:a7a43371b306 37 /**
ram54288 0:a7a43371b306 38 * Destructor.
ram54288 0:a7a43371b306 39 */
ram54288 0:a7a43371b306 40 ~M2MTLVSerializer();
ram54288 0:a7a43371b306 41
ram54288 0:a7a43371b306 42 /**
ram54288 0:a7a43371b306 43 * Serialises given objects instances that contain resources or multiple
ram54288 0:a7a43371b306 44 * resources. Object instance IDs are also encoded. This method must be
ram54288 0:a7a43371b306 45 * used when an operation targets an object with (potential) multiple
ram54288 0:a7a43371b306 46 * instances like "GET /1". In that case the generated TLV will contain the
ram54288 0:a7a43371b306 47 * following data:
ram54288 0:a7a43371b306 48 * <ul>
ram54288 0:a7a43371b306 49 * <li> ./0
ram54288 0:a7a43371b306 50 * <li> ./0/0
ram54288 0:a7a43371b306 51 * <li> ./0/1
ram54288 0:a7a43371b306 52 * <li> ...
ram54288 0:a7a43371b306 53 * <li> ./1
ram54288 0:a7a43371b306 54 * <li> ./1/0
ram54288 0:a7a43371b306 55 * <li> ./1/1
ram54288 0:a7a43371b306 56 * <li> ...
ram54288 0:a7a43371b306 57 * </ul>
ram54288 0:a7a43371b306 58 *
ram54288 0:a7a43371b306 59 * @param objects List of object instances.
ram54288 0:a7a43371b306 60 * @return Object instances encoded binary as OMA-TLV
ram54288 0:a7a43371b306 61 * @see #serializeObjectInstances(List)
ram54288 0:a7a43371b306 62 */
ram54288 0:a7a43371b306 63 uint8_t* serialize(M2MObjectInstanceList object_instance_list, uint32_t &size);
ram54288 0:a7a43371b306 64
ram54288 0:a7a43371b306 65 /**
ram54288 0:a7a43371b306 66 * Serialises given resources with no information about the parent object
ram54288 0:a7a43371b306 67 * instance. This method must be used when an operation targets an object
ram54288 0:a7a43371b306 68 * instance like "GET /1/0" or a single-instance object like "GET /3//".
ram54288 0:a7a43371b306 69 * Resources may have single or multiple instances. The generated TLV will
ram54288 0:a7a43371b306 70 * contain the following data as response to "GET /3//":
ram54288 0:a7a43371b306 71 * <ul>
ram54288 0:a7a43371b306 72 * <li> ./0
ram54288 0:a7a43371b306 73 * <li> ./1
ram54288 0:a7a43371b306 74 * <li> ./2
ram54288 0:a7a43371b306 75 * <li> ./6/0 (1st instance of a multiple resource)
ram54288 0:a7a43371b306 76 * <li> ./6/1 (2nd instance of a multiple resource)
ram54288 0:a7a43371b306 77 * <li> ...
ram54288 0:a7a43371b306 78 * </ul>
ram54288 0:a7a43371b306 79 * @param resources Array of resources and resource instances.
ram54288 0:a7a43371b306 80 * @return Resources encoded binary as OMA-TLV
ram54288 0:a7a43371b306 81 * @see #serializeResources(List)
ram54288 0:a7a43371b306 82 */
ram54288 0:a7a43371b306 83 uint8_t* serialize(M2MResourceList resource_list, uint32_t &size);
ram54288 0:a7a43371b306 84
ram54288 0:a7a43371b306 85 uint8_t* serialize(M2MResource *resource, uint32_t &size);
ram54288 0:a7a43371b306 86
ram54288 0:a7a43371b306 87 private :
ram54288 0:a7a43371b306 88
ram54288 0:a7a43371b306 89 uint8_t* serialize_object_instances(M2MObjectInstanceList object_instance_list, uint32_t &size);
ram54288 0:a7a43371b306 90
ram54288 0:a7a43371b306 91 uint8_t* serialize_resources(M2MResourceList resource_list, uint32_t &size, bool &valid);
ram54288 0:a7a43371b306 92
ram54288 0:a7a43371b306 93 void serialize(uint16_t id, M2MObjectInstance *object_instance, uint8_t *&data, uint32_t &size);
ram54288 0:a7a43371b306 94
ram54288 0:a7a43371b306 95 bool serialize (M2MResource *resource, uint8_t *&data, uint32_t &size);
ram54288 0:a7a43371b306 96
ram54288 0:a7a43371b306 97 bool serialize_resource(M2MResource *resource, uint8_t *&data, uint32_t &size);
ram54288 0:a7a43371b306 98
ram54288 0:a7a43371b306 99 bool serialize_multiple_resource(M2MResource *resource, uint8_t *&data, uint32_t &size);
ram54288 0:a7a43371b306 100
ram54288 0:a7a43371b306 101 void serialize_resource_instance(uint16_t id, M2MResourceInstance *resource, uint8_t *&data, uint32_t &size);
ram54288 0:a7a43371b306 102
ram54288 0:a7a43371b306 103 void serialize_TILV (uint8_t type, uint16_t id, uint8_t *value, uint32_t value_length, uint8_t *&data, uint32_t &size);
ram54288 0:a7a43371b306 104
ram54288 0:a7a43371b306 105 uint8_t* serialize_id(uint16_t id, uint32_t &size);
ram54288 0:a7a43371b306 106
ram54288 0:a7a43371b306 107 uint8_t* serialize_length(uint32_t length, uint32_t &size);
ram54288 0:a7a43371b306 108 };