m2mfirmware.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 M2MFIRMWARE_H
#define M2MFIRMWARE_H

#include "mbed-client/m2mobject.h"

// FORWARD DECLARATION
class M2MResource;
class M2MResourceInstance;

class  M2MFirmware : public M2MObject {

friend class M2MInterfaceFactory;

public:

    typedef enum {
        Package,
        PackageUri,
        Update,
        State,
        UpdateSupportedObjects,
        UpdateResult,
        PackageName,
        PackageVersion
    } FirmwareResource;

    typedef enum {
       Idle = 0,
       Downloading,
       Downloaded,
       Updating
    } UpdateState;

    typedef enum {
       Default = 0,
       SuccessfullyUpdated,
       NotEnoughSpace,
       OutOfMemory,
       ConnectionLost,
       CRCCheckFailure,
       UnsupportedPackageType,
       InvalidURI
    } ResultOfUpdate;

private:

    M2MFirmware();

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

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

    virtual ~M2MFirmware();

    static M2MFirmware* get_instance();

public:

    static void delete_instance() m2m_deprecated;

    M2MResource* create_resource(FirmwareResource resource, const String &value) m2m_deprecated;

    M2MResource* create_resource(FirmwareResource resource, int64_t value) m2m_deprecated;

    bool delete_resource(FirmwareResource resource) m2m_deprecated;

    bool set_resource_value(FirmwareResource resource,
                            const String &value) m2m_deprecated;

    bool set_resource_value(FirmwareResource resource,
                            int64_t value) m2m_deprecated;

    bool set_resource_value(FirmwareResource resource,
                            const uint8_t *value,
                            const uint32_t length) m2m_deprecated;

    String resource_value_string(FirmwareResource resource) const m2m_deprecated;

    int64_t resource_value_int(FirmwareResource resource) const m2m_deprecated;

    uint32_t resource_value_buffer(FirmwareResource resource,
                                   uint8_t *&data) const m2m_deprecated;

    bool is_resource_present(FirmwareResource resource) const m2m_deprecated;

    uint16_t total_resource_count() const m2m_deprecated;

    uint16_t per_resource_count(FirmwareResource resource) const m2m_deprecated;

    bool set_update_execute_callback(execute_callback callback);

    bool set_resource_value_update_callback(FirmwareResource resource,
                                            value_updated_callback callback);

    bool set_resource_notification_sent_callback(FirmwareResource resource,
                                                 notification_sent_callback_2 callback) m2m_deprecated;


    bool set_resource_notification_sent_callback(FirmwareResource resource,
                                                 notification_delivery_status_cb callback) m2m_deprecated;


    bool set_resource_notification_sent_callback(FirmwareResource resource,
                                                 message_delivery_status_cb callback);

#ifndef DISABLE_BLOCK_MESSAGE

    bool set_package_block_message_callback(incoming_block_message_callback callback);
#endif

private:

    M2MResource* get_resource(FirmwareResource resource) const;

    static const char* resource_name(FirmwareResource resource);

    void create_mandatory_resources();

    bool check_value_range(FirmwareResource resource, const int64_t value) const;

private :

    M2MObjectInstance*    _firmware_instance;     //Not owned

protected:

    static M2MFirmware*     _instance;

    friend class Test_M2MFirmware;
    friend class Test_M2MInterfaceFactory;
} m2m_deprecated;


#endif // M2MFIRMWARE_H