m2mobject.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_OBJECT_H
#define M2M_OBJECT_H

#include "mbed-client/m2mvector.h"
#include "mbed-client/m2mbase.h"
#include "mbed-client/m2mobjectinstance.h"

//FORWARD DECLARATION
typedef Vector<M2MObjectInstance *> M2MObjectInstanceList;

class M2MEndpoint;

class M2MObject : public M2MBase {

    friend class M2MInterfaceFactory;
    friend class M2MEndpoint;
    friend class TestFactory;

protected :

    M2MObject(const String &object_name,
              char *path,
              bool external_blockwise_store = false);

    // Prevents the use of default constructor.
    M2MObject();

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

    // Prevents the use of copy constructor.
    M2MObject(const M2MObject & /*other*/);

    M2MObject(const M2MBase::lwm2m_parameters_s *static_res);

public:

    virtual ~M2MObject();

    M2MObjectInstance *create_object_instance(uint16_t instance_id = 0);

    M2MObjectInstance *create_object_instance(const lwm2m_parameters_s *s);

    bool remove_object_instance(uint16_t instance_id = 0);

    M2MObjectInstance *object_instance(uint16_t instance_id = 0) const;

    const M2MObjectInstanceList &instances() const;

    uint16_t instance_count() const;

    uint16_t new_instance_id() const;

    virtual M2MObservationHandler *observation_handler() const;

    virtual void set_observation_handler(M2MObservationHandler *handler);

    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);

    void notification_update(uint16_t obj_instance_id);

#ifdef MBED_CLOUD_CLIENT_EDGE_EXTENSION
    void set_endpoint(M2MEndpoint *endpoint);

    M2MEndpoint *get_endpoint() const;
#endif

protected :
    virtual M2MBase *get_parent() const;

private:

    M2MObjectInstanceList     _instance_list; // owned

    M2MObservationHandler    *_observation_handler; // Not owned

#ifdef MBED_CLOUD_CLIENT_EDGE_EXTENSION
    M2MEndpoint              *_endpoint; // Parent endpoint
#endif

    friend class Test_M2MObject;
    friend class Test_M2MEndpoint;
    friend class Test_M2MInterfaceImpl;
    friend class Test_M2MInterfaceFactory;
    friend class Test_M2MNsdlInterface;
    friend class Test_M2MTLVSerializer;
    friend class Test_M2MTLVDeserializer;
    friend class Test_M2MDevice;
    friend class Test_M2MBase;
    friend class Test_M2MObjectInstance;
    friend class Test_M2MResource;
    friend class Test_M2MSecurity;
    friend class Test_M2MServer;
    friend class Test_M2MReportHandler;
    friend class Test_M2MResourceInstance;
    friend class Test_M2MDiscover;
    friend class Test_M2MDynLog;
};

#endif // M2M_OBJECT_H