Diff: mbed-client/mbed-client/m2mresource.h

Revision:

11:cada08fc8a70

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mbed-client/mbed-client/m2mresource.h	Thu Jun 09 17:08:36 2016 +0000
@@ -0,0 +1,205 @@
+/*
+ * 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.
+ */
+#ifndef M2M_RESOURCE_H
+#define M2M_RESOURCE_H
+
+#include "mbed-client/m2mvector.h"
+#include "mbed-client/m2mresourceinstance.h"
+
+//FORWARD DECLARATION
+class M2MObjectInstance;
+typedef Vector<M2MResourceInstance *> M2MResourceInstanceList;
+
+class M2MResourceCallback {
+public:
+    virtual void notification_update() = 0;
+};
+
+/**
+ *  @brief M2MResource.
+ *  This class is the base class for mbed Client Resources. All defined
+ *  LWM2M object models can be created using it. This class will also hold all resources
+ *  instances associated with the given object.
+ */
+
+class M2MResource : public M2MResourceInstance, M2MResourceCallback {
+
+friend class M2MObjectInstance;
+
+private: // Constructor and destructor are private
+         // which means that these objects can be created or
+         // deleted only through a function provided by the M2MObjectInstance.
+
+    /**
+     * @brief Constructor
+     * @param resource_name, Resource name of the object.
+     * @param resource_type, Resource type of the object.
+     * @param type, Resource Data Type of the object.
+     * @param value, Value pointer of the object.
+     * @param value_length, Length of the value pointer
+     * @param multiple_instance, True if resource supports instances.
+     */
+    M2MResource(M2MObjectInstanceCallback &object_instance_callback,
+                const String &resource_name,
+                const String &resource_type,
+                M2MResourceInstance::ResourceType type,
+                const uint8_t *value,
+                const uint8_t value_length,
+                bool multiple_instance = false);
+
+    /**
+     * @brief Constructor
+     * @param name, Name of the object
+     */
+    M2MResource(M2MObjectInstanceCallback &object_instance_callback,
+                const String &resource_name,
+                const String &resource_type,
+                M2MResourceInstance::ResourceType type,
+                bool observable,
+                bool multiple_instance = false);
+
+    // Prevents the use of default constructor.
+    M2MResource();
+
+    // Prevents the use of assignment operator.
+    M2MResource& operator=( const M2MResource& /*other*/ );
+
+    // Prevents the use of copy constructor
+    M2MResource( const M2MResource& /*other*/ );
+
+    /**
+     * Destructor
+     */
+    virtual ~M2MResource();
+
+public:
+
+    /**
+     * @brief Adds resource instances to the M2MResource.
+     * @param resource_instance, Resource Instance to be added.
+     */
+    void add_resource_instance(M2MResourceInstance *resource_instance);
+
+    /**
+     * @brief Returns whether the resource has multiple
+     * resource instances or not.
+     * @return True if resource base has multiple instances,
+     * else false.
+     */
+    bool supports_multiple_instances() const;
+
+    /**
+     * @brief Removes the resource with the given name.
+     * @param name, Name of the resource to be removed.
+     * @param instance_id, Instance ID of resource to be removed, default is 0.
+     * @return True if removed, else false.
+     */
+    virtual bool remove_resource_instance(uint16_t instance_id = 0);
+
+    /**
+     * @brief Returns resource instance with the given name.
+     * @param instance_id, Instance ID of the requested resource, default is 0
+     * @return M2MResourceInstance object if found, else NULL.
+     */
+    virtual M2MResourceInstance* resource_instance(uint16_t instance_id = 0) const;
+
+    /**
+     * @brief Returns a list of resources.
+     * @return List of resources with the object.
+     */
+    virtual const M2MResourceInstanceList& resource_instances() const;
+
+    /**
+     * @brief Returns the total number of resources with the object.
+     * @return Total number of resources.
+     */
+    virtual uint16_t resource_instance_count() const;
+
+    /**
+     * @brief Parses the received query for a notification
+     * attribute.
+     * @return True if required attributes are present, else false.
+     */
+    virtual bool handle_observation_attribute(char *&query);
+
+    /**
+     * @brief Adds the observation level for the object.
+     * @param observation_level, Level of observation.
+     */
+    virtual void add_observation_level(M2MBase::Observation observation_level);
+
+    /**
+     * @brief Removes the observation level from the object.
+     * @param observation_level, Level of observation.
+     */
+    virtual void remove_observation_level(M2MBase::Observation observation_level);
+
+    /**
+     * @brief Handles GET request for the registered objects.
+     * @param nsdl, NSDL handler for the CoAP library.
+     * @param received_coap_header, CoAP message received from the server.
+     * @param observation_handler, Handler object for sending
+     * observation callbacks.
+     * @return sn_coap_hdr_s,  Message that needs to be sent to the server.
+     */
+    virtual sn_coap_hdr_s* handle_get_request(nsdl_s *nsdl,
+                                              sn_coap_hdr_s *received_coap_header,
+                                              M2MObservationHandler *observation_handler = NULL);
+    /**
+     * @brief Handles PUT request for the registered objects.
+     * @param nsdl, NSDL handler for the CoAP library.
+     * @param received_coap_header, CoAP message received from the server.
+     * @param observation_handler, Handler object for sending
+     * observation callbacks.
+     * @return sn_coap_hdr_s,  Message that needs to be sent to the server.
+     */
+    virtual sn_coap_hdr_s* handle_put_request(nsdl_s *nsdl,
+                                              sn_coap_hdr_s *received_coap_header,
+                                              M2MObservationHandler *observation_handler = NULL);
+    /**
+     * @brief Handles POST request for the registered objects.
+     * @param nsdl, NSDL handler for the CoAP library.
+     * @param received_coap_header, CoAP message received from the server.
+     * @param observation_handler, Handler object for sending
+     * observation callbacks.
+     * @return sn_coap_hdr_s,  Message that needs to be sent to the server.
+     */
+    virtual sn_coap_hdr_s* handle_post_request(nsdl_s *nsdl,
+                                               sn_coap_hdr_s *received_coap_header,
+                                               M2MObservationHandler *observation_handler = NULL);
+
+protected:
+    virtual void notification_update();
+
+private:
+
+    M2MResourceInstanceList     _resource_instance_list; // owned
+    bool                        _has_multiple_instances;
+
+friend class Test_M2MResource;
+friend class Test_M2MObjectInstance;
+friend class Test_M2MObject;
+friend class Test_M2MDevice;
+friend class Test_M2MSecurity;
+friend class Test_M2MServer;
+friend class Test_M2MNsdlInterface;
+friend class Test_M2MFirmware;
+friend class Test_M2MTLVSerializer;
+friend class Test_M2MTLVDeserializer;
+
+};
+
+#endif // M2M_RESOURCE_H