m2minterfacefactory.h

Go to the documentation of this file.

/*
 * 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_INTERFACE_FACTORY_H
#define M2M_INTERFACE_FACTORY_H

#include <stdlib.h>
#include "mbed-client/m2msecurity.h"
#include "mbed-client/m2mresource.h"
#include "mbed-client/m2minterfaceobserver.h"

//FORWARD DECLARATION
class M2MDevice;
class M2MServer;
class M2MInterfaceImpl;
class M2MFirmware;

class  M2MInterfaceFactory {
private:
    // Prevents the use of an assignment operator by accident.
    M2MInterfaceFactory& operator=( const M2MInterfaceFactory& /*other*/ );

    // Prevents the use of a copy constructor by accident.
    M2MInterfaceFactory( const M2MInterfaceFactory& /*other*/ );


public:

    static M2MInterface *create_interface(M2MInterfaceObserver &observer,
                                              const String &endpoint_name,
                                              const String &endpoint_type = "",
                                              const int32_t life_time = -1,
                                              const uint16_t listen_port = 5683,
                                              const String &domain = "",
                                              M2MInterface::BindingMode mode = M2MInterface::NOT_SET,
                                              M2MInterface::NetworkStack stack = M2MInterface::LwIP_IPv4,
                                              const String &context_address = "");

    static M2MSecurity *create_security(M2MSecurity::ServerType server_type);

    static M2MServer *create_server();

    static M2MDevice *create_device();

    static M2MFirmware *create_firmware() m2m_deprecated;

    static M2MObject *create_object(const String &name);

    static M2MResource *create_resource(M2MObjectList &m2m_obj_list,
                                        const uint16_t object_id,
                                        const uint16_t object_instance_id,
                                        const uint16_t resource_id,
                                        const M2MResourceInstance::ResourceType resource_type,
                                        const M2MBase::Operation allowed,
                                        bool multiple_instance = false,
                                        bool external_blockwise_store = false);

#ifdef MBED_CLOUD_CLIENT_EDGE_EXTENSION

    static M2MEndpoint* create_endpoint(const String &name);
#endif

private:
    static M2MObject* find_or_create_object(M2MObjectList &object_list,
                                            const uint16_t object_id,
                                            bool &object_created);

    static M2MObjectInstance* find_or_create_object_instance(M2MObject &object,
                                                             const uint16_t object_instance_id,
                                                             bool &object_instance_created);

    static M2MResource* find_or_create_resource(M2MObjectInstance &object_instance,
                                                const uint16_t resource_id,
                                                const M2MResourceInstance::ResourceType resource_type,
                                                bool multiple_instance,
                                                bool external_blockwise_store);

    friend class Test_M2MInterfaceFactory;
};

#endif // M2M_INTERFACE_FACTORY_H