m2mresource.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2021 Pelion. 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/m2mresourcebase.h"
#include "mbed-client/m2mresourceinstance.h"
#include "mbed-client/coap_response.h"
#include <stdlib.h>

//FORWARD DECLARATION
class M2MObjectInstance;
typedef Vector<M2MResourceInstance *> M2MResourceInstanceList;


class M2MResource : public M2MResourceBase {

    friend class M2MObjectInstance;

public:
    class M2MExecuteParameter;

private: // Constructor and destructor are private,
    // which means that these objects can be created or
    // deleted only through a function provided by the M2MObjectInstance.

    M2MResource(M2MObjectInstance &_parent,
                const lwm2m_parameters_s *s,
                M2MBase::DataType type);
    M2MResource(M2MObjectInstance &_parent,
                const String &resource_name,
                M2MBase::Mode mode,
                const String &resource_type,
                M2MBase::DataType type,
                const uint8_t *value,
                const uint8_t value_length,
                char *path,
                bool multiple_instance = false,
                bool external_blockwise_store = false);

    M2MResource(M2MObjectInstance &_parent,
                const String &resource_name,
                M2MBase::Mode mode,
                const String &resource_type,
                M2MBase::DataType type,
                bool observable,
                char *path,
                bool multiple_instance = false,
                bool external_blockwise_store = false);

    // Prevents the use of a default constructor.
    M2MResource();

    // Prevents the use of an assignment operator.
    M2MResource &operator=(const M2MResource & /*other*/);

    // Prevents the use of a copy constructor
    M2MResource(const M2MResource & /*other*/);

    virtual M2MBase *get_parent() const;

    virtual ~M2MResource();

public:

    void add_resource_instance(M2MResourceInstance *resource_instance);

    bool supports_multiple_instances() const;

#ifndef DISABLE_DELAYED_RESPONSE

#ifdef ENABLE_ASYNC_REST_RESPONSE
    void set_delayed_response(bool delayed_response) m2m_deprecated;
#else
    void set_delayed_response(bool delayed_response);
#endif

    bool delayed_response() const;

    bool send_delayed_post_response(sn_coap_msg_code_e code = COAP_MSG_CODE_RESPONSE_CHANGED);

    void get_delayed_token(uint8_t *&token, uint8_t &token_length);

#endif //DISABLE_DELAYED_RESPONSE

    bool remove_resource_instance(uint16_t instance_id = 0);

    M2MResourceInstance *resource_instance(uint16_t instance_id = 0) const;

    const M2MResourceInstanceList &resource_instances() const;

    uint16_t resource_instance_count() const;

    virtual M2MObservationHandler *observation_handler() const;

    virtual void set_observation_handler(M2MObservationHandler *handler);

#if defined (MBED_CONF_MBED_CLIENT_ENABLE_OBSERVATION_PARAMETERS) && (MBED_CONF_MBED_CLIENT_ENABLE_OBSERVATION_PARAMETERS == 1)

    virtual bool handle_observation_attribute(const char *query);
#endif

    virtual void add_observation_level(M2MBase::Observation observation_level);

    virtual void remove_observation_level(M2MBase::Observation observation_level);

    virtual sn_coap_hdr_s *handle_get_request(nsdl_s *nsdl,
                                              sn_coap_hdr_s *received_coap_header,
                                              M2MObservationHandler *observation_handler = NULL);
    virtual sn_coap_hdr_s *handle_put_request(nsdl_s *nsdl,
                                              sn_coap_hdr_s *received_coap_header,
                                              M2MObservationHandler *observation_handler,
                                              bool &execute_value_updated);
    virtual sn_coap_hdr_s *handle_post_request(nsdl_s *nsdl,
                                               sn_coap_hdr_s *received_coap_header,
                                               M2MObservationHandler *observation_handler,
                                               bool &execute_value_updated,
                                               sn_nsdl_addr_s *address = NULL);

    M2MObjectInstance &get_parent_object_instance() const;

    virtual uint16_t object_instance_id() const;

    virtual const char *object_name() const;

    virtual M2MResource &get_parent_resource() const;

#ifdef MBED_CLOUD_CLIENT_EDGE_EXTENSION

    void set_manifest_check_status(bool status);

    bool get_manifest_check_status();
#endif

private:
    M2MObjectInstance &_parent;

    M2MResourceInstanceList     _resource_instance_list; // owned

#ifdef MBED_CLOUD_CLIENT_EDGE_EXTENSION
    bool                        _status;
#endif

#ifndef DISABLE_DELAYED_RESPONSE
    uint8_t                     *_delayed_token;
    uint8_t                     _delayed_token_len;
    bool                        _delayed_response;
#endif

    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_M2MReportHandler;
    friend class Test_M2MNsdlInterface;
    friend class Test_M2MInterfaceFactory;
    friend class Test_M2MTLVSerializer;
    friend class Test_M2MTLVDeserializer;
    friend class Test_M2MBase;
    friend class Test_M2MResourceInstance;
    friend class TestFactory;
    friend class Test_M2MInterfaceImpl;
    friend class Test_M2MDiscover;
    friend class Test_M2MDynLog;
};

class M2MResource::M2MExecuteParameter {

private:

    M2MExecuteParameter();

#ifdef MEMORY_OPTIMIZED_API
    M2MExecuteParameter(const char *object_name, const char *resource_name, uint16_t object_instance_id);
#else

    M2MExecuteParameter(const String &object_name, const String &resource_name, uint16_t object_instance_id);
#endif
public:

    const uint8_t *get_argument_value() const;

    uint16_t get_argument_value_length() const;

#ifdef MEMORY_OPTIMIZED_API
    const char *get_argument_object_name() const;
#else
    const String &get_argument_object_name() const;
#endif

#ifdef MEMORY_OPTIMIZED_API
    const char *get_argument_resource_name() const;
#else
    const String &get_argument_resource_name() const;
#endif

    uint16_t get_argument_object_instance_id() const;

#ifdef MBED_CLOUD_CLIENT_EDGE_EXTENSION

    void set_resource(M2MResource *res);

    M2MResource *get_resource();

#endif

private:
    // pointers to const data, not owned by this instance

#ifdef MEMORY_OPTIMIZED_API
    const char      *_object_name;
    const char      *_resource_name;
#else
    const String    &_object_name;
    const String    &_resource_name;
#endif
    const uint8_t   *_value;
    uint16_t        _value_length;
    uint16_t        _object_instance_id;
#ifdef MBED_CLOUD_CLIENT_EDGE_EXTENSION
    M2MResource     *_resource;
#endif

    friend class Test_M2MResource;
    friend class M2MResource;
};

#endif // M2M_RESOURCE_H